Floor function

  • Article

Warning

This documentation refers to the Classic QDK, which has been replaced by the Modern QDK.

Please see https://aka.ms/qdk.api for the API documentation for the Modern QDK.

Namespace: Microsoft.Quantum.Math

Package: Microsoft.Quantum.QSharp.Foundation

Returns the smallest integer greater than or equal to the specified number.

function Floor (value : Double) : Int

Input

value : Double

The value whose floor is to be returned.

Output : Int

The floor of the input.

Example

Message($"{Floor(3.1)}");   //  3
Message($"{Floor(3.7)}");   //  3
Message($"{Floor(-3.1)}");  // -4
Message($"{Floor(-3.7)}");  // -4