qsharp-lang 1.1.2-dev → 1.1.4-dev

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

@@ -0,0 +1,36 @@
+---
+uid: Microsoft.Quantum.Convert.BigIntAsBoolArray
+title: BigIntAsBoolArray function
+ms.date: 02/16/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](xref: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,35 @@
+---
+uid: Microsoft.Quantum.Convert.BoolArrayAsBigInt
+title: BoolArrayAsBigInt function
+ms.date: 02/16/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](xref: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: Microsoft.Quantum.Convert.BoolArrayAsInt
+title: BoolArrayAsInt function
+ms.date: 02/16/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](xref: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,30 @@
+---
+uid: Microsoft.Quantum.Convert.BoolArrayAsResultArray
+title: BoolArrayAsResultArray function
+ms.date: 02/16/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](xref: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,30 @@
+---
+uid: Microsoft.Quantum.Convert.BoolAsResult
+title: BoolAsResult function
+ms.date: 02/16/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](xref: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`.

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

@@ -0,0 +1,30 @@
+---
+uid: Microsoft.Quantum.Convert.ComplexAsComplexPolar
+title: ComplexAsComplexPolar function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: ComplexAsComplexPolar
+qsharp.summary: Converts a complex number of type `Complex` to a complex
+number of type `ComplexPolar`.
+---
+
+# ComplexAsComplexPolar function
+
+Namespace: [Microsoft.Quantum.Convert](xref:Microsoft.Quantum.Convert)
+
+```qsharp
+function ComplexAsComplexPolar(input : Complex) : ComplexPolar
+```
+
+## Summary
+Converts a complex number of type `Complex` to a complex
+number of type `ComplexPolar`.
+
+## Input
+### input
+Complex number c = x + y𝑖.
+
+## Output
+Complex number c = r⋅e^(t𝑖).

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

@@ -0,0 +1,30 @@
+---
+uid: Microsoft.Quantum.Convert.ComplexPolarAsComplex
+title: ComplexPolarAsComplex function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: ComplexPolarAsComplex
+qsharp.summary: Converts a complex number of type `ComplexPolar` to a complex
+number of type `Complex`.
+---
+
+# ComplexPolarAsComplex function
+
+Namespace: [Microsoft.Quantum.Convert](xref:Microsoft.Quantum.Convert)
+
+```qsharp
+function ComplexPolarAsComplex(input : ComplexPolar) : Complex
+```
+
+## Summary
+Converts a complex number of type `ComplexPolar` to a complex
+number of type `Complex`.
+
+## Input
+### input
+Complex number c = r⋅e^(t𝑖).
+
+## Output
+Complex number c = x + y𝑖.

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

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Convert.IntAsBigInt
+title: IntAsBigInt function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: IntAsBigInt
+qsharp.summary: Converts a given integer to an equivalent big integer.
+---
+
+# IntAsBigInt function
+
+Namespace: [Microsoft.Quantum.Convert](xref:Microsoft.Quantum.Convert)
+
+```qsharp
+function IntAsBigInt(number : Int) : BigInt
+```
+
+## Summary
+Converts a given integer to an equivalent big integer.

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

@@ -0,0 +1,36 @@
+---
+uid: Microsoft.Quantum.Convert.IntAsBoolArray
+title: IntAsBoolArray function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: IntAsBoolArray
+qsharp.summary: Produces a binary representation of a non-negative integer, using the
+little-endian representation for the returned array.
+---
+
+# IntAsBoolArray function
+
+Namespace: [Microsoft.Quantum.Convert](xref:Microsoft.Quantum.Convert)
+
+```qsharp
+function IntAsBoolArray(number : Int, bits : Int) : Bool[]
+```
+
+## Summary
+Produces a binary representation of a non-negative integer, using the
+little-endian representation for the returned array.
+
+## Input
+### number
+A non-negative integer 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/IntAsDouble.md

@@ -0,0 +1,21 @@
+---
+uid: Microsoft.Quantum.Convert.IntAsDouble
+title: IntAsDouble function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: IntAsDouble
+qsharp.summary: Converts a given integer to an equivalent double-precision floating-point number.
+---
+
+# IntAsDouble function
+
+Namespace: [Microsoft.Quantum.Convert](xref:Microsoft.Quantum.Convert)
+
+```qsharp
+function IntAsDouble(number : Int) : Double
+```
+
+## Summary
+Converts a given integer to an equivalent double-precision floating-point number.

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

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

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

@@ -0,0 +1,34 @@
+---
+uid: Microsoft.Quantum.Convert.ResultArrayAsInt
+title: ResultArrayAsInt function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Convert
+qsharp.name: ResultArrayAsInt
+qsharp.summary: Produces a non-negative integer from a string of Results in little-endian format.
+---
+
+# ResultArrayAsInt function
+
+Namespace: [Microsoft.Quantum.Convert](xref:Microsoft.Quantum.Convert)
+
+```qsharp
+function ResultArrayAsInt(results : Result[]) : Int
+```
+
+## Summary
+Produces a non-negative integer from a string of Results in little-endian format.
+
+## Input
+### results
+Results in binary representation of number.
+
+## Output
+A non-negative integer
+
+## Example
+```qsharp
+// The following returns 1
+let int1 = ResultArrayAsInt([One,Zero])
+```

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

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

package/docs/Microsoft.Quantum.Core/IsRangeEmpty.md

@@ -0,0 +1,32 @@
+---
+uid: Microsoft.Quantum.Core.IsRangeEmpty
+title: IsRangeEmpty function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Core
+qsharp.name: IsRangeEmpty
+qsharp.summary: Returns true if and only if the input range is empty.
+---
+
+# IsRangeEmpty function
+
+Namespace: [Microsoft.Quantum.Core](xref:Microsoft.Quantum.Core)
+
+```qsharp
+function IsRangeEmpty(rng : Range) : Bool
+```
+
+## Summary
+Returns true if and only if the input range is empty.
+
+## Input
+### rng
+Any range
+
+## Output
+True, if and only if `rng` is empty
+
+## Remark
+This function needs to check at most one range index
+to determine whether the range is empty.

package/docs/Microsoft.Quantum.Core/Length.md

@@ -0,0 +1,28 @@
+---
+uid: Microsoft.Quantum.Core.Length
+title: Length function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Core
+qsharp.name: Length
+qsharp.summary: Returns the number of elements in an array.
+---
+
+# Length function
+
+Namespace: [Microsoft.Quantum.Core](xref:Microsoft.Quantum.Core)
+
+```qsharp
+function Length<'T>(a : 'T[]) : Int
+```
+
+## Summary
+Returns the number of elements in an array.
+
+## Input
+### a
+Input array.
+
+## Output
+The total count of elements in an array.

package/docs/Microsoft.Quantum.Core/RangeEnd.md

@@ -0,0 +1,38 @@
+---
+uid: Microsoft.Quantum.Core.RangeEnd
+title: RangeEnd function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Core
+qsharp.name: RangeEnd
+qsharp.summary: Returns the defined end value of the given range,
+which is not necessarily the last element in the sequence.
+---
+
+# RangeEnd function
+
+Namespace: [Microsoft.Quantum.Core](xref:Microsoft.Quantum.Core)
+
+```qsharp
+function RangeEnd(r : Range) : Int
+```
+
+## Summary
+Returns the defined end value of the given range,
+which is not necessarily the last element in the sequence.
+
+## Input
+### r
+Input range.
+
+## Output
+The defined end value of the given range.
+
+## Remarks
+A range expression's first element is `start`,
+its second element is `start+step`, third element is `start+step+step`, etc.,
+until `end` is passed.
+
+Note that the defined end value of a range can differ from the last element in the sequence specified by the range;
+for example, in a range 0 .. 2 .. 5 the last element is 4 but the end value is 5.

package/docs/Microsoft.Quantum.Core/RangeReverse.md

@@ -0,0 +1,32 @@
+---
+uid: Microsoft.Quantum.Core.RangeReverse
+title: RangeReverse function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Core
+qsharp.name: RangeReverse
+qsharp.summary: Returns a new range which is the reverse of the input range.
+---
+
+# RangeReverse function
+
+Namespace: [Microsoft.Quantum.Core](xref:Microsoft.Quantum.Core)
+
+```qsharp
+function RangeReverse(r : Range) : Range
+```
+
+## Summary
+Returns a new range which is the reverse of the input range.
+
+## Input
+### r
+Input range.
+
+## Output
+A new range that is the reverse of the given range.
+
+## Remarks
+Note that the reverse of a range is not simply `end`..`-step`..`start`, because
+the actual last element of a range may not be the same as `end`.

package/docs/Microsoft.Quantum.Core/RangeStart.md

@@ -0,0 +1,36 @@
+---
+uid: Microsoft.Quantum.Core.RangeStart
+title: RangeStart function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Core
+qsharp.name: RangeStart
+qsharp.summary: Returns the defined start value of the given range.
+---
+
+# RangeStart function
+
+Namespace: [Microsoft.Quantum.Core](xref:Microsoft.Quantum.Core)
+
+```qsharp
+function RangeStart(r : Range) : Int
+```
+
+## Summary
+Returns the defined start value of the given range.
+
+## Input
+### r
+Input range.
+
+## Output
+The defined start value of the given range.
+
+## Remarks
+A range expression's first element is `start`,
+its second element is `start+step`, third element is `start+step+step`, etc.,
+until `end` is passed.
+
+Note that the defined start value of a range is the same as the first element of the sequence,
+unless the range specifies an empty sequence (for example, 2 .. 1).

package/docs/Microsoft.Quantum.Core/RangeStep.md

@@ -0,0 +1,33 @@
+---
+uid: Microsoft.Quantum.Core.RangeStep
+title: RangeStep function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Core
+qsharp.name: RangeStep
+qsharp.summary: Returns the integer that specifies how the next value of a range is calculated.
+---
+
+# RangeStep function
+
+Namespace: [Microsoft.Quantum.Core](xref:Microsoft.Quantum.Core)
+
+```qsharp
+function RangeStep(r : Range) : Int
+```
+
+## Summary
+Returns the integer that specifies how the next value of a range is calculated.
+
+## Input
+### r
+Input range.
+
+## Output
+The defined step value of the given range.
+
+## Remarks
+A range expression's first element is `start`,
+its second element is `start+step`, third element is `start+step+step`, etc.,
+until `end` is passed.

package/docs/Microsoft.Quantum.Core/Repeated.md

@@ -0,0 +1,36 @@
+---
+uid: Microsoft.Quantum.Core.Repeated
+title: Repeated function
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: function
+qsharp.namespace: Microsoft.Quantum.Core
+qsharp.name: Repeated
+qsharp.summary: Creates an array of given length with all elements equal to given value.
+---
+
+# Repeated function
+
+Namespace: [Microsoft.Quantum.Core](xref:Microsoft.Quantum.Core)
+
+```qsharp
+function Repeated<'T>(value : 'T, length : Int) : 'T[]
+```
+
+## Summary
+Creates an array of given length with all elements equal to given value.
+
+## Input
+### value
+The value of each element of the new array.
+### length
+Length of the new array.
+
+## Output
+A new array of length `length`, such that every element is `value`.
+
+## Example
+The following code creates an array of 3 Boolean values, each equal to `true`:
+```qsharp
+let array = Repeated(true, 3);
+```

package/docs/Microsoft.Quantum.Diagnostics/CheckAllZero.md

@@ -0,0 +1,18 @@
+---
+uid: Microsoft.Quantum.Diagnostics.CheckAllZero
+title: CheckAllZero operation
+ms.date: 02/16/2024 12:00:00 AM
+ms.topic: managed-reference
+qsharp.kind: opeartion
+qsharp.namespace: Microsoft.Quantum.Diagnostics
+qsharp.name: CheckAllZero
+qsharp.summary: 
+---
+
+# CheckAllZero operation
+
+Namespace: [Microsoft.Quantum.Diagnostics](xref:Microsoft.Quantum.Diagnostics)
+
+```qsharp
+operation CheckAllZero(qubits : Qubit[]) : Bool
+```