qsharp-lang 1.1.3 → 1.1.5-dev

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

@@ -0,0 +1,29 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ArgComplex
+title: ArgComplex function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ArgComplex
+qsharp.summary: Returns the phase of a complex number of type `Complex`.
+---
+
+# ArgComplex function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function ArgComplex(input : Complex) : Double
+```
+
+## Summary
+Returns the phase of a complex number of type
+`Complex`.
+
+## Input
+### input
+Complex number c = x + y𝑖.
+
+## Output
+Phase Arg(c) = ArcTan(y,x) ∈ (-𝜋,𝜋].

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

@@ -0,0 +1,28 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ArgComplexPolar
+title: ArgComplexPolar function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ArgComplexPolar
+qsharp.summary: Returns the phase of a complex number of type `ComplexPolar`.
+---
+
+# ArgComplexPolar function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function ArgComplexPolar(input : ComplexPolar) : Double
+```
+
+## Summary
+Returns the phase of a complex number of type `ComplexPolar`.
+
+## Input
+### input
+Complex number c = r⋅𝑒^(t𝑖).
+
+## Output
+Phase Arg(c) = t.

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

@@ -0,0 +1,34 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.Binom
+title: Binom function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Binom
+qsharp.summary: Returns the approximate binomial coefficient of two integers.
+---
+
+# Binom function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function Binom(n : Int, k : Int) : Int
+```
+
+## Summary
+Returns the approximate binomial coefficient of two integers.
+
+## Description
+Given two integers n and k, returns the binomial coefficient
+binom(n, k), also known as n-choose-k. Computed approximately.
+
+## Input
+### n
+The first of the two integers to compute the binomial coefficient of.
+### k
+The second of the two integers to compute the binomial coefficient of.
+
+## Output
+The binomial coefficient n-choose-k.

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

@@ -0,0 +1,22 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.BitSizeI
+title: BitSizeI function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: BitSizeI
+qsharp.summary: For a non-negative integer `a`, returns the number of bits required to represent `a`. NOTE: This function returns the smallest n such that a < 2^n.
+---
+
+# BitSizeI function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function BitSizeI(a : Int) : Int
+```
+
+## Summary
+For a non-negative integer `a`, returns the number of bits required to represent `a`.
+NOTE: This function returns the smallest n such that a < 2^n.

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

@@ -0,0 +1,22 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.BitSizeL
+title: BitSizeL function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: BitSizeL
+qsharp.summary: For a non-negative integer `a`, returns the number of bits required to represent `a`. NOTE: This function returns the smallest n such that a < 2^n.
+---
+
+# BitSizeL function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function BitSizeL(a : BigInt) : Int
+```
+
+## Summary
+For a non-negative integer `a`, returns the number of bits required to represent `a`.
+NOTE: This function returns the smallest n such that a < 2^n.

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

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

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

@@ -0,0 +1,29 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.Complex
+title: Complex user defined type
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: udt
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Complex
+qsharp.summary: Represents a complex number by its real and imaginary components. The first element of the tuple is the real component, the second one - the imaginary component.
+---
+
+# Complex user defined type
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+newtype Complex = (Real: Double, Imag: Double)
+```
+
+## Summary
+Represents a complex number by its real and imaginary components.
+The first element of the tuple is the real component,
+the second one - the imaginary component.
+
+## Example
+The following snippet defines the imaginary unit 𝑖 = 0 + 1𝑖:
+```qsharp
+let imagUnit = Complex(0.0, 1.0);
+```

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

@@ -0,0 +1,28 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ComplexPolar
+title: ComplexPolar user defined type
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: udt
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ComplexPolar
+qsharp.summary: Represents a complex number in polar form. The polar representation of a complex number is c = r⋅𝑒^(t𝑖).
+---
+
+# ComplexPolar user defined type
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+newtype ComplexPolar = (Magnitude: Double, Argument: Double)
+```
+
+## Summary
+Represents a complex number in polar form.
+The polar representation of a complex number is c = r⋅𝑒^(t𝑖).
+
+## Named Items
+### Magnitude
+The absolute value r>0 of c.
+### Argument
+The phase t ∈ ℝ of c.

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

@@ -0,0 +1,23 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ContinuedFractionConvergentI
+title: ContinuedFractionConvergentI function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ContinuedFractionConvergentI
+qsharp.summary: Finds the continued fraction convergent closest to `fraction` with the denominator less or equal to `denominatorBound` Using process similar to this: https://nrich.maths.org/1397
+---
+
+# ContinuedFractionConvergentI function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function ContinuedFractionConvergentI(fraction : (Int, Int), denominatorBound : Int) : (Int, Int)
+```
+
+## Summary
+Finds the continued fraction convergent closest to `fraction`
+with the denominator less or equal to `denominatorBound`
+Using process similar to this: https://nrich.maths.org/1397

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

@@ -0,0 +1,23 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ContinuedFractionConvergentL
+title: ContinuedFractionConvergentL function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ContinuedFractionConvergentL
+qsharp.summary: Finds the continued fraction convergent closest to `fraction` with the denominator less or equal to `denominatorBound` Using process similar to this: https://nrich.maths.org/1397
+---
+
+# ContinuedFractionConvergentL function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function ContinuedFractionConvergentL(fraction : (BigInt, BigInt), denominatorBound : BigInt) : (BigInt, BigInt)
+```
+
+## Summary
+Finds the continued fraction convergent closest to `fraction`
+with the denominator less or equal to `denominatorBound`
+Using process similar to this: https://nrich.maths.org/1397

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

@@ -0,0 +1,21 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.Cos
+title: Cos function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Cos
+qsharp.summary: Returns the cosine of the specified angle.
+---
+
+# Cos function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function Cos(theta : Double) : Double
+```
+
+## Summary
+Returns the cosine of the specified angle.

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

@@ -0,0 +1,21 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.Cosh
+title: Cosh function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Cosh
+qsharp.summary: Returns the hyperbolic cosine of the specified angle.
+---
+
+# Cosh function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function Cosh(d : Double) : Double
+```
+
+## Summary
+Returns the hyperbolic cosine of the specified angle.

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

@@ -0,0 +1,21 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.DivRemI
+title: DivRemI function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: DivRemI
+qsharp.summary: Divides one Integer value by another, returns the result and the remainder as a tuple.
+---
+
+# DivRemI function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function DivRemI(dividend : Int, divisor : Int) : (Int, Int)
+```
+
+## Summary
+Divides one Integer value by another, returns the result and the remainder as a tuple.

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

@@ -0,0 +1,21 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.DivRemL
+title: DivRemL function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: DivRemL
+qsharp.summary: Divides one BigInteger value by another, returns the result and the remainder as a tuple.
+---
+
+# DivRemL function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function DivRemL(dividend : BigInt, divisor : BigInt) : (BigInt, BigInt)
+```
+
+## Summary
+Divides one BigInteger value by another, returns the result and the remainder as a tuple.

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

@@ -0,0 +1,30 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.DividedByC
+title: DividedByC function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: DividedByC
+qsharp.summary: Returns the quotient of two inputs of type `Complex`.
+---
+
+# DividedByC function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function DividedByC(a : Complex, b : Complex) : Complex
+```
+
+## Summary
+Returns the quotient of two inputs of type `Complex`.
+
+## Input
+### a
+The first input a to be divided.
+### b
+The second input b to be divided.
+
+## Output
+The quotient a / b.

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

@@ -0,0 +1,30 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.DividedByCP
+title: DividedByCP function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: DividedByCP
+qsharp.summary: Returns the quotient of two inputs of type `ComplexPolar`.
+---
+
+# DividedByCP function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function DividedByCP(a : ComplexPolar, b : ComplexPolar) : ComplexPolar
+```
+
+## Summary
+Returns the quotient of two inputs of type `ComplexPolar`.
+
+## Input
+### a
+The first input a to be divided.
+### b
+The second input b to be divided.
+
+## Output
+The quotient a / b.

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

@@ -0,0 +1,28 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.E
+title: E function
+ms.date: 02/23/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
+
+```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,22 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ExpModI
+title: ExpModI function
+ms.date: 02/23/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
+
+```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,22 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ExpModL
+title: ExpModL function
+ms.date: 02/23/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
+
+```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,22 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ExtendedGreatestCommonDivisorI
+title: ExtendedGreatestCommonDivisorI function
+ms.date: 02/23/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
+
+```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,22 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ExtendedGreatestCommonDivisorL
+title: ExtendedGreatestCommonDivisorL function
+ms.date: 02/23/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
+
+```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: Qdk.Microsoft.Quantum.Math.FactorialI
+title: FactorialI function
+ms.date: 02/23/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
+
+```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: Qdk.Microsoft.Quantum.Math.FactorialL
+title: FactorialL function
+ms.date: 02/23/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
+
+```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,22 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.Floor
+title: Floor function
+ms.date: 02/23/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
+
+```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,22 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.GreatestCommonDivisorI
+title: GreatestCommonDivisorI function
+ms.date: 02/23/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
+
+```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,22 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.GreatestCommonDivisorL
+title: GreatestCommonDivisorL function
+ms.date: 02/23/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
+
+```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.