qsharp-lang 1.1.2-dev → 1.1.4-dev

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

@@ -0,0 +1,24 @@
+---
+uid: Microsoft.Quantum.Math.LogOf2
+title: LogOf2 function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: LogOf2
+qsharp.summary: Returns the natural logarithm of 2.
+---
+
+# LogOf2 function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function LogOf2() : Double
+```
+
+## Summary
+Returns the natural logarithm of 2.
+
+## Output
+Returns a `Double` equal to 0.6931471805599453.

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

@@ -0,0 +1,28 @@
+---
+uid: Microsoft.Quantum.Math.Max
+title: Max function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Max
+qsharp.summary: Given an array of integers, returns the largest element.
+---
+
+# Max function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function Max(values : Int[]) : Int
+```
+
+## Summary
+Given an array of integers, returns the largest element.
+
+## Input
+### values
+An array to take the maximum of.
+
+## Output
+The largest element of `values`.

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

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

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

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.MaxI
+title: MaxI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: MaxI
+qsharp.summary: Returns the larger of two specified numbers.
+---
+
+# MaxI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function MaxI(a : Int, b : Int) : Int
+```
+
+## Summary
+Returns the larger of two specified numbers.

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

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.MaxL
+title: MaxL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: MaxL
+qsharp.summary: Returns the larger of two specified numbers.
+---
+
+# MaxL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function MaxL(a : BigInt, b : BigInt) : BigInt
+```
+
+## Summary
+Returns the larger of two specified numbers.

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

@@ -0,0 +1,28 @@
+---
+uid: Microsoft.Quantum.Math.Min
+title: Min function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: Min
+qsharp.summary: Given an array of integers, returns the smallest element.
+---
+
+# Min function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function Min(values : Int[]) : Int
+```
+
+## Summary
+Given an array of integers, returns the smallest element.
+
+## Input
+### values
+An array to take the minimum of.
+
+## Output
+The smallest element of `values`.

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

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

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

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.MinI
+title: MinI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: MinI
+qsharp.summary: Returns the smaller of two specified numbers.
+---
+
+# MinI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function MinI(a : Int, b : Int) : Int
+```
+
+## Summary
+Returns the smaller of two specified numbers.

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

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.MinL
+title: MinL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: MinL
+qsharp.summary: Returns the smaller of two specified numbers.
+---
+
+# MinL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function MinL(a : BigInt, b : BigInt) : BigInt
+```
+
+## Summary
+Returns the smaller of two specified numbers.

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

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

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

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

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

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.ModulusI
+title: ModulusI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ModulusI
+qsharp.summary: Computes the canonical residue of `value` modulo `modulus`.
+The result is always in the range 0..modulus-1 even for negative numbers.
+---
+
+# ModulusI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function ModulusI(value : Int, modulus : Int) : Int
+```
+
+## Summary
+Computes the canonical residue of `value` modulo `modulus`.
+The result is always in the range 0..modulus-1 even for negative numbers.

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

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.ModulusL
+title: ModulusL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ModulusL
+qsharp.summary: Computes the canonical residue of `value` modulo `modulus`.
+The result is always in the range 0..modulus-1 even for negative numbers.
+---
+
+# ModulusL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function ModulusL(value : BigInt, modulus : BigInt) : BigInt
+```
+
+## Summary
+Computes the canonical residue of `value` modulo `modulus`.
+The result is always in the range 0..modulus-1 even for negative numbers.

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

@@ -0,0 +1,28 @@
+---
+uid: Microsoft.Quantum.Math.NegationC
+title: NegationC function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: NegationC
+qsharp.summary: Returns the unary negation of an input of type `Complex`.
+---
+
+# NegationC function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function NegationC(input : Complex) : Complex
+```
+
+## Summary
+Returns the unary negation of an input of type `Complex`.
+
+## Input
+### input
+A value whose negation is to be returned.
+
+## Output
+The unary negation of `input`.

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

@@ -0,0 +1,28 @@
+---
+uid: Microsoft.Quantum.Math.NegationCP
+title: NegationCP function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: NegationCP
+qsharp.summary: Returns the unary negation of an input of type `ComplexPolar`
+---
+
+# NegationCP function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function NegationCP(input : ComplexPolar) : ComplexPolar
+```
+
+## Summary
+Returns the unary negation of an input of type `ComplexPolar`
+
+## Input
+### input
+A value whose negation is to be returned.
+
+## Output
+The unary negation of `input`.

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

@@ -0,0 +1,28 @@
+---
+uid: Microsoft.Quantum.Math.PI
+title: PI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: PI
+qsharp.summary: Represents the ratio of the circumference of a circle to its diameter.
+---
+
+# PI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function PI() : Double
+```
+
+## Summary
+Represents the ratio of the circumference of a circle to its diameter.
+
+## Output
+A double-precision approximation of the the circumference of a circle
+to its diameter, π ≈ 3.14159265358979323846.
+
+## See Also
+- Microsoft.Quantum.Math.E

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

@@ -0,0 +1,34 @@
+---
+uid: Microsoft.Quantum.Math.PNorm
+title: PNorm function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: PNorm
+qsharp.summary: Returns the `L(p)` norm of a vector of `Double`s.
+
+That is, given an array x of type `Double[]`, this returns the p-norm
+|x̄|ₚ= (∑(xᵢ)ᵖ)¹ᐟᵖ.
+---
+
+# PNorm function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function PNorm(p : Double, array : Double[]) : Double
+```
+
+## Summary
+Returns the `L(p)` norm of a vector of `Double`s.
+
+That is, given an array x of type `Double[]`, this returns the p-norm
+|x̄|ₚ= (∑(xᵢ)ᵖ)¹ᐟᵖ.
+
+## Input
+### p
+The exponent p in the p-norm.
+
+## Output
+The p-norm |x̄|ₚ.

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

@@ -0,0 +1,39 @@
+---
+uid: Microsoft.Quantum.Math.PNormalized
+title: PNormalized function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: PNormalized
+qsharp.summary: Normalizes a vector of `Double`s in the `L(p)` norm.
+
+That is, given an array x of type `Double[]`, this returns an array where
+all elements are divided by the p-norm |x̄|ₚ.
+Function leaves array with norm 0 unchanged.
+---
+
+# PNormalized function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function PNormalized(p : Double, array : Double[]) : Double[]
+```
+
+## Summary
+Normalizes a vector of `Double`s in the `L(p)` norm.
+
+That is, given an array x of type `Double[]`, this returns an array where
+all elements are divided by the p-norm |x̄|ₚ.
+Function leaves array with norm 0 unchanged.
+
+## Input
+### p
+The exponent p in the p-norm.
+
+## Output
+The array x normalized by the p-norm |x̄|ₚ.
+
+## See Also
+- PNorm

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

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

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

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

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

@@ -0,0 +1,32 @@
+---
+uid: Microsoft.Quantum.Math.PowC
+title: PowC function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: PowC
+qsharp.summary: Returns a number raised to a given power of type `Complex`.
+Note that this is a multi-valued function, but only one value is returned.
+---
+
+# PowC function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function PowC(a : Complex, power : Complex) : Complex
+```
+
+## Summary
+Returns a number raised to a given power of type `Complex`.
+Note that this is a multi-valued function, but only one value is returned.
+
+## Input
+### a
+The number a that is to be raised.
+### power
+The power b to which a should be raised.
+
+## Output
+The power a^b

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

@@ -0,0 +1,32 @@
+---
+uid: Microsoft.Quantum.Math.PowCP
+title: PowCP function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: PowCP
+qsharp.summary: Returns a number raised to a given power of type `ComplexPolar`.
+Note that this is a multi-valued function, but only one value is returned.
+---
+
+# PowCP function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function PowCP(a : ComplexPolar, power : ComplexPolar) : ComplexPolar
+```
+
+## Summary
+Returns a number raised to a given power of type `ComplexPolar`.
+Note that this is a multi-valued function, but only one value is returned.
+
+## Input
+### a
+The number a that is to be raised.
+### power
+The power b to which a should be raised.
+
+## Output
+The power a^b

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

@@ -0,0 +1,38 @@
+---
+uid: Microsoft.Quantum.Math.RealMod
+title: RealMod function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: RealMod
+qsharp.summary: Computes the modulus between two real numbers.
+---
+
+# RealMod function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function RealMod(value : Double, modulo : Double, minValue : Double) : Double
+```
+
+## Summary
+Computes the modulus between two real numbers.
+
+## Input
+### value
+A real number x to take the modulus of.
+### modulo
+A real number to take the modulus of x with respect to.
+### minValue
+The smallest value to be returned by this function.
+
+## Example
+```qsharp
+    // Returns 3 π / 2.
+    let y = RealMod(5.5 * PI(), 2.0 * PI(), 0.0);
+    // Returns -1.2, since +3.6 and -1.2 are 4.8 apart on the real line,
+    // which is a multiple of 2.4.
+    let z = RealMod(3.6, 2.4, -1.2);
+```

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

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