qsharp-lang 1.1.2-dev → 1.1.4-dev

package/docs/Microsoft.Quantum.Math/E.md

@@ -0,0 +1,28 @@
+---
+uid: Microsoft.Quantum.Math.E
+title: E function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: E
+qsharp.summary: Returns the natural logarithmic base to double-precision.
+---
+
+# E function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function E() : Double
+```
+
+## Summary
+Returns the natural logarithmic base to double-precision.
+
+## Output
+A double-precision approximation of the natural logarithmic base,
+e ≈ 2.7182818284590452354.
+
+## See Also
+- Microsoft.Quantum.Math.PI

package/docs/Microsoft.Quantum.Math/ExpModI.md

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.ExpModI
+title: ExpModI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ExpModI
+qsharp.summary: Returns an integer raised to a given power, with respect to a given
+modulus. I.e. (expBase^power) % modulus.
+---
+
+# ExpModI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function ExpModI(expBase : Int, power : Int, modulus : Int) : Int
+```
+
+## Summary
+Returns an integer raised to a given power, with respect to a given
+modulus. I.e. (expBase^power) % modulus.

package/docs/Microsoft.Quantum.Math/ExpModL.md

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.ExpModL
+title: ExpModL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ExpModL
+qsharp.summary: Returns an integer raised to a given power, with respect to a given
+modulus. I.e. (expBase^power) % modulus.
+---
+
+# ExpModL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function ExpModL(expBase : BigInt, power : BigInt, modulus : BigInt) : BigInt
+```
+
+## Summary
+Returns an integer raised to a given power, with respect to a given
+modulus. I.e. (expBase^power) % modulus.

package/docs/Microsoft.Quantum.Math/ExtendedGreatestCommonDivisorI.md

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.ExtendedGreatestCommonDivisorI
+title: ExtendedGreatestCommonDivisorI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ExtendedGreatestCommonDivisorI
+qsharp.summary: Returns a tuple (u,v) such that u*a+v*b=GCD(a,b)
+Note: GCD is always positive except that GCD(0,0)=0.
+---
+
+# ExtendedGreatestCommonDivisorI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function ExtendedGreatestCommonDivisorI(a : Int, b : Int) : (Int, Int)
+```
+
+## Summary
+Returns a tuple (u,v) such that u*a+v*b=GCD(a,b)
+Note: GCD is always positive except that GCD(0,0)=0.

package/docs/Microsoft.Quantum.Math/ExtendedGreatestCommonDivisorL.md

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.ExtendedGreatestCommonDivisorL
+title: ExtendedGreatestCommonDivisorL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ExtendedGreatestCommonDivisorL
+qsharp.summary: Returns a tuple (u,v) such that u*a+v*b=GCD(a,b)
+Note: GCD is always positive except that GCD(0,0)=0.
+---
+
+# ExtendedGreatestCommonDivisorL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function ExtendedGreatestCommonDivisorL(a : BigInt, b : BigInt) : (BigInt, BigInt)
+```
+
+## Summary
+Returns a tuple (u,v) such that u*a+v*b=GCD(a,b)
+Note: GCD is always positive except that GCD(0,0)=0.

package/docs/Microsoft.Quantum.Math/FactorialI.md

@@ -0,0 +1,38 @@
+---
+uid: Microsoft.Quantum.Math.FactorialI
+title: FactorialI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: FactorialI
+qsharp.summary: Returns the factorial of a given number.
+---
+
+# FactorialI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function FactorialI(n : Int) : Int
+```
+
+## Summary
+Returns the factorial of a given number.
+
+## Description
+Returns the factorial of a given nonnegative integer n, where 0 ≤ n ≤ 20.
+
+## Input
+### n
+The number to take the factorial of.
+
+## Output
+The factorial of `n`.
+
+## Remarks
+For inputs greater than 20, please use `Microsoft.Quantum.Math.FactorialL`.
+
+## See Also
+- Microsoft.Quantum.Math.FactorialL
+- Microsoft.Quantum.Math.ApproximateFactorial

package/docs/Microsoft.Quantum.Math/FactorialL.md

@@ -0,0 +1,32 @@
+---
+uid: Microsoft.Quantum.Math.FactorialL
+title: FactorialL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: FactorialL
+qsharp.summary: Returns the factorial of a given number.
+---
+
+# FactorialL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function FactorialL(n : Int) : BigInt
+```
+
+## Summary
+Returns the factorial of a given number.
+
+## Input
+### n
+The number to take the factorial of.
+
+## Output
+The factorial of `n`.
+
+## See Also
+- Microsoft.Quantum.Math.FactorialI
+- Microsoft.Quantum.Math.ApproximateFactorial

package/docs/Microsoft.Quantum.Math/Floor.md

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.Floor
+title: Floor function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Floor
+qsharp.summary: Returns the largest integer less than or equal to the specified number.
+For example: Floor(3.7) = 3; Floor(-3.1) = -4
+---
+
+# Floor function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function Floor(value : Double) : Int
+```
+
+## Summary
+Returns the largest integer less than or equal to the specified number.
+For example: Floor(3.7) = 3; Floor(-3.1) = -4

package/docs/Microsoft.Quantum.Math/GreatestCommonDivisorI.md

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.GreatestCommonDivisorI
+title: GreatestCommonDivisorI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: GreatestCommonDivisorI
+qsharp.summary: Computes the greatest common divisor of two integers.
+Note: GCD is always positive except that GCD(0,0)=0.
+---
+
+# GreatestCommonDivisorI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function GreatestCommonDivisorI(a : Int, b : Int) : Int
+```
+
+## Summary
+Computes the greatest common divisor of two integers.
+Note: GCD is always positive except that GCD(0,0)=0.

package/docs/Microsoft.Quantum.Math/GreatestCommonDivisorL.md

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.GreatestCommonDivisorL
+title: GreatestCommonDivisorL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: GreatestCommonDivisorL
+qsharp.summary: Computes the greatest common divisor of two integers.
+Note: GCD is always positive except that GCD(0,0)=0.
+---
+
+# GreatestCommonDivisorL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function GreatestCommonDivisorL(a : BigInt, b : BigInt) : BigInt
+```
+
+## Summary
+Computes the greatest common divisor of two integers.
+Note: GCD is always positive except that GCD(0,0)=0.

package/docs/Microsoft.Quantum.Math/HammingWeightI.md

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.HammingWeightI
+title: HammingWeightI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: HammingWeightI
+qsharp.summary: Returns the number of 1 bits in the binary representation of integer `n`.
+---
+
+# HammingWeightI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function HammingWeightI(n : Int) : Int
+```
+
+## Summary
+Returns the number of 1 bits in the binary representation of integer `n`.

package/docs/Microsoft.Quantum.Math/InverseModI.md

@@ -0,0 +1,25 @@
+---
+uid: Microsoft.Quantum.Math.InverseModI
+title: InverseModI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: InverseModI
+qsharp.summary: Returns the multiplicative inverse of a modular integer.
+---
+
+# InverseModI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function InverseModI(a : Int, modulus : Int) : Int
+```
+
+## Summary
+Returns the multiplicative inverse of a modular integer.
+
+## Description
+This will calculate the multiplicative inverse of a
+modular integer `b` such that `a • b = 1 (mod modulus)`.

package/docs/Microsoft.Quantum.Math/InverseModL.md

@@ -0,0 +1,25 @@
+---
+uid: Microsoft.Quantum.Math.InverseModL
+title: InverseModL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: InverseModL
+qsharp.summary: Returns the multiplicative inverse of a modular integer.
+---
+
+# InverseModL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function InverseModL(a : BigInt, modulus : BigInt) : BigInt
+```
+
+## Summary
+Returns the multiplicative inverse of a modular integer.
+
+## Description
+This will calculate the multiplicative inverse of a
+modular integer `b` such that `a • b = 1 (mod modulus)`.

package/docs/Microsoft.Quantum.Math/IsCoprimeI.md

@@ -0,0 +1,34 @@
+---
+uid: Microsoft.Quantum.Math.IsCoprimeI
+title: IsCoprimeI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: IsCoprimeI
+qsharp.summary: Returns if two integers are co-prime.
+---
+
+# IsCoprimeI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function IsCoprimeI(a : Int, b : Int) : Bool
+```
+
+## Summary
+Returns if two integers are co-prime.
+
+## Description
+Returns true if a and b are co-prime and false otherwise.
+
+## Input
+### a
+the first number of which co-primality is being tested
+### b
+the second number of which co-primality is being tested
+
+## Output
+True, if a and b are co-prime (e.g. their greatest common divisor is 1),
+and false otherwise

package/docs/Microsoft.Quantum.Math/IsCoprimeL.md

@@ -0,0 +1,34 @@
+---
+uid: Microsoft.Quantum.Math.IsCoprimeL
+title: IsCoprimeL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: IsCoprimeL
+qsharp.summary: Returns if two integers are co-prime.
+---
+
+# IsCoprimeL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function IsCoprimeL(a : BigInt, b : BigInt) : Bool
+```
+
+## Summary
+Returns if two integers are co-prime.
+
+## Description
+Returns true if a and b are co-prime and false otherwise.
+
+## Input
+### a
+the first number of which co-primality is being tested
+### b
+the second number of which co-primality is being tested
+
+## Output
+True, if a and b are co-prime (e.g. their greatest common divisor is 1),
+and false otherwise

package/docs/Microsoft.Quantum.Math/IsInfinite.md

@@ -0,0 +1,49 @@
+---
+uid: Microsoft.Quantum.Math.IsInfinite
+title: IsInfinite function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: IsInfinite
+qsharp.summary: Returns whether a given floating-point value is either positive or
+negative infinity.
+---
+
+# IsInfinite function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function IsInfinite(d : Double) : Bool
+```
+
+## Summary
+Returns whether a given floating-point value is either positive or
+negative infinity.
+
+## Input
+### d
+The floating-point value to be checked.
+
+## Output
+`true` if and only if `d` is either positive or negative infinity.
+
+## Remarks
+`NaN` is not a number, and is thus neither a finite number nor
+is it infinite. As such, `IsInfinite(0.0 / 0.0)` returns `false`.
+To check if a value is `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`.
+
+## Example
+```qsharp
+Message($"{IsInfinite(42.0)}"); // false
+Message($"{IsInfinite(0.0 / 0.0)}"); // false
+Message($"{IsInfinite(-1.0 / 0.0}"); // true
+```
+
+## See Also
+- Microsoft.Quantum.Math.IsNaN

package/docs/Microsoft.Quantum.Math/IsNaN.md

@@ -0,0 +1,30 @@
+---
+uid: Microsoft.Quantum.Math.IsNaN
+title: IsNaN function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: IsNaN
+qsharp.summary: Returns whether a given floating-point value is not a number (i.e. is
+NaN).
+---
+
+# IsNaN function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function IsNaN(d : Double) : Bool
+```
+
+## Summary
+Returns whether a given floating-point value is not a number (i.e. is
+NaN).
+
+## Input
+### d
+A floating-point value to be checked.
+
+## Output
+`true` if and only if `d` is not a number.

package/docs/Microsoft.Quantum.Math/LargestFixedPoint.md

@@ -0,0 +1,31 @@
+---
+uid: Microsoft.Quantum.Math.LargestFixedPoint
+title: LargestFixedPoint function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: LargestFixedPoint
+qsharp.summary: Returns the largest representable number for specific fixed point dimensions.
+---
+
+# LargestFixedPoint function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function LargestFixedPoint(integerBits : Int, fractionalBits : Int) : Double
+```
+
+## Summary
+Returns the largest representable number for specific fixed point dimensions.
+
+## Input
+### integerBits
+Number of integer bits (including the sign bit).
+### fractionalBits
+Number of fractional bits.
+
+## Remark
+The value can be computed as 2^(p-1) - 2^(-q), where p
+is the number of integer bits and q is the number of fractional bits.

package/docs/Microsoft.Quantum.Math/Lg.md

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.Lg
+title: Lg function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Lg
+qsharp.summary: Computes the base-2 logarithm of a number.
+---
+
+# Lg function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function Lg(input : Double) : Double
+```
+
+## Summary
+Computes the base-2 logarithm of a number.

package/docs/Microsoft.Quantum.Math/Log.md

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.Log
+title: Log function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Log
+qsharp.summary: Returns the natural (base _e_) logarithm of a specified number.
+---
+
+# Log function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function Log(input : Double) : Double
+```
+
+## Summary
+Returns the natural (base _e_) logarithm of a specified number.

package/docs/Microsoft.Quantum.Math/Log10.md

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.Log10
+title: Log10 function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Log10
+qsharp.summary: Returns the base-10 logarithm of a specified number.
+---
+
+# Log10 function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function Log10(input : Double) : Double
+```
+
+## Summary
+Returns the base-10 logarithm of a specified number.

package/docs/Microsoft.Quantum.Math/LogFactorialD.md

@@ -0,0 +1,35 @@
+---
+uid: Microsoft.Quantum.Math.LogFactorialD
+title: LogFactorialD function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: LogFactorialD
+qsharp.summary: Returns the approximate natural logarithm of the factorial of a given
+integer.
+---
+
+# LogFactorialD function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function LogFactorialD(n : Int) : Double
+```
+
+## Summary
+Returns the approximate natural logarithm of the factorial of a given
+integer.
+
+## Input
+### n
+The number to take the log-factorial of.
+
+## Output
+The natural logarithm of the factorial of the provided input.
+
+## See Also
+- Microsoft.Quantum.Math.ApproximateFactorial
+- Microsoft.Quantum.Math.FactorialI
+- Microsoft.Quantum.Math.FactorialL

package/docs/Microsoft.Quantum.Math/LogGammaD.md

@@ -0,0 +1,39 @@
+---
+uid: Microsoft.Quantum.Math.LogGammaD
+title: LogGammaD function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: LogGammaD
+qsharp.summary: Returns the natural logarithm of the gamma function (aka the log-gamma
+function).
+---
+
+# LogGammaD function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function LogGammaD(x : Double) : Double
+```
+
+## Summary
+Returns the natural logarithm of the gamma function (aka the log-gamma
+function).
+
+## Description
+The gamma function Γ(x) generalizes the factorial function
+to the positive real numbers and is defined as
+integral from 0 to ∞ of t¹⁻ˣ⋅e⁻ᵗ𝑑t
+
+The gamma function has the property that for all positive real numbers
+x, Γ(x + 1) = x⋅Γ(x), such that the factorial function
+is a special case of Γ, n! = Γ(n + 1) for all natural numbers n.
+
+## Input
+### x
+The point x at which the log-gamma function is to be evaluated.
+
+## Output
+The value ㏑(Γ(x)).