IsInfinite 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 whether a given floating-point value is either positive or negative infinity.

function IsInfinite (d : Double) : Bool

Input

d : Double

The floating-point value to be checked.

Output : Bool

Example

Message($"{IsInfinite(42.0)}"); // false
Message($"{IsInfinite(NaN())}"); // false
Message($"{IsInfinite(-1.0 / 0.0}"); // true

# See Also
- Microsoft.Quantum.Math.NaN
- Microsoft.Quantum.Math.IsNaN
- Microsoft.Quantum.Math.IsFinite

Remarks

NaN() is not a number, and is thus neither a finite number nor is it infinite. As such, both IsInfinite(NaN()) and IsFinite(NaN()) return false. To check a value against NaN(), use IsNaN(d).

Note that even though this function returns true for both positive and negative infinities, these values can still be discriminated by checking d > 0.0 and d < 0.0.