qsharp-lang 1.1.3 → 1.1.5-dev

package/docs/Microsoft.Quantum.Intrinsic/Rzz.md

@@ -0,0 +1,42 @@
+---
+uid: Qdk.Microsoft.Quantum.Intrinsic.Rzz
+title: Rzz operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Intrinsic
+qsharp.name: Rzz
+qsharp.summary: Applies the two qubit Ising _ZZ_ rotation gate.
+---
+
+# Rzz operation
+
+Namespace: Microsoft.Quantum.Intrinsic
+
+```qsharp
+operation Rzz(theta : Double, qubit0 : Qubit, qubit1 : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the two qubit Ising _ZZ_ rotation gate.
+
+## Input
+### theta
+The angle about which the qubits are rotated.
+### qubit0
+The first qubit input to the gate.
+### qubit1
+The second qubit input to the gate.
+
+## Remarks
+$$
+\begin{align}
+    R_{zz}(\theta) \mathrel{:=}
+    \begin{bmatrix}
+        e^{-i \theta / 2} & 0 & 0 & 0 \\\\
+        0 & e^{i \theta / 2} & 0 & 0 \\\\
+        0 & 0 & e^{i \theta / 2} & 0 \\\\
+        0 & 0 & 0 & e^{-i \theta / 2}
+    \end{bmatrix}.
+\end{align}
+$$

package/docs/Microsoft.Quantum.Intrinsic/S.md

@@ -0,0 +1,36 @@
+---
+uid: Qdk.Microsoft.Quantum.Intrinsic.S
+title: S operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Intrinsic
+qsharp.name: S
+qsharp.summary: Applies the π/4 phase gate to a single qubit.
+---
+
+# S operation
+
+Namespace: Microsoft.Quantum.Intrinsic
+
+```qsharp
+operation S(qubit : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the π/4 phase gate to a single qubit.
+
+## Input
+### qubit
+Qubit to which the gate should be applied.
+
+## Remarks
+$$
+\begin{align}
+    S \mathrel{:=}
+    \begin{bmatrix}
+        1 & 0 \\\\
+        0 & i
+    \end{bmatrix}.
+\end{align}
+$$

package/docs/Microsoft.Quantum.Intrinsic/SWAP.md

@@ -0,0 +1,49 @@
+---
+uid: Qdk.Microsoft.Quantum.Intrinsic.SWAP
+title: SWAP operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Intrinsic
+qsharp.name: SWAP
+qsharp.summary: Applies the SWAP gate to a pair of qubits.
+---
+
+# SWAP operation
+
+Namespace: Microsoft.Quantum.Intrinsic
+
+```qsharp
+operation SWAP(qubit1 : Qubit, qubit2 : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the SWAP gate to a pair of qubits.
+
+## Input
+### qubit1
+First qubit to be swapped.
+### qubit2
+Second qubit to be swapped.
+
+## Remarks
+$$
+\begin{align}
+    \operatorname{SWAP} \mathrel{:=}
+    \begin{bmatrix}
+        1 & 0 & 0 & 0 \\\\
+        0 & 0 & 1 & 0 \\\\
+        0 & 1 & 0 & 0 \\\\
+        0 & 0 & 0 & 1
+    \end{bmatrix},
+\end{align}
+$$
+
+where rows and columns are ordered as in the quantum concepts guide.
+
+Equivalent to:
+```qsharp
+CNOT(qubit1, qubit2);
+CNOT(qubit2, qubit1);
+CNOT(qubit1, qubit2);
+```

package/docs/Microsoft.Quantum.Intrinsic/T.md

@@ -0,0 +1,36 @@
+---
+uid: Qdk.Microsoft.Quantum.Intrinsic.T
+title: T operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Intrinsic
+qsharp.name: T
+qsharp.summary: Applies the π/8 gate to a single qubit.
+---
+
+# T operation
+
+Namespace: Microsoft.Quantum.Intrinsic
+
+```qsharp
+operation T(qubit : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the π/8 gate to a single qubit.
+
+## Input
+### qubit
+Qubit to which the gate should be applied.
+
+## Remarks
+$$
+\begin{align}
+    T \mathrel{:=}
+    \begin{bmatrix}
+        1 & 0 \\\\
+        0 & e^{i \pi / 4}
+    \end{bmatrix}.
+\end{align}
+$$

package/docs/Microsoft.Quantum.Intrinsic/X.md

@@ -0,0 +1,36 @@
+---
+uid: Qdk.Microsoft.Quantum.Intrinsic.X
+title: X operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Intrinsic
+qsharp.name: X
+qsharp.summary: Applies the Pauli _X_ gate.
+---
+
+# X operation
+
+Namespace: Microsoft.Quantum.Intrinsic
+
+```qsharp
+operation X(qubit : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the Pauli _X_ gate.
+
+## Input
+### qubit
+Qubit to which the gate should be applied.
+
+## Remarks
+$$
+\begin{align}
+    \sigma_x \mathrel{:=}
+    \begin{bmatrix}
+        0 & 1 \\\\
+        1 & 0
+    \end{bmatrix}.
+\end{align}
+$$

package/docs/Microsoft.Quantum.Intrinsic/Y.md

@@ -0,0 +1,36 @@
+---
+uid: Qdk.Microsoft.Quantum.Intrinsic.Y
+title: Y operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Intrinsic
+qsharp.name: Y
+qsharp.summary: Applies the Pauli _Y_ gate.
+---
+
+# Y operation
+
+Namespace: Microsoft.Quantum.Intrinsic
+
+```qsharp
+operation Y(qubit : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the Pauli _Y_ gate.
+
+## Input
+### qubit
+Qubit to which the gate should be applied.
+
+## Remarks
+$$
+\begin{align}
+    \sigma_y \mathrel{:=}
+    \begin{bmatrix}
+        0 & -i \\\\
+        i & 0
+    \end{bmatrix}.
+\end{align}
+$$

package/docs/Microsoft.Quantum.Intrinsic/Z.md

@@ -0,0 +1,36 @@
+---
+uid: Qdk.Microsoft.Quantum.Intrinsic.Z
+title: Z operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Intrinsic
+qsharp.name: Z
+qsharp.summary: Applies the Pauli _Z_ gate.
+---
+
+# Z operation
+
+Namespace: Microsoft.Quantum.Intrinsic
+
+```qsharp
+operation Z(qubit : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the Pauli _Z_ gate.
+
+## Input
+### qubit
+Qubit to which the gate should be applied.
+
+## Remarks
+$$
+\begin{align}
+    \sigma_z \mathrel{:=}
+    \begin{bmatrix}
+        1 & 0 \\\\
+        0 & -1
+    \end{bmatrix}.
+\end{align}
+$$

package/docs/Microsoft.Quantum.Logical/Xor.md

@@ -0,0 +1,38 @@
+---
+uid: Qdk.Microsoft.Quantum.Logical.Xor
+title: Xor function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Logical
+qsharp.name: Xor
+qsharp.summary: Returns the boolean exclusive disjunction (XOR) of two input boolean values.
+---
+
+# Xor function
+
+Namespace: Microsoft.Quantum.Logical
+
+```qsharp
+function Xor(first : Bool, second : Bool) : Bool
+```
+
+## Summary
+Returns the boolean exclusive disjunction (XOR) of two input boolean values.
+
+## Input
+### first
+The first boolean value to be considered.
+
+### second
+The second boolean value to be considered.
+
+## Output
+A `Bool` which is `true` if and only if exactly one of `first` and `second` is `true`.
+
+## Example
+```qsharp
+
+let result = Xor(true, false);
+// result is true
+```

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

@@ -0,0 +1,29 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.AbsComplex
+title: AbsComplex function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: AbsComplex
+qsharp.summary: Returns the absolute value of a complex number of type `Complex`.
+---
+
+# AbsComplex function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function AbsComplex(input : Complex) : Double
+```
+
+## Summary
+Returns the absolute value of a complex number of type
+`Complex`.
+
+## Input
+### input
+Complex number c = x + y𝑖.
+
+## Output
+Absolute value |c| = √(x² + y²).

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

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

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

@@ -0,0 +1,21 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.AbsD
+title: AbsD function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: AbsD
+qsharp.summary: Returns the absolute value of a double-precision floating-point number.
+---
+
+# AbsD function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function AbsD(a : Double) : Double
+```
+
+## Summary
+Returns the absolute value of a double-precision floating-point number.

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

@@ -0,0 +1,21 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.AbsI
+title: AbsI function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: AbsI
+qsharp.summary: Returns the absolute value of an integer.
+---
+
+# AbsI function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function AbsI(a : Int) : Int
+```
+
+## Summary
+Returns the absolute value of an integer.

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

@@ -0,0 +1,20 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.AbsL
+title: AbsL function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: AbsL
+qsharp.summary: 
+---
+
+# AbsL function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function AbsL(a : BigInt) : BigInt
+```
+
+## Summary

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

@@ -0,0 +1,29 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.AbsSquaredComplex
+title: AbsSquaredComplex function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: AbsSquaredComplex
+qsharp.summary: Returns the squared absolute value of a complex number of type `Complex`.
+---
+
+# AbsSquaredComplex function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function AbsSquaredComplex(input : Complex) : Double
+```
+
+## Summary
+Returns the squared absolute value of a complex number of type
+`Complex`.
+
+## Input
+### input
+Complex number c = x + y𝑖.
+
+## Output
+Squared absolute value |c|² = x² + y².

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

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

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

@@ -0,0 +1,40 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ApproximateFactorial
+title: ApproximateFactorial function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ApproximateFactorial
+qsharp.summary: Returns an approximate factorial of a given number.
+---
+
+# ApproximateFactorial function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function ApproximateFactorial(n : Int) : Double
+```
+
+## Summary
+Returns an approximate factorial of a given number.
+
+## Description
+Returns the factorial as `Double`, given an input `n`.
+The domain of inputs for this function is `n <= 169`.
+
+## Remarks
+For n > 10, this function uses the Ramanujan approximation with a
+relative error of the order of 1 / n⁵.
+
+## Input
+### n
+The number to take the approximate factorial of. Must not be negative.
+
+## Output
+The approximate factorial of `n`.
+
+## See Also
+- Microsoft.Quantum.Math.FactorialI
+- Microsoft.Quantum.Math.FactorialL

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

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

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

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

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

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

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

@@ -0,0 +1,21 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ArcSinh
+title: ArcSinh function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ArcSinh
+qsharp.summary: Computes the inverse hyperbolic sine of a number.
+---
+
+# ArcSinh function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function ArcSinh(x : Double) : Double
+```
+
+## Summary
+Computes the inverse hyperbolic sine of a number.

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

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

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

@@ -0,0 +1,21 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ArcTan2
+title: ArcTan2 function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ArcTan2
+qsharp.summary: Returns the angle whose tangent is the quotient of two specified numbers.
+---
+
+# ArcTan2 function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function ArcTan2(y : Double, x : Double) : Double
+```
+
+## Summary
+Returns the angle whose tangent is the quotient of two specified numbers.

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

@@ -0,0 +1,21 @@
+---
+uid: Qdk.Microsoft.Quantum.Math.ArcTanh
+title: ArcTanh function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Math
+qsharp.name: ArcTanh
+qsharp.summary: Computes the inverse hyperbolic tangent of a number.
+---
+
+# ArcTanh function
+
+Namespace: Microsoft.Quantum.Math
+
+```qsharp
+function ArcTanh(x : Double) : Double
+```
+
+## Summary
+Computes the inverse hyperbolic tangent of a number.