qsharp-lang 1.1.2-dev → 1.1.4-dev

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

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.SignD
+title: SignD function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: SignD
+qsharp.summary: Returns -1, 0 or +1 that indicates the sign of a number.
+---
+
+# SignD function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function SignD(a : Double) : Int
+```
+
+## Summary
+Returns -1, 0 or +1 that indicates the sign of a number.

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

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.SignI
+title: SignI function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: SignI
+qsharp.summary: Returns -1, 0 or +1 that indicates the sign of a number.
+---
+
+# SignI function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function SignI(a : Int) : Int
+```
+
+## Summary
+Returns -1, 0 or +1 that indicates the sign of a number.

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

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Math.SignL
+title: SignL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: SignL
+qsharp.summary: Returns -1, 0 or +1 that indicates the sign of a number.
+---
+
+# SignL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function SignL(a : BigInt) : Int
+```
+
+## Summary
+Returns -1, 0 or +1 that indicates the sign of a number.

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

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

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

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

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

@@ -0,0 +1,30 @@
+---
+uid: Microsoft.Quantum.Math.SmallestFixedPoint
+title: SmallestFixedPoint function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: SmallestFixedPoint
+qsharp.summary: Returns the smallest representable number for specific fixed point dimensions.
+---
+
+# SmallestFixedPoint function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function SmallestFixedPoint(integerBits : Int, fractionalBits : Int) : Double
+```
+
+## Summary
+Returns the smallest 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), where p is the number of integer bits.

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

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

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

@@ -0,0 +1,32 @@
+---
+uid: Microsoft.Quantum.Math.SquaredNorm
+title: SquaredNorm function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: SquaredNorm
+qsharp.summary: Returns the squared 2-norm of a vector.
+---
+
+# SquaredNorm function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function SquaredNorm(array : Double[]) : Double
+```
+
+## Summary
+Returns the squared 2-norm of a vector.
+
+## Description
+Returns the squared 2-norm of a vector; that is, given an input
+x̄, returns ∑xᵢ.
+
+## Input
+### array
+The vector whose squared 2-norm is to be returned.
+
+## Output
+The squared 2-norm of `array`.

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,23 @@
+---
+uid: Microsoft.Quantum.Math.TrailingZeroCountL
+title: TrailingZeroCountL function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: TrailingZeroCountL
+qsharp.summary: For a non-zero integer `a`, returns the number of trailing zero bits
+in the binary representation of `a`.
+---
+
+# TrailingZeroCountL function
+
+Namespace: [Microsoft.Quantum.Math](xref:Microsoft.Quantum.Math)
+
+```qsharp
+function TrailingZeroCountL(a : BigInt) : Int
+```
+
+## Summary
+For a non-zero integer `a`, returns the number of trailing zero bits
+in the binary representation of `a`.

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

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

package/docs/Microsoft.Quantum.Measurement/MResetEachZ.md

@@ -0,0 +1,28 @@
+---
+uid: Microsoft.Quantum.Measurement.MResetEachZ
+title: MResetEachZ operation
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: opeartion
+qsharp.namespace: Microsoft.Quantum.Measurement
+qsharp.name: MResetEachZ
+qsharp.summary: Measures each qubit in a given array in the Z basis
+and resets them to a fixed initial state.
+---
+
+# MResetEachZ operation
+
+Namespace: [Microsoft.Quantum.Measurement](xref:Microsoft.Quantum.Measurement)
+
+```qsharp
+operation MResetEachZ(register : Qubit[]) : Result[]
+```
+
+## Summary
+Measures each qubit in a given array in the Z basis
+and resets them to a fixed initial state.
+## Input
+### targets
+An array of qubits to be measured.
+## Output
+An array of measurement results.

package/docs/Microsoft.Quantum.Measurement/MResetX.md

@@ -0,0 +1,37 @@
+---
+uid: Microsoft.Quantum.Measurement.MResetX
+title: MResetX operation
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: opeartion
+qsharp.namespace: Microsoft.Quantum.Measurement
+qsharp.name: MResetX
+qsharp.summary: Measures a single qubit in the X basis,
+and resets it to a fixed initial state
+following the measurement.
+---
+
+# MResetX operation
+
+Namespace: [Microsoft.Quantum.Measurement](xref:Microsoft.Quantum.Measurement)
+
+```qsharp
+operation MResetX(target : Qubit) : Result
+```
+
+## Summary
+Measures a single qubit in the X basis,
+and resets it to a fixed initial state
+following the measurement.
+
+## Description
+Performs a single-qubit measurement in the X-basis,
+and ensures that the qubit is returned to |0⟩
+following the measurement.
+
+## Input
+### target
+A single qubit to be measured.
+
+## Output
+The result of measuring `target` in the Pauli X basis.

package/docs/Microsoft.Quantum.Measurement/MResetY.md

@@ -0,0 +1,37 @@
+---
+uid: Microsoft.Quantum.Measurement.MResetY
+title: MResetY operation
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: opeartion
+qsharp.namespace: Microsoft.Quantum.Measurement
+qsharp.name: MResetY
+qsharp.summary: Measures a single qubit in the Y basis,
+and resets it to a fixed initial state
+following the measurement.
+---
+
+# MResetY operation
+
+Namespace: [Microsoft.Quantum.Measurement](xref:Microsoft.Quantum.Measurement)
+
+```qsharp
+operation MResetY(target : Qubit) : Result
+```
+
+## Summary
+Measures a single qubit in the Y basis,
+and resets it to a fixed initial state
+following the measurement.
+
+## Description
+Performs a single-qubit measurement in the Y-basis,
+and ensures that the qubit is returned to |0⟩
+following the measurement.
+
+## Input
+### target
+A single qubit to be measured.
+
+## Output
+The result of measuring `target` in the Pauli Y basis.

package/docs/Microsoft.Quantum.Measurement/MResetZ.md

@@ -0,0 +1,37 @@
+---
+uid: Microsoft.Quantum.Measurement.MResetZ
+title: MResetZ operation
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: opeartion
+qsharp.namespace: Microsoft.Quantum.Measurement
+qsharp.name: MResetZ
+qsharp.summary: Measures a single qubit in the Z basis,
+and resets it to a fixed initial state
+following the measurement.
+---
+
+# MResetZ operation
+
+Namespace: [Microsoft.Quantum.Measurement](xref:Microsoft.Quantum.Measurement)
+
+```qsharp
+operation MResetZ(target : Qubit) : Result
+```
+
+## Summary
+Measures a single qubit in the Z basis,
+and resets it to a fixed initial state
+following the measurement.
+
+## Description
+Performs a single-qubit measurement in the Z-basis,
+and ensures that the qubit is returned to |0⟩
+following the measurement.
+
+## Input
+### target
+A single qubit to be measured.
+
+## Output
+The result of measuring `target` in the Pauli Z basis.

package/docs/Microsoft.Quantum.Measurement/MeasureAllZ.md

@@ -0,0 +1,36 @@
+---
+uid: Microsoft.Quantum.Measurement.MeasureAllZ
+title: MeasureAllZ operation
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: opeartion
+qsharp.namespace: Microsoft.Quantum.Measurement
+qsharp.name: MeasureAllZ
+qsharp.summary: Jointly measures a register of qubits in the Pauli Z basis.
+---
+
+# MeasureAllZ operation
+
+Namespace: [Microsoft.Quantum.Measurement](xref:Microsoft.Quantum.Measurement)
+
+```qsharp
+operation MeasureAllZ(register : Qubit[]) : Result
+```
+
+## Summary
+Jointly measures a register of qubits in the Pauli Z basis.
+
+## Description
+Measures a register of qubits in the `Z ⊗ Z ⊗ ••• ⊗ Z`
+basis, representing the parity of the entire register.
+
+## Input
+### register
+The register to be measured.
+
+## Output
+The result of measuring `Z ⊗ Z ⊗ ••• ⊗ Z`.
+
+## Remarks
+This operation does not reset the measured qubits to the |0⟩ state,
+leaving them in the state that corresponds to the measurement result.

package/docs/Microsoft.Quantum.Measurement/MeasureEachZ.md

@@ -0,0 +1,30 @@
+---
+uid: Microsoft.Quantum.Measurement.MeasureEachZ
+title: MeasureEachZ operation
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: opeartion
+qsharp.namespace: Microsoft.Quantum.Measurement
+qsharp.name: MeasureEachZ
+qsharp.summary: Measures each qubit in a given array in the standard basis.
+---
+
+# MeasureEachZ operation
+
+Namespace: [Microsoft.Quantum.Measurement](xref:Microsoft.Quantum.Measurement)
+
+```qsharp
+operation MeasureEachZ(register : Qubit[]) : Result[]
+```
+
+## Summary
+Measures each qubit in a given array in the standard basis.
+## Input
+### targets
+An array of qubits to be measured.
+## Output
+An array of measurement results.
+
+## Remarks
+This operation does not reset the measured qubits to the |0⟩ state,
+leaving them in the state that corresponds to the measurement results.

package/docs/Microsoft.Quantum.Measurement/MeasureInteger.md

@@ -0,0 +1,36 @@
+---
+uid: Microsoft.Quantum.Measurement.MeasureInteger
+title: MeasureInteger operation
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: opeartion
+qsharp.namespace: Microsoft.Quantum.Measurement
+qsharp.name: MeasureInteger
+qsharp.summary: Measures the content of a quantum register and converts
+it to an integer. The measurement is performed with respect
+to the standard computational basis, i.e., the eigenbasis of `PauliZ`.
+---
+
+# MeasureInteger operation
+
+Namespace: [Microsoft.Quantum.Measurement](xref:Microsoft.Quantum.Measurement)
+
+```qsharp
+operation MeasureInteger(target : Qubit[]) : Int
+```
+
+## Summary
+Measures the content of a quantum register and converts
+it to an integer. The measurement is performed with respect
+to the standard computational basis, i.e., the eigenbasis of `PauliZ`.
+
+## Input
+### target
+A quantum register in the little-endian encoding.
+
+## Output
+An unsigned integer that contains the measured value of `target`.
+
+## Remarks
+This operation resets its input register to the |00...0> state,
+suitable for releasing back to a target machine.

package/docs/Microsoft.Quantum.Random/DrawRandomDouble.md

@@ -0,0 +1,40 @@
+---
+uid: Microsoft.Quantum.Random.DrawRandomDouble
+title: DrawRandomDouble operation
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: opeartion
+qsharp.namespace: Microsoft.Quantum.Random
+qsharp.name: DrawRandomDouble
+qsharp.summary: Draws a random real number in a given inclusive interval.
+---
+
+# DrawRandomDouble operation
+
+Namespace: [Microsoft.Quantum.Random](xref:Microsoft.Quantum.Random)
+
+```qsharp
+operation DrawRandomDouble(min : Double, max : Double) : Double
+```
+
+## Summary
+Draws a random real number in a given inclusive interval.
+
+## Input
+### min
+The smallest real number to be drawn.
+### max
+The largest real number to be drawn.
+
+## Output
+A random real number in the inclusive interval from `min` to `max` with
+uniform probability.
+
+## Remarks
+Fails if `max < min`.
+
+## Example
+The following Q# snippet randomly draws an angle between 0 and 2π:
+```qsharp
+let angle = DrawRandomDouble(0.0, 2.0 * PI());
+```