qsharp-lang 1.1.3 → 1.1.5-dev

package/docs/Microsoft.Quantum.Canon/ApplyPauliFromInt.md

@@ -0,0 +1,44 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.ApplyPauliFromInt
+title: ApplyPauliFromInt operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: ApplyPauliFromInt
+qsharp.summary: Applies a Pauli operator on each qubit in an array if the corresponding bit of a Little-endian integer matches a given input.
+---
+
+# ApplyPauliFromInt operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation ApplyPauliFromInt(pauli : Pauli, bitApply : Bool, numberState : Int, qubits : Qubit[]) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies a Pauli operator on each qubit in an array if the corresponding
+bit of a Little-endian integer matches a given input.
+
+## Input
+### pauli
+Pauli operator to apply to `qubits[idx]` when bit of numberState
+in idx position is the same as bitApply.
+### bitApply
+apply Pauli if bit is this value
+### numberState
+Little-endian integer specifying which corresponding qubit in `qubits` should be operated on
+### qubits
+Quantum register on which to selectively apply the specified Pauli operator
+
+## Example
+The following applies an X operation on qubits 0 and 2, and a Z operation on qubits 1 and 3.
+```qsharp
+use qubits = Qubit[4];
+let n = 5;
+// Apply when index in `bits` is `true`.
+ApplyPauliFromBitString(PauliX, true, n, qubits);
+// Apply when index in `bits` is `false`.
+ApplyPauliFromBitString(PauliZ, false, n, qubits);
+```

package/docs/Microsoft.Quantum.Canon/ApplyQFT.md

@@ -0,0 +1,34 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.ApplyQFT
+title: ApplyQFT operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: ApplyQFT
+qsharp.summary: Applies Quantum Fourier Transform (QFT) to a little-endian quantum register.
+---
+
+# ApplyQFT operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation ApplyQFT(qs : Qubit[]) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies Quantum Fourier Transform (QFT) to a little-endian quantum register.
+
+## Description
+Applies QFT to a little-endian register `qs` of length n
+containing |x₁⟩⊗|x₂⟩⊗…⊗|xₙ⟩. The qs[0] contains the
+least significant bit xₙ. The state of qs[0] becomes
+(|0⟩+𝑒^(2π𝑖[0.xₙ])|1⟩)/sqrt(2) after the operation.
+
+## Input
+### qs
+Quantum register in a little-endian format to which the QFT is applied.
+
+## Reference
+ - [Quantum Fourier transform](https://en.wikipedia.org/wiki/Quantum_Fourier_transform)

package/docs/Microsoft.Quantum.Canon/ApplyToEach.md

@@ -0,0 +1,38 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.ApplyToEach
+title: ApplyToEach operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: ApplyToEach
+qsharp.summary: Applies an operation to each element in a register.
+---
+
+# ApplyToEach operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation ApplyToEach<'T>(singleElementOperation : ('T => Unit), register : 'T[]) : Unit
+```
+
+## Summary
+Applies an operation to each element in a register.
+
+## Input
+### singleElementOperation
+Operation to apply to each element.
+### register
+Array of elements on which to apply the given operation.
+
+## Type Parameters
+### 'T
+The target on which the operation acts.
+
+## Example
+Prepare a three-qubit |+⟩ state:
+```qsharp
+use register = Qubit[3];
+ApplyToEach(H, register);
+```

package/docs/Microsoft.Quantum.Canon/ApplyToEachA.md

@@ -0,0 +1,42 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.ApplyToEachA
+title: ApplyToEachA operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: ApplyToEachA
+qsharp.summary: Applies an operation to each element in a register. The modifier `A` indicates that the single-element operation is adjointable.
+---
+
+# ApplyToEachA operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation ApplyToEachA<'T>(singleElementOperation : ('T => Unit is Adj), register : 'T[]) : Unit is Adj
+```
+
+## Summary
+Applies an operation to each element in a register.
+The modifier `A` indicates that the single-element operation is adjointable.
+
+## Input
+### singleElementOperation
+Operation to apply to each element.
+### register
+Array of elements on which to apply the given operation.
+
+## Type Parameters
+### 'T
+The target on which the operation acts.
+
+## Example
+Prepare a three-qubit |+⟩ state:
+```qsharp
+use register = Qubit[3];
+ApplyToEach(H, register);
+```
+
+## See Also
+- Microsoft.Quantum.Canon.ApplyToEach

package/docs/Microsoft.Quantum.Canon/ApplyToEachC.md

@@ -0,0 +1,42 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.ApplyToEachC
+title: ApplyToEachC operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: ApplyToEachC
+qsharp.summary: Applies an operation to each element in a register. The modifier `C` indicates that the single-element operation is controllable.
+---
+
+# ApplyToEachC operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation ApplyToEachC<'T>(singleElementOperation : ('T => Unit is Ctl), register : 'T[]) : Unit is Ctl
+```
+
+## Summary
+Applies an operation to each element in a register.
+The modifier `C` indicates that the single-element operation is controllable.
+
+## Input
+### singleElementOperation
+Operation to apply to each element.
+### register
+Array of elements on which to apply the given operation.
+
+## Type Parameters
+### 'T
+The target on which the operation acts.
+
+## Example
+Prepare a three-qubit |+⟩ state:
+```qsharp
+use register = Qubit[3];
+ApplyToEach(H, register);
+```
+
+## See Also
+- Microsoft.Quantum.Canon.ApplyToEach

package/docs/Microsoft.Quantum.Canon/ApplyToEachCA.md

@@ -0,0 +1,42 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.ApplyToEachCA
+title: ApplyToEachCA operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: ApplyToEachCA
+qsharp.summary: Applies an operation to each element in a register. The modifier `CA` indicates that the single-element operation is controllable and adjointable.
+---
+
+# ApplyToEachCA operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation ApplyToEachCA<'T>(singleElementOperation : ('T => Unit is Adj + Ctl), register : 'T[]) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies an operation to each element in a register.
+The modifier `CA` indicates that the single-element operation is controllable and adjointable.
+
+## Input
+### singleElementOperation
+Operation to apply to each element.
+### register
+Array of elements on which to apply the given operation.
+
+## Type Parameters
+### 'T
+The target on which the operation acts.
+
+## Example
+Prepare a three-qubit |+⟩ state:
+```qsharp
+use register = Qubit[3];
+ApplyToEach(H, register);
+```
+
+## See Also
+- Microsoft.Quantum.Canon.ApplyToEach

package/docs/Microsoft.Quantum.Canon/ApplyXorInPlace.md

@@ -0,0 +1,30 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.ApplyXorInPlace
+title: ApplyXorInPlace operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: ApplyXorInPlace
+qsharp.summary: Applies a bitwise-XOR operation between a classical integer and an integer represented by a register of qubits.
+---
+
+# ApplyXorInPlace operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation ApplyXorInPlace(value : Int, target : Qubit[]) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies a bitwise-XOR operation between a classical integer and an
+integer represented by a register of qubits.
+
+## Description
+Applies `X` operations to qubits in a little-endian register based on
+1 bits in an integer.
+
+Let us denote `value` by a and let y be an unsigned integer encoded in `target`,
+then `ApplyXorInPlace` performs an operation given by the following map:
+|y⟩ ↦ |y ⊕ a⟩, where ⊕ is the bitwise exclusive OR operator.

package/docs/Microsoft.Quantum.Canon/ApplyXorInPlaceL.md

@@ -0,0 +1,30 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.ApplyXorInPlaceL
+title: ApplyXorInPlaceL operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: ApplyXorInPlaceL
+qsharp.summary: Applies a bitwise-XOR operation between a classical integer and an integer represented by a register of qubits.
+---
+
+# ApplyXorInPlaceL operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation ApplyXorInPlaceL(value : BigInt, target : Qubit[]) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies a bitwise-XOR operation between a classical integer and an
+integer represented by a register of qubits.
+
+## Description
+Applies `X` operations to qubits in a little-endian register based on
+1 bits in an integer.
+
+Let us denote `value` by a and let y be an unsigned integer encoded in `target`,
+then `ApplyXorInPlace` performs an operation given by the following map:
+|y⟩ ↦ |y ⊕ a⟩, where ⊕ is the bitwise exclusive OR operator.

package/docs/Microsoft.Quantum.Canon/CX.md

@@ -0,0 +1,50 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.CX
+title: CX operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: CX
+qsharp.summary: Applies the controlled-X (CX) gate to a pair of qubits.
+---
+
+# CX operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation CX(control : Qubit, target : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the controlled-X (CX) gate to a pair of qubits.
+
+## Input
+### control
+Control qubit for the CX gate.
+### target
+Target qubit for the CX gate.
+
+## Remarks
+This operation can be simulated by the unitary matrix
+$$
+\begin{align}
+    \left(\begin{matrix}
+        1 & 0 & 0 & 0 \\\\
+        0 & 1 & 0 & 0 \\\\
+        0 & 0 & 0 & 1 \\\\
+        0 & 0 & 1 & 0
+     \end{matrix}\right)
+\end{align},
+$$
+where rows and columns are organized as in the quantum concepts guide.
+
+Equivalent to:
+```qsharp
+Controlled X([control], target);
+```
+and to:
+```qsharp
+CNOT(control, target);
+```

package/docs/Microsoft.Quantum.Canon/CY.md

@@ -0,0 +1,44 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.CY
+title: CY operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: CY
+qsharp.summary: Applies the controlled-Y (CY) gate to a pair of qubits.
+---
+
+# CY operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation CY(control : Qubit, target : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the controlled-Y (CY) gate to a pair of qubits.
+
+## Input
+### control
+Control qubit for the CY gate.
+### target
+Target qubit for the CY gate.
+
+## Remarks
+This operation can be simulated by the unitary matrix
+$$
+\begin{align}
+    1 & 0 & 0 & 0 \\\\
+    0 & 1 & 0 & 0 \\\\
+    0 & 0 & 0 & -i \\\\
+    0 & 0 & i & 0
+\end{align},
+$$
+where rows and columns are organized as in the quantum concepts guide.
+
+Equivalent to:
+```qsharp
+Controlled Y([control], target);
+```

package/docs/Microsoft.Quantum.Canon/CZ.md

@@ -0,0 +1,44 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.CZ
+title: CZ operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: CZ
+qsharp.summary: Applies the controlled-Z (CZ) gate to a pair of qubits.
+---
+
+# CZ operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation CZ(control : Qubit, target : Qubit) : Unit is Adj + Ctl
+```
+
+## Summary
+Applies the controlled-Z (CZ) gate to a pair of qubits.
+
+## Input
+### control
+Control qubit for the CZ gate.
+### target
+Target qubit for the CZ gate.
+
+## Remarks
+This operation can be simulated by the unitary matrix
+$$
+\begin{align}
+    1 & 0 & 0 & 0 \\\\
+    0 & 1 & 0 & 0 \\\\
+    0 & 0 & 1 & 0 \\\\
+    0 & 0 & 0 & -1
+\end{align},
+$$
+where rows and columns are organized as in the quantum concepts guide.
+
+Equivalent to:
+```qsharp
+Controlled Z([control], target);
+```

package/docs/Microsoft.Quantum.Canon/Fst.md

@@ -0,0 +1,20 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.Fst
+title: Fst function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: Fst
+qsharp.summary: Given a pair, returns its first element.
+---
+
+# Fst function
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+function Fst<'T, 'U>(pair : ('T, 'U)) : 'T
+```
+
+Given a pair, returns its first element.

package/docs/Microsoft.Quantum.Canon/Snd.md

@@ -0,0 +1,20 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.Snd
+title: Snd function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: Snd
+qsharp.summary: Given a pair, returns its second element.
+---
+
+# Snd function
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+function Snd<'T, 'U>(pair : ('T, 'U)) : 'U
+```
+
+Given a pair, returns its second element.

package/docs/Microsoft.Quantum.Canon/SwapReverseRegister.md

@@ -0,0 +1,25 @@
+---
+uid: Qdk.Microsoft.Quantum.Canon.SwapReverseRegister
+title: SwapReverseRegister operation
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: operation
+qsharp.namespace: Microsoft.Quantum.Canon
+qsharp.name: SwapReverseRegister
+qsharp.summary: Uses SWAP gates to reverse the order of the qubits in a register.
+---
+
+# SwapReverseRegister operation
+
+Namespace: Microsoft.Quantum.Canon
+
+```qsharp
+operation SwapReverseRegister(register : Qubit[]) : Unit is Adj + Ctl
+```
+
+## Summary
+Uses SWAP gates to reverse the order of the qubits in a register.
+
+## Input
+### register
+The qubits order of which should be reversed using SWAP gates

package/docs/Microsoft.Quantum.Convert/BigIntAsBoolArray.md

@@ -0,0 +1,35 @@
+---
+uid: Qdk.Microsoft.Quantum.Convert.BigIntAsBoolArray
+title: BigIntAsBoolArray function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: BigIntAsBoolArray
+qsharp.summary: Produces a binary representation of a non-negative BigInt, using the little-endian representation for the returned array.
+---
+
+# BigIntAsBoolArray function
+
+Namespace: Microsoft.Quantum.Convert
+
+```qsharp
+function BigIntAsBoolArray(number : BigInt, bits : Int) : Bool[]
+```
+
+## Summary
+Produces a binary representation of a non-negative BigInt, using the
+little-endian representation for the returned array.
+
+## Input
+### number
+A non-negative BigInt to be converted to an array of Boolean values.
+### bits
+The number of bits in the binary representation of `number`.
+
+## Output
+An array of Boolean values representing `number`.
+
+## Remarks
+The input `bits` must be non-negative.
+The input `number` must be between 0 and 2^bits - 1.

package/docs/Microsoft.Quantum.Convert/BoolArrayAsBigInt.md

@@ -0,0 +1,34 @@
+---
+uid: Qdk.Microsoft.Quantum.Convert.BoolArrayAsBigInt
+title: BoolArrayAsBigInt function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: BoolArrayAsBigInt
+qsharp.summary: Converts an array of Boolean values into a non-negative BigInt, interpreting the array as a binary representation in little-endian format.
+---
+
+# BoolArrayAsBigInt function
+
+Namespace: Microsoft.Quantum.Convert
+
+```qsharp
+function BoolArrayAsBigInt(boolArray : Bool[]) : BigInt
+```
+
+## Summary
+Converts an array of Boolean values into a non-negative BigInt, interpreting the
+array as a binary representation in little-endian format.
+
+## Input
+### boolArray
+An array of Boolean values representing the binary digits of a BigInt.
+
+## Output
+A BigInt represented by `boolArray`.
+
+## Remarks
+The function interprets the array in little-endian format, where the first
+element of the array represents the least significant bit.
+The input `boolArray` should not be empty.

package/docs/Microsoft.Quantum.Convert/BoolArrayAsInt.md

@@ -0,0 +1,25 @@
+---
+uid: Qdk.Microsoft.Quantum.Convert.BoolArrayAsInt
+title: BoolArrayAsInt function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: BoolArrayAsInt
+qsharp.summary: Produces a non-negative integer from a string of bits in little endian format.
+---
+
+# BoolArrayAsInt function
+
+Namespace: Microsoft.Quantum.Convert
+
+```qsharp
+function BoolArrayAsInt(bits : Bool[]) : Int
+```
+
+## Summary
+Produces a non-negative integer from a string of bits in little endian format.
+
+## Input
+### bits
+Bits in binary representation of number.

package/docs/Microsoft.Quantum.Convert/BoolArrayAsResultArray.md

@@ -0,0 +1,29 @@
+---
+uid: Qdk.Microsoft.Quantum.Convert.BoolArrayAsResultArray
+title: BoolArrayAsResultArray function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: BoolArrayAsResultArray
+qsharp.summary: Converts a `Bool[]` type to a `Result[]` type, where `true` is mapped to `One` and `false` is mapped to `Zero`.
+---
+
+# BoolArrayAsResultArray function
+
+Namespace: Microsoft.Quantum.Convert
+
+```qsharp
+function BoolArrayAsResultArray(input : Bool[]) : Result[]
+```
+
+## Summary
+Converts a `Bool[]` type to a `Result[]` type, where `true`
+is mapped to `One` and `false` is mapped to `Zero`.
+
+## Input
+### input
+`Bool[]` to be converted.
+
+## Output
+A `Result[]` representing the `input`.

package/docs/Microsoft.Quantum.Convert/BoolAsResult.md

@@ -0,0 +1,29 @@
+---
+uid: Qdk.Microsoft.Quantum.Convert.BoolAsResult
+title: BoolAsResult function
+ms.date: 02/23/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: BoolAsResult
+qsharp.summary: Converts a `Bool` type to a `Result` type, where `true` is mapped to `One` and `false` is mapped to `Zero`.
+---
+
+# BoolAsResult function
+
+Namespace: Microsoft.Quantum.Convert
+
+```qsharp
+function BoolAsResult(input : Bool) : Result
+```
+
+## Summary
+Converts a `Bool` type to a `Result` type, where `true` is mapped to
+`One` and `false` is mapped to `Zero`.
+
+## Input
+### input
+`Bool` to be converted.
+
+## Output
+A `Result` representing the `input`.