qsharp-lang 1.10.2-dev → 1.10.3-dev
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/katas-content.generated.js +3 -3
- package/dist/katas-content.generated.md.js +3 -3
- package/dist/samples.generated.js +23 -18
- package/docs/Microsoft.Quantum.Core/Length.md +4 -5
- package/docs/Microsoft.Quantum.Core/Repeated.md +4 -5
- package/docs/Microsoft.Quantum.Core/index.md +18 -0
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/AddLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfEqualL.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfEqualLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfGreaterL.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfGreaterLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfGreaterOrEqualL.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfGreaterOrEqualLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfLessL.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfLessLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfLessOrEqualL.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ApplyIfLessOrEqualLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/FourierTDIncByLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/IncByI.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/IncByIUsingIncByLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/IncByL.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/IncByLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/IncByLEUsingAddLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/IncByLUsingIncByLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/LookAheadDKRSAddLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/MAJ.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/ReflectAboutInteger.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/RippleCarryCGAddLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/RippleCarryCGIncByLE.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.Arithmetic → Std.Arithmetic}/RippleCarryTTKIncByLE.md +5 -4
- package/docs/Std.Arithmetic/index.md +40 -0
- package/docs/Std.Arrays/All.md +2 -1
- package/docs/Std.Arrays/Any.md +2 -1
- package/docs/Std.Arrays/Chunks.md +2 -1
- package/docs/Std.Arrays/CircularlyShifted.md +2 -1
- package/docs/Std.Arrays/ColumnAt.md +2 -1
- package/docs/Std.Arrays/Count.md +2 -1
- package/docs/Std.Arrays/Diagonal.md +2 -1
- package/docs/Std.Arrays/DrawMany.md +2 -1
- package/docs/Std.Arrays/Enumerated.md +2 -1
- package/docs/Std.Arrays/Excluding.md +2 -1
- package/docs/Std.Arrays/Filtered.md +2 -1
- package/docs/Std.Arrays/FlatMapped.md +2 -1
- package/docs/Std.Arrays/Flattened.md +2 -1
- package/docs/Std.Arrays/Fold.md +2 -1
- package/docs/Std.Arrays/ForEach.md +2 -1
- package/docs/Std.Arrays/Head.md +2 -1
- package/docs/Std.Arrays/HeadAndRest.md +2 -1
- package/docs/Std.Arrays/IndexOf.md +2 -1
- package/docs/Std.Arrays/IndexRange.md +2 -1
- package/docs/Std.Arrays/Interleaved.md +2 -1
- package/docs/Std.Arrays/IsEmpty.md +2 -1
- package/docs/Std.Arrays/IsRectangularArray.md +2 -1
- package/docs/Std.Arrays/IsSorted.md +2 -1
- package/docs/Std.Arrays/IsSquareArray.md +2 -1
- package/docs/Std.Arrays/Mapped.md +2 -1
- package/docs/Std.Arrays/MappedByIndex.md +2 -1
- package/docs/Std.Arrays/MappedOverRange.md +2 -1
- package/docs/Std.Arrays/Most.md +2 -1
- package/docs/Std.Arrays/MostAndTail.md +2 -1
- package/docs/Std.Arrays/Padded.md +2 -1
- package/docs/Std.Arrays/Partitioned.md +2 -1
- package/docs/Std.Arrays/Rest.md +2 -1
- package/docs/Std.Arrays/Reversed.md +2 -1
- package/docs/Std.Arrays/SequenceI.md +2 -1
- package/docs/Std.Arrays/SequenceL.md +2 -1
- package/docs/Std.Arrays/Sorted.md +2 -1
- package/docs/Std.Arrays/Subarray.md +2 -1
- package/docs/Std.Arrays/Swapped.md +2 -1
- package/docs/Std.Arrays/Tail.md +2 -1
- package/docs/Std.Arrays/Transposed.md +2 -1
- package/docs/Std.Arrays/Unzipped.md +2 -1
- package/docs/Std.Arrays/Where.md +2 -1
- package/docs/Std.Arrays/Windows.md +2 -1
- package/docs/Std.Arrays/Zipped.md +2 -1
- package/docs/Std.Arrays/index.md +60 -0
- package/docs/Std.Canon/ApplyCNOTChain.md +2 -1
- package/docs/Std.Canon/ApplyControlledOnBitString.md +2 -1
- package/docs/Std.Canon/ApplyControlledOnInt.md +2 -1
- package/docs/Std.Canon/ApplyP.md +2 -1
- package/docs/Std.Canon/ApplyPauli.md +2 -1
- package/docs/Std.Canon/ApplyPauliFromBitString.md +2 -1
- package/docs/Std.Canon/ApplyPauliFromInt.md +2 -1
- package/docs/Std.Canon/ApplyQFT.md +2 -1
- package/docs/Std.Canon/ApplyToEach.md +2 -1
- package/docs/Std.Canon/ApplyToEachA.md +2 -1
- package/docs/Std.Canon/ApplyToEachC.md +2 -1
- package/docs/Std.Canon/ApplyToEachCA.md +2 -1
- package/docs/Std.Canon/ApplyXorInPlace.md +2 -1
- package/docs/Std.Canon/ApplyXorInPlaceL.md +2 -1
- package/docs/Std.Canon/CX.md +2 -1
- package/docs/Std.Canon/CY.md +2 -1
- package/docs/Std.Canon/CZ.md +2 -1
- package/docs/Std.Canon/Fst.md +2 -1
- package/docs/Std.Canon/Relabel.md +2 -1
- package/docs/Std.Canon/Snd.md +2 -1
- package/docs/Std.Canon/SwapReverseRegister.md +2 -1
- package/docs/Std.Canon/index.md +37 -0
- package/docs/Std.Convert/BigIntAsBoolArray.md +2 -1
- package/docs/Std.Convert/BoolArrayAsBigInt.md +2 -1
- package/docs/Std.Convert/BoolArrayAsInt.md +2 -1
- package/docs/Std.Convert/BoolArrayAsResultArray.md +2 -1
- package/docs/Std.Convert/BoolAsResult.md +2 -1
- package/docs/Std.Convert/ComplexAsComplexPolar.md +2 -1
- package/docs/Std.Convert/ComplexPolarAsComplex.md +2 -1
- package/docs/Std.Convert/DoubleAsStringWithPrecision.md +2 -1
- package/docs/Std.Convert/IntAsBigInt.md +2 -1
- package/docs/Std.Convert/IntAsBoolArray.md +2 -1
- package/docs/Std.Convert/IntAsDouble.md +2 -1
- package/docs/Std.Convert/ResultArrayAsBoolArray.md +2 -1
- package/docs/Std.Convert/ResultArrayAsInt.md +2 -1
- package/docs/Std.Convert/ResultAsBool.md +2 -1
- package/docs/Std.Convert/index.md +30 -0
- package/docs/Std.Core/Length.md +2 -1
- package/docs/Std.Core/Repeated.md +2 -1
- package/docs/Std.Core/index.md +18 -0
- package/docs/Std.Diagnostics/ApplyIdleNoise.md +34 -0
- package/docs/Std.Diagnostics/BitFlipNoise.md +23 -0
- package/docs/Std.Diagnostics/CheckAllZero.md +38 -0
- package/docs/Std.Diagnostics/CheckOperationsAreEqual.md +49 -0
- package/docs/Std.Diagnostics/CheckZero.md +38 -0
- package/docs/Std.Diagnostics/ConfigurePauliNoise.md +38 -0
- package/docs/Std.Diagnostics/DepolarizingNoise.md +23 -0
- package/docs/Std.Diagnostics/DumpMachine.md +2 -1
- package/docs/Std.Diagnostics/DumpOperation.md +3 -2
- package/docs/Std.Diagnostics/DumpRegister.md +2 -1
- package/docs/Std.Diagnostics/Fact.md +2 -1
- package/docs/Std.Diagnostics/NoNoise.md +23 -0
- package/docs/Std.Diagnostics/PhaseFlipNoise.md +23 -0
- package/docs/Std.Diagnostics/StartCountingFunction.md +44 -0
- package/docs/Std.Diagnostics/StartCountingOperation.md +53 -0
- package/docs/Std.Diagnostics/StartCountingQubits.md +39 -0
- package/docs/Std.Diagnostics/StopCountingFunction.md +34 -0
- package/docs/Std.Diagnostics/StopCountingOperation.md +34 -0
- package/docs/Std.Diagnostics/StopCountingQubits.md +30 -0
- package/docs/Std.Diagnostics/index.md +35 -0
- package/docs/Std.Intrinsic/AND.md +3 -2
- package/docs/Std.Intrinsic/CCNOT.md +2 -1
- package/docs/Std.Intrinsic/CNOT.md +2 -1
- package/docs/Std.Intrinsic/Exp.md +2 -1
- package/docs/Std.Intrinsic/H.md +2 -1
- package/docs/Std.Intrinsic/I.md +2 -1
- package/docs/Std.Intrinsic/M.md +2 -1
- package/docs/Std.Intrinsic/Measure.md +2 -1
- package/docs/Std.Intrinsic/Message.md +2 -1
- package/docs/Std.Intrinsic/R.md +2 -1
- package/docs/Std.Intrinsic/R1.md +3 -2
- package/docs/Std.Intrinsic/R1Frac.md +3 -2
- package/docs/Std.Intrinsic/RFrac.md +2 -1
- package/docs/Std.Intrinsic/Reset.md +3 -2
- package/docs/Std.Intrinsic/ResetAll.md +3 -2
- package/docs/Std.Intrinsic/Rx.md +2 -1
- package/docs/Std.Intrinsic/Rxx.md +2 -1
- package/docs/Std.Intrinsic/Ry.md +2 -1
- package/docs/Std.Intrinsic/Ryy.md +2 -1
- package/docs/Std.Intrinsic/Rz.md +2 -1
- package/docs/Std.Intrinsic/Rzz.md +2 -1
- package/docs/Std.Intrinsic/S.md +2 -1
- package/docs/Std.Intrinsic/SWAP.md +2 -1
- package/docs/Std.Intrinsic/T.md +2 -1
- package/docs/Std.Intrinsic/X.md +2 -1
- package/docs/Std.Intrinsic/Y.md +2 -1
- package/docs/Std.Intrinsic/Z.md +2 -1
- package/docs/Std.Intrinsic/index.md +43 -0
- package/docs/Std.Logical/Xor.md +2 -1
- package/docs/Std.Logical/index.md +17 -0
- package/docs/Std.Math/AbsComplex.md +2 -1
- package/docs/Std.Math/AbsComplexPolar.md +2 -1
- package/docs/Std.Math/AbsD.md +2 -1
- package/docs/Std.Math/AbsI.md +2 -1
- package/docs/Std.Math/AbsL.md +6 -2
- package/docs/Std.Math/AbsSquaredComplex.md +2 -1
- package/docs/Std.Math/AbsSquaredComplexPolar.md +2 -1
- package/docs/Std.Math/ApproximateFactorial.md +2 -1
- package/docs/Std.Math/ArcCos.md +2 -1
- package/docs/Std.Math/ArcCosh.md +2 -1
- package/docs/Std.Math/ArcSin.md +2 -1
- package/docs/Std.Math/ArcSinh.md +2 -1
- package/docs/Std.Math/ArcTan.md +2 -1
- package/docs/Std.Math/ArcTan2.md +2 -1
- package/docs/Std.Math/ArcTanh.md +2 -1
- package/docs/Std.Math/ArgComplex.md +2 -1
- package/docs/Std.Math/ArgComplexPolar.md +2 -1
- package/docs/Std.Math/Binom.md +2 -1
- package/docs/Std.Math/BitSizeI.md +2 -1
- package/docs/Std.Math/BitSizeL.md +2 -1
- package/docs/Std.Math/Ceiling.md +2 -1
- package/docs/Std.Math/Complex.md +2 -1
- package/docs/Std.Math/ComplexPolar.md +2 -1
- package/docs/Std.Math/ContinuedFractionConvergentI.md +2 -1
- package/docs/Std.Math/ContinuedFractionConvergentL.md +2 -1
- package/docs/Std.Math/Cos.md +2 -1
- package/docs/Std.Math/Cosh.md +2 -1
- package/docs/Std.Math/DivRemI.md +2 -1
- package/docs/Std.Math/DivRemL.md +2 -1
- package/docs/Std.Math/DividedByC.md +2 -1
- package/docs/Std.Math/DividedByCP.md +2 -1
- package/docs/Std.Math/E.md +2 -1
- package/docs/Std.Math/ExpModI.md +2 -1
- package/docs/Std.Math/ExpModL.md +2 -1
- package/docs/Std.Math/ExtendedGreatestCommonDivisorI.md +2 -1
- package/docs/Std.Math/ExtendedGreatestCommonDivisorL.md +2 -1
- package/docs/Std.Math/FactorialI.md +2 -1
- package/docs/Std.Math/FactorialL.md +2 -1
- package/docs/Std.Math/Floor.md +2 -1
- package/docs/Std.Math/GreatestCommonDivisorI.md +2 -1
- package/docs/Std.Math/GreatestCommonDivisorL.md +2 -1
- package/docs/Std.Math/HammingWeightI.md +2 -1
- package/docs/Std.Math/InverseModI.md +2 -1
- package/docs/Std.Math/InverseModL.md +2 -1
- package/docs/Std.Math/IsCoprimeI.md +2 -1
- package/docs/Std.Math/IsCoprimeL.md +2 -1
- package/docs/Std.Math/IsInfinite.md +2 -1
- package/docs/Std.Math/IsNaN.md +2 -1
- package/docs/Std.Math/LargestFixedPoint.md +2 -1
- package/docs/Std.Math/Lg.md +2 -1
- package/docs/Std.Math/Log.md +2 -1
- package/docs/Std.Math/Log10.md +2 -1
- package/docs/Std.Math/LogFactorialD.md +2 -1
- package/docs/Std.Math/LogGammaD.md +2 -1
- package/docs/Std.Math/LogOf2.md +2 -1
- package/docs/Std.Math/Max.md +2 -1
- package/docs/Std.Math/MaxD.md +2 -1
- package/docs/Std.Math/MaxI.md +2 -1
- package/docs/Std.Math/MaxL.md +2 -1
- package/docs/Std.Math/Min.md +2 -1
- package/docs/Std.Math/MinD.md +2 -1
- package/docs/Std.Math/MinI.md +2 -1
- package/docs/Std.Math/MinL.md +2 -1
- package/docs/Std.Math/MinusC.md +2 -1
- package/docs/Std.Math/MinusCP.md +2 -1
- package/docs/Std.Math/ModulusI.md +2 -1
- package/docs/Std.Math/ModulusL.md +2 -1
- package/docs/Std.Math/NegationC.md +2 -1
- package/docs/Std.Math/NegationCP.md +2 -1
- package/docs/Std.Math/PI.md +2 -1
- package/docs/Std.Math/PNorm.md +3 -2
- package/docs/Std.Math/PNormalized.md +3 -2
- package/docs/Std.Math/PlusC.md +2 -1
- package/docs/Std.Math/PlusCP.md +2 -1
- package/docs/Std.Math/PowC.md +2 -1
- package/docs/Std.Math/PowCP.md +2 -1
- package/docs/Std.Math/RealMod.md +2 -1
- package/docs/Std.Math/Round.md +2 -1
- package/docs/Std.Math/SignD.md +2 -1
- package/docs/Std.Math/SignI.md +2 -1
- package/docs/Std.Math/SignL.md +2 -1
- package/docs/Std.Math/Sin.md +2 -1
- package/docs/Std.Math/Sinh.md +2 -1
- package/docs/Std.Math/SmallestFixedPoint.md +2 -1
- package/docs/Std.Math/Sqrt.md +2 -1
- package/docs/Std.Math/SquaredNorm.md +2 -1
- package/docs/Std.Math/Tan.md +2 -1
- package/docs/Std.Math/Tanh.md +2 -1
- package/docs/Std.Math/TimesC.md +2 -1
- package/docs/Std.Math/TimesCP.md +2 -1
- package/docs/Std.Math/TrailingZeroCountI.md +2 -1
- package/docs/Std.Math/TrailingZeroCountL.md +2 -1
- package/docs/Std.Math/Truncate.md +2 -1
- package/docs/Std.Math/index.md +109 -0
- package/docs/Std.Measurement/MResetEachZ.md +2 -1
- package/docs/Std.Measurement/MResetX.md +2 -1
- package/docs/Std.Measurement/MResetY.md +2 -1
- package/docs/Std.Measurement/MResetZ.md +2 -1
- package/docs/Std.Measurement/MeasureAllZ.md +2 -1
- package/docs/Std.Measurement/MeasureEachZ.md +2 -1
- package/docs/Std.Measurement/MeasureInteger.md +2 -1
- package/docs/Std.Measurement/index.md +23 -0
- package/docs/Std.Random/DrawRandomBool.md +38 -0
- package/docs/Std.Random/DrawRandomDouble.md +40 -0
- package/docs/Std.Random/DrawRandomInt.md +40 -0
- package/docs/Std.Random/index.md +19 -0
- package/docs/Std.Range/IsRangeEmpty.md +2 -1
- package/docs/Std.Range/RangeEnd.md +2 -1
- package/docs/Std.Range/RangeReverse.md +2 -1
- package/docs/Std.Range/RangeStart.md +2 -1
- package/docs/Std.Range/RangeStep.md +2 -1
- package/docs/Std.Range/index.md +21 -0
- package/docs/Std.ResourceEstimation/AccountForEstimates.md +2 -1
- package/docs/Std.ResourceEstimation/AuxQubitCount.md +2 -1
- package/docs/Std.ResourceEstimation/BeginEstimateCaching.md +2 -1
- package/docs/Std.ResourceEstimation/BeginRepeatEstimates.md +2 -1
- package/docs/Std.ResourceEstimation/CczCount.md +2 -1
- package/docs/Std.ResourceEstimation/EndEstimateCaching.md +2 -1
- package/docs/Std.ResourceEstimation/EndRepeatEstimates.md +2 -1
- package/docs/Std.ResourceEstimation/MeasurementCount.md +2 -1
- package/docs/Std.ResourceEstimation/PSSPCLayout.md +2 -1
- package/docs/Std.ResourceEstimation/RepeatEstimates.md +2 -1
- package/docs/Std.ResourceEstimation/RotationCount.md +2 -1
- package/docs/Std.ResourceEstimation/RotationDepth.md +2 -1
- package/docs/Std.ResourceEstimation/SingleVariant.md +2 -1
- package/docs/Std.ResourceEstimation/TCount.md +2 -1
- package/docs/Std.ResourceEstimation/index.md +30 -0
- package/docs/{Microsoft.Quantum.Unstable.StatePreparation → Std.StatePreparation}/ApproximatelyPreparePureStateCP.md +5 -4
- package/docs/{Microsoft.Quantum.Unstable.StatePreparation → Std.StatePreparation}/PreparePureStateD.md +6 -5
- package/docs/Std.StatePreparation/index.md +18 -0
- package/docs/{Microsoft.Quantum.Unstable.TableLookup → Std.TableLookup}/Select.md +5 -4
- package/docs/Std.TableLookup/index.md +17 -0
- package/docs/index.md +32 -0
- package/docs/toc.yml +76 -38
- package/lib/node/qsc_wasm.cjs +1 -1
- package/lib/node/qsc_wasm.d.cts +1 -1
- package/lib/node/qsc_wasm_bg.wasm +0 -0
- package/lib/web/qsc_wasm.d.ts +1 -1
- package/lib/web/qsc_wasm.js +1 -1
- package/lib/web/qsc_wasm_bg.wasm +0 -0
- package/package.json +1 -1
package/docs/Std.Math/Sinh.md
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.Sinh
|
|
3
3
|
title: Sinh function
|
|
4
|
-
|
|
4
|
+
description: "Q# Sinh function: Returns the hyperbolic sine of the specified angle."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.SmallestFixedPoint
|
|
3
3
|
title: SmallestFixedPoint function
|
|
4
|
-
|
|
4
|
+
description: "Q# SmallestFixedPoint function: Returns the smallest representable number for specific fixed point dimensions."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
package/docs/Std.Math/Sqrt.md
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.Sqrt
|
|
3
3
|
title: Sqrt function
|
|
4
|
-
|
|
4
|
+
description: "Q# Sqrt function: Returns the square root of a specified number."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.SquaredNorm
|
|
3
3
|
title: SquaredNorm function
|
|
4
|
-
|
|
4
|
+
description: "Q# SquaredNorm function: Returns the squared 2-norm of a vector."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
package/docs/Std.Math/Tan.md
CHANGED
package/docs/Std.Math/Tanh.md
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.Tanh
|
|
3
3
|
title: Tanh function
|
|
4
|
-
|
|
4
|
+
description: "Q# Tanh function: Returns the hyperbolic tangent of the specified angle."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
package/docs/Std.Math/TimesC.md
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.TimesC
|
|
3
3
|
title: TimesC function
|
|
4
|
-
|
|
4
|
+
description: "Q# TimesC function: Returns the product of two inputs of type `Complex`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
package/docs/Std.Math/TimesCP.md
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.TimesCP
|
|
3
3
|
title: TimesCP function
|
|
4
|
-
|
|
4
|
+
description: "Q# TimesCP function: Returns the product of two inputs of type `ComplexPolar`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.TrailingZeroCountI
|
|
3
3
|
title: TrailingZeroCountI function
|
|
4
|
-
|
|
4
|
+
description: "Q# TrailingZeroCountI function: For a non-zero integer `a`, returns the number of trailing zero bits in the binary representation of `a`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.TrailingZeroCountL
|
|
3
3
|
title: TrailingZeroCountL function
|
|
4
|
-
|
|
4
|
+
description: "Q# TrailingZeroCountL function: For a non-zero integer `a`, returns the number of trailing zero bits in the binary representation of `a`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Math.Truncate
|
|
3
3
|
title: Truncate function
|
|
4
|
-
|
|
4
|
+
description: "Q# Truncate function: Returns the integral part of a number. For example: Truncate(3.7) = 3; Truncate(-3.7) = -3"
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
---
|
|
2
|
+
uid: Qdk.Std.Math-toc
|
|
3
|
+
title: Std.Math namespace
|
|
4
|
+
description: Table of contents for the Q# Math namespace
|
|
5
|
+
author: {AUTHOR}
|
|
6
|
+
ms.author: {MS_AUTHOR}
|
|
7
|
+
ms.date: 11/15/2024
|
|
8
|
+
ms.topic: landing-page
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Std.Math
|
|
12
|
+
|
|
13
|
+
The Std.Math namespace contains the following items:
|
|
14
|
+
|
|
15
|
+
| Name | Description |
|
|
16
|
+
|------|-------------|
|
|
17
|
+
| [AbsComplex](xref:Qdk.Std.Math.AbsComplex) | Returns the absolute value of a complex number of type `Complex`. |
|
|
18
|
+
| [AbsComplexPolar](xref:Qdk.Std.Math.AbsComplexPolar) | Returns the absolute value of a complex number of type `ComplexPolar`. |
|
|
19
|
+
| [AbsD](xref:Qdk.Std.Math.AbsD) | Returns the absolute value of a double-precision floating-point number. |
|
|
20
|
+
| [AbsI](xref:Qdk.Std.Math.AbsI) | Returns the absolute value of an integer. |
|
|
21
|
+
| [AbsL](xref:Qdk.Std.Math.AbsL) | Returns the absolute value of a big integer. |
|
|
22
|
+
| [AbsSquaredComplex](xref:Qdk.Std.Math.AbsSquaredComplex) | Returns the squared absolute value of a complex number of type `Complex`. |
|
|
23
|
+
| [AbsSquaredComplexPolar](xref:Qdk.Std.Math.AbsSquaredComplexPolar) | Returns the squared absolute value of a complex number of type `ComplexPolar`. |
|
|
24
|
+
| [ApproximateFactorial](xref:Qdk.Std.Math.ApproximateFactorial) | Returns an approximate factorial of a given number. |
|
|
25
|
+
| [ArcCos](xref:Qdk.Std.Math.ArcCos) | Returns the angle whose cosine is the specified number. |
|
|
26
|
+
| [ArcCosh](xref:Qdk.Std.Math.ArcCosh) | Computes the inverse hyperbolic cosine of a number. |
|
|
27
|
+
| [ArcSin](xref:Qdk.Std.Math.ArcSin) | Returns the angle whose sine is the specified number. |
|
|
28
|
+
| [ArcSinh](xref:Qdk.Std.Math.ArcSinh) | Computes the inverse hyperbolic sine of a number. |
|
|
29
|
+
| [ArcTan](xref:Qdk.Std.Math.ArcTan) | Returns the angle whose tangent is the specified number. |
|
|
30
|
+
| [ArcTan2](xref:Qdk.Std.Math.ArcTan2) | Returns the angle whose tangent is the quotient of two specified numbers. |
|
|
31
|
+
| [ArcTanh](xref:Qdk.Std.Math.ArcTanh) | Computes the inverse hyperbolic tangent of a number. |
|
|
32
|
+
| [ArgComplex](xref:Qdk.Std.Math.ArgComplex) | Returns the phase of a complex number of type `Complex`. |
|
|
33
|
+
| [ArgComplexPolar](xref:Qdk.Std.Math.ArgComplexPolar) | Returns the phase of a complex number of type `ComplexPolar`. |
|
|
34
|
+
| [Binom](xref:Qdk.Std.Math.Binom) | Returns the approximate binomial coefficient of two integers. |
|
|
35
|
+
| [BitSizeI](xref:Qdk.Std.Math.BitSizeI) | For a non-negative integer `a`, returns the number of bits required to represent `a`. NOTE: This function returns the smallest n such that a < 2^n. |
|
|
36
|
+
| [BitSizeL](xref:Qdk.Std.Math.BitSizeL) | For a non-negative integer `a`, returns the number of bits required to represent `a`. NOTE: This function returns the smallest n such that a < 2^n. |
|
|
37
|
+
| [Ceiling](xref:Qdk.Std.Math.Ceiling) | Returns the smallest integer greater than or equal to the specified number. For example: Ceiling(3.1) = 4; Ceiling(-3.7) = -3 |
|
|
38
|
+
| [Complex](xref:Qdk.Std.Math.Complex) | Represents a complex number by its real and imaginary components. The first element of the tuple is the real component, the second one - the imaginary component. |
|
|
39
|
+
| [ComplexPolar](xref:Qdk.Std.Math.ComplexPolar) | Represents a complex number in polar form. The polar representation of a complex number is c = r⋅𝑒^(t𝑖). |
|
|
40
|
+
| [ContinuedFractionConvergentI](xref:Qdk.Std.Math.ContinuedFractionConvergentI) | Finds the continued fraction convergent closest to `fraction` with the denominator less or equal to `denominatorBound` Using process similar to this: https://nrich.maths.org/1397 |
|
|
41
|
+
| [ContinuedFractionConvergentL](xref:Qdk.Std.Math.ContinuedFractionConvergentL) | Finds the continued fraction convergent closest to `fraction` with the denominator less or equal to `denominatorBound` Using process similar to this: https://nrich.maths.org/1397 |
|
|
42
|
+
| [Cos](xref:Qdk.Std.Math.Cos) | Returns the cosine of the specified angle. |
|
|
43
|
+
| [Cosh](xref:Qdk.Std.Math.Cosh) | Returns the hyperbolic cosine of the specified angle. |
|
|
44
|
+
| [DivRemI](xref:Qdk.Std.Math.DivRemI) | Divides one Integer value by another, returns the result and the remainder as a tuple. |
|
|
45
|
+
| [DivRemL](xref:Qdk.Std.Math.DivRemL) | Divides one BigInteger value by another, returns the result and the remainder as a tuple. |
|
|
46
|
+
| [DividedByC](xref:Qdk.Std.Math.DividedByC) | Returns the quotient of two inputs of type `Complex`. |
|
|
47
|
+
| [DividedByCP](xref:Qdk.Std.Math.DividedByCP) | Returns the quotient of two inputs of type `ComplexPolar`. |
|
|
48
|
+
| [E](xref:Qdk.Std.Math.E) | Returns a double-precision approximation of the mathematical constant 𝒆 ≈ 2.7182818284590452354 |
|
|
49
|
+
| [ExpModI](xref:Qdk.Std.Math.ExpModI) | Returns an integer raised to a given power, with respect to a given modulus. I.e. (expBase^power) % modulus. |
|
|
50
|
+
| [ExpModL](xref:Qdk.Std.Math.ExpModL) | Returns an integer raised to a given power, with respect to a given modulus. I.e. (expBase^power) % modulus. |
|
|
51
|
+
| [ExtendedGreatestCommonDivisorI](xref:Qdk.Std.Math.ExtendedGreatestCommonDivisorI) | Returns a tuple (u,v) such that u*a+v*b=GCD(a,b) Note: GCD is always positive except that GCD(0,0)=0. |
|
|
52
|
+
| [ExtendedGreatestCommonDivisorL](xref:Qdk.Std.Math.ExtendedGreatestCommonDivisorL) | Returns a tuple (u,v) such that u*a+v*b=GCD(a,b) Note: GCD is always positive except that GCD(0,0)=0. |
|
|
53
|
+
| [FactorialI](xref:Qdk.Std.Math.FactorialI) | Returns the factorial of a given number. |
|
|
54
|
+
| [FactorialL](xref:Qdk.Std.Math.FactorialL) | Returns the factorial of a given number. |
|
|
55
|
+
| [Floor](xref:Qdk.Std.Math.Floor) | Returns the largest integer less than or equal to the specified number. For example: Floor(3.7) = 3; Floor(-3.1) = -4 |
|
|
56
|
+
| [GreatestCommonDivisorI](xref:Qdk.Std.Math.GreatestCommonDivisorI) | Computes the greatest common divisor of two integers. Note: GCD is always positive except that GCD(0,0)=0. |
|
|
57
|
+
| [GreatestCommonDivisorL](xref:Qdk.Std.Math.GreatestCommonDivisorL) | Computes the greatest common divisor of two integers. Note: GCD is always positive except that GCD(0,0)=0. |
|
|
58
|
+
| [HammingWeightI](xref:Qdk.Std.Math.HammingWeightI) | Returns the number of 1 bits in the binary representation of integer `n`. |
|
|
59
|
+
| [InverseModI](xref:Qdk.Std.Math.InverseModI) | Returns the multiplicative inverse of a modular integer. |
|
|
60
|
+
| [InverseModL](xref:Qdk.Std.Math.InverseModL) | Returns the multiplicative inverse of a modular integer. |
|
|
61
|
+
| [IsCoprimeI](xref:Qdk.Std.Math.IsCoprimeI) | Returns if two integers are co-prime. |
|
|
62
|
+
| [IsCoprimeL](xref:Qdk.Std.Math.IsCoprimeL) | Returns if two integers are co-prime. |
|
|
63
|
+
| [IsInfinite](xref:Qdk.Std.Math.IsInfinite) | Returns whether a given floating-point value is either positive or negative infinity. |
|
|
64
|
+
| [IsNaN](xref:Qdk.Std.Math.IsNaN) | Returns whether a given floating-point value is not a number (i.e. is NaN). |
|
|
65
|
+
| [LargestFixedPoint](xref:Qdk.Std.Math.LargestFixedPoint) | Returns the largest representable number for specific fixed point dimensions. |
|
|
66
|
+
| [Lg](xref:Qdk.Std.Math.Lg) | Computes the base-2 logarithm of a number. |
|
|
67
|
+
| [Log](xref:Qdk.Std.Math.Log) | Returns the natural (base _e_) logarithm of a specified number. |
|
|
68
|
+
| [Log10](xref:Qdk.Std.Math.Log10) | Returns the base-10 logarithm of a specified number. |
|
|
69
|
+
| [LogFactorialD](xref:Qdk.Std.Math.LogFactorialD) | Returns the approximate natural logarithm of the factorial of a given integer. |
|
|
70
|
+
| [LogGammaD](xref:Qdk.Std.Math.LogGammaD) | Returns the natural logarithm of the gamma function (aka the log-gamma function). |
|
|
71
|
+
| [LogOf2](xref:Qdk.Std.Math.LogOf2) | Returns a double-precision approximation of the constant ㏑2 ≈ 0.6931471805599453 |
|
|
72
|
+
| [Max](xref:Qdk.Std.Math.Max) | Given an array of integers, returns the largest element. |
|
|
73
|
+
| [MaxD](xref:Qdk.Std.Math.MaxD) | Returns the larger of two specified numbers. |
|
|
74
|
+
| [MaxI](xref:Qdk.Std.Math.MaxI) | Returns the larger of two specified numbers. |
|
|
75
|
+
| [MaxL](xref:Qdk.Std.Math.MaxL) | Returns the larger of two specified numbers. |
|
|
76
|
+
| [Min](xref:Qdk.Std.Math.Min) | Given an array of integers, returns the smallest element. |
|
|
77
|
+
| [MinD](xref:Qdk.Std.Math.MinD) | Returns the smaller of two specified numbers. |
|
|
78
|
+
| [MinI](xref:Qdk.Std.Math.MinI) | Returns the smaller of two specified numbers. |
|
|
79
|
+
| [MinL](xref:Qdk.Std.Math.MinL) | Returns the smaller of two specified numbers. |
|
|
80
|
+
| [MinusC](xref:Qdk.Std.Math.MinusC) | Returns the difference between two inputs of type `Complex`. |
|
|
81
|
+
| [MinusCP](xref:Qdk.Std.Math.MinusCP) | Returns the difference between two inputs of type `ComplexPolar`. |
|
|
82
|
+
| [ModulusI](xref:Qdk.Std.Math.ModulusI) | Computes the canonical residue of `value` modulo `modulus`. The result is always in the range 0..modulus-1 even for negative numbers. |
|
|
83
|
+
| [ModulusL](xref:Qdk.Std.Math.ModulusL) | Computes the canonical residue of `value` modulo `modulus`. The result is always in the range 0..modulus-1 even for negative numbers. |
|
|
84
|
+
| [NegationC](xref:Qdk.Std.Math.NegationC) | Returns the unary negation of an input of type `Complex`. |
|
|
85
|
+
| [NegationCP](xref:Qdk.Std.Math.NegationCP) | Returns the unary negation of an input of type `ComplexPolar` |
|
|
86
|
+
| [PI](xref:Qdk.Std.Math.PI) | Returns a double-precision approximation of the matematical constant 𝝅 ≈ 3.14159265358979323846 |
|
|
87
|
+
| [PNorm](xref:Qdk.Std.Math.PNorm) | 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ᵢ)ᵖ)¹ᐟᵖ. |
|
|
88
|
+
| [PNormalized](xref:Qdk.Std.Math.PNormalized) | 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. |
|
|
89
|
+
| [PlusC](xref:Qdk.Std.Math.PlusC) | Returns the sum of two inputs of type `Complex`. |
|
|
90
|
+
| [PlusCP](xref:Qdk.Std.Math.PlusCP) | Returns the sum of two inputs of type `ComplexPolar`. |
|
|
91
|
+
| [PowC](xref:Qdk.Std.Math.PowC) | 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. |
|
|
92
|
+
| [PowCP](xref:Qdk.Std.Math.PowCP) | 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. |
|
|
93
|
+
| [RealMod](xref:Qdk.Std.Math.RealMod) | Computes the modulus between two real numbers. |
|
|
94
|
+
| [Round](xref:Qdk.Std.Math.Round) | Returns the nearest integer to the specified number. For example: Round(3.7) = 4; Round(-3.7) = -4 |
|
|
95
|
+
| [SignD](xref:Qdk.Std.Math.SignD) | Returns -1, 0 or +1 that indicates the sign of a number. |
|
|
96
|
+
| [SignI](xref:Qdk.Std.Math.SignI) | Returns -1, 0 or +1 that indicates the sign of a number. |
|
|
97
|
+
| [SignL](xref:Qdk.Std.Math.SignL) | Returns -1, 0 or +1 that indicates the sign of a number. |
|
|
98
|
+
| [Sin](xref:Qdk.Std.Math.Sin) | Returns the sine of the specified angle. |
|
|
99
|
+
| [Sinh](xref:Qdk.Std.Math.Sinh) | Returns the hyperbolic sine of the specified angle. |
|
|
100
|
+
| [SmallestFixedPoint](xref:Qdk.Std.Math.SmallestFixedPoint) | Returns the smallest representable number for specific fixed point dimensions. |
|
|
101
|
+
| [Sqrt](xref:Qdk.Std.Math.Sqrt) | Returns the square root of a specified number. |
|
|
102
|
+
| [SquaredNorm](xref:Qdk.Std.Math.SquaredNorm) | Returns the squared 2-norm of a vector. |
|
|
103
|
+
| [Tan](xref:Qdk.Std.Math.Tan) | Returns the tangent of the specified angle. |
|
|
104
|
+
| [Tanh](xref:Qdk.Std.Math.Tanh) | Returns the hyperbolic tangent of the specified angle. |
|
|
105
|
+
| [TimesC](xref:Qdk.Std.Math.TimesC) | Returns the product of two inputs of type `Complex`. |
|
|
106
|
+
| [TimesCP](xref:Qdk.Std.Math.TimesCP) | Returns the product of two inputs of type `ComplexPolar`. |
|
|
107
|
+
| [TrailingZeroCountI](xref:Qdk.Std.Math.TrailingZeroCountI) | For a non-zero integer `a`, returns the number of trailing zero bits in the binary representation of `a`. |
|
|
108
|
+
| [TrailingZeroCountL](xref:Qdk.Std.Math.TrailingZeroCountL) | For a non-zero integer `a`, returns the number of trailing zero bits in the binary representation of `a`. |
|
|
109
|
+
| [Truncate](xref:Qdk.Std.Math.Truncate) | Returns the integral part of a number. For example: Truncate(3.7) = 3; Truncate(-3.7) = -3 |
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Measurement.MResetEachZ
|
|
3
3
|
title: MResetEachZ operation
|
|
4
|
-
|
|
4
|
+
description: "Q# MResetEachZ operation: Measures each qubit in a given array in the Z basis and resets them to a fixed initial state."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Measurement.MResetX
|
|
3
3
|
title: MResetX operation
|
|
4
|
-
|
|
4
|
+
description: "Q# MResetX operation: Measures a single qubit in the X basis, and resets it to a fixed initial state following the measurement."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Measurement.MResetY
|
|
3
3
|
title: MResetY operation
|
|
4
|
-
|
|
4
|
+
description: "Q# MResetY operation: Measures a single qubit in the Y basis, and resets it to a fixed initial state following the measurement."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Measurement.MResetZ
|
|
3
3
|
title: MResetZ operation
|
|
4
|
-
|
|
4
|
+
description: "Q# MResetZ operation: Measures a single qubit in the Z basis, and resets it to a fixed initial state following the measurement."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Measurement.MeasureAllZ
|
|
3
3
|
title: MeasureAllZ operation
|
|
4
|
-
|
|
4
|
+
description: "Q# MeasureAllZ operation: Jointly measures a register of qubits in the Pauli Z basis."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Measurement.MeasureEachZ
|
|
3
3
|
title: MeasureEachZ operation
|
|
4
|
-
|
|
4
|
+
description: "Q# MeasureEachZ operation: Measures each qubit in a given array in the standard basis."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Measurement.MeasureInteger
|
|
3
3
|
title: MeasureInteger operation
|
|
4
|
-
|
|
4
|
+
description: "Q# MeasureInteger operation: 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`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
uid: Qdk.Std.Measurement-toc
|
|
3
|
+
title: Std.Measurement namespace
|
|
4
|
+
description: Table of contents for the Q# Measurement namespace
|
|
5
|
+
author: {AUTHOR}
|
|
6
|
+
ms.author: {MS_AUTHOR}
|
|
7
|
+
ms.date: 11/15/2024
|
|
8
|
+
ms.topic: landing-page
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Std.Measurement
|
|
12
|
+
|
|
13
|
+
The Std.Measurement namespace contains the following items:
|
|
14
|
+
|
|
15
|
+
| Name | Description |
|
|
16
|
+
|------|-------------|
|
|
17
|
+
| [MResetEachZ](xref:Qdk.Std.Measurement.MResetEachZ) | Measures each qubit in a given array in the Z basis and resets them to a fixed initial state. |
|
|
18
|
+
| [MResetX](xref:Qdk.Std.Measurement.MResetX) | Measures a single qubit in the X basis, and resets it to a fixed initial state following the measurement. |
|
|
19
|
+
| [MResetY](xref:Qdk.Std.Measurement.MResetY) | Measures a single qubit in the Y basis, and resets it to a fixed initial state following the measurement. |
|
|
20
|
+
| [MResetZ](xref:Qdk.Std.Measurement.MResetZ) | Measures a single qubit in the Z basis, and resets it to a fixed initial state following the measurement. |
|
|
21
|
+
| [MeasureAllZ](xref:Qdk.Std.Measurement.MeasureAllZ) | Jointly measures a register of qubits in the Pauli Z basis. |
|
|
22
|
+
| [MeasureEachZ](xref:Qdk.Std.Measurement.MeasureEachZ) | Measures each qubit in a given array in the standard basis. |
|
|
23
|
+
| [MeasureInteger](xref:Qdk.Std.Measurement.MeasureInteger) | 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`. |
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
uid: Qdk.Std.Random.DrawRandomBool
|
|
3
|
+
title: DrawRandomBool operation
|
|
4
|
+
description: "Q# DrawRandomBool operation: Given a success probability, returns a single Bernoulli trial that is true with the given probability."
|
|
5
|
+
ms.date: 11/15/2024
|
|
6
|
+
ms.topic: managed-reference
|
|
7
|
+
qsharp.kind: operation
|
|
8
|
+
qsharp.package: __Std__
|
|
9
|
+
qsharp.namespace: Std.Random
|
|
10
|
+
qsharp.name: DrawRandomBool
|
|
11
|
+
qsharp.summary: "Given a success probability, returns a single Bernoulli trial that is true with the given probability."
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# DrawRandomBool operation
|
|
15
|
+
|
|
16
|
+
Fully qualified name: Std.Random.DrawRandomBool
|
|
17
|
+
|
|
18
|
+
```qsharp
|
|
19
|
+
operation DrawRandomBool(successProbability : Double) : Bool
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Summary
|
|
23
|
+
Given a success probability, returns a single Bernoulli trial
|
|
24
|
+
that is true with the given probability.
|
|
25
|
+
|
|
26
|
+
## Input
|
|
27
|
+
### successProbability
|
|
28
|
+
The probability with which true should be returned.
|
|
29
|
+
|
|
30
|
+
## Output
|
|
31
|
+
`true` with probability `successProbability`
|
|
32
|
+
and `false` with probability `1.0 - successProbability`.
|
|
33
|
+
|
|
34
|
+
## Example
|
|
35
|
+
The following Q# snippet samples flips from a biased coin:
|
|
36
|
+
```qsharp
|
|
37
|
+
let flips = DrawMany(DrawRandomBool, 10, 0.6);
|
|
38
|
+
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
uid: Qdk.Std.Random.DrawRandomDouble
|
|
3
|
+
title: DrawRandomDouble operation
|
|
4
|
+
description: "Q# DrawRandomDouble operation: Draws a random real number from a uniform distribution in a given inclusive interval. Fails if `max < min`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
6
|
+
ms.topic: managed-reference
|
|
7
|
+
qsharp.kind: operation
|
|
8
|
+
qsharp.package: __Std__
|
|
9
|
+
qsharp.namespace: Std.Random
|
|
10
|
+
qsharp.name: DrawRandomDouble
|
|
11
|
+
qsharp.summary: "Draws a random real number from a uniform distribution in a given inclusive interval. Fails if `max < min`."
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# DrawRandomDouble operation
|
|
15
|
+
|
|
16
|
+
Fully qualified name: Std.Random.DrawRandomDouble
|
|
17
|
+
|
|
18
|
+
```qsharp
|
|
19
|
+
operation DrawRandomDouble(min : Double, max : Double) : Double
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Summary
|
|
23
|
+
Draws a random real number from a uniform distribution
|
|
24
|
+
in a given inclusive interval. Fails if `max < min`.
|
|
25
|
+
|
|
26
|
+
## Input
|
|
27
|
+
### min
|
|
28
|
+
The smallest real number to be drawn.
|
|
29
|
+
### max
|
|
30
|
+
The largest real number to be drawn.
|
|
31
|
+
|
|
32
|
+
## Output
|
|
33
|
+
A random real number in the inclusive interval from `min` to `max` with
|
|
34
|
+
uniform probability.
|
|
35
|
+
|
|
36
|
+
## Example
|
|
37
|
+
The following Q# snippet randomly draws an angle between 0 and 2π:
|
|
38
|
+
```qsharp
|
|
39
|
+
let angle = DrawRandomDouble(0.0, 2.0 * PI());
|
|
40
|
+
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
uid: Qdk.Std.Random.DrawRandomInt
|
|
3
|
+
title: DrawRandomInt operation
|
|
4
|
+
description: "Q# DrawRandomInt operation: Draws a random integer from a uniform distribution in a given inclusive range. Fails if `max < min`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
6
|
+
ms.topic: managed-reference
|
|
7
|
+
qsharp.kind: operation
|
|
8
|
+
qsharp.package: __Std__
|
|
9
|
+
qsharp.namespace: Std.Random
|
|
10
|
+
qsharp.name: DrawRandomInt
|
|
11
|
+
qsharp.summary: "Draws a random integer from a uniform distribution in a given inclusive range. Fails if `max < min`."
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# DrawRandomInt operation
|
|
15
|
+
|
|
16
|
+
Fully qualified name: Std.Random.DrawRandomInt
|
|
17
|
+
|
|
18
|
+
```qsharp
|
|
19
|
+
operation DrawRandomInt(min : Int, max : Int) : Int
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Summary
|
|
23
|
+
Draws a random integer from a uniform distribution
|
|
24
|
+
in a given inclusive range. Fails if `max < min`.
|
|
25
|
+
|
|
26
|
+
## Input
|
|
27
|
+
### min
|
|
28
|
+
The smallest integer to be drawn.
|
|
29
|
+
### max
|
|
30
|
+
The largest integer to be drawn.
|
|
31
|
+
|
|
32
|
+
## Output
|
|
33
|
+
An integer in the inclusive range from `min` to `max` with uniform
|
|
34
|
+
probability.
|
|
35
|
+
|
|
36
|
+
## Example
|
|
37
|
+
The following Q# snippet randomly rolls a six-sided die:
|
|
38
|
+
```qsharp
|
|
39
|
+
let roll = DrawRandomInt(1, 6);
|
|
40
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
uid: Qdk.Std.Random-toc
|
|
3
|
+
title: Std.Random namespace
|
|
4
|
+
description: Table of contents for the Q# Random namespace
|
|
5
|
+
author: {AUTHOR}
|
|
6
|
+
ms.author: {MS_AUTHOR}
|
|
7
|
+
ms.date: 11/15/2024
|
|
8
|
+
ms.topic: landing-page
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Std.Random
|
|
12
|
+
|
|
13
|
+
The Std.Random namespace contains the following items:
|
|
14
|
+
|
|
15
|
+
| Name | Description |
|
|
16
|
+
|------|-------------|
|
|
17
|
+
| [DrawRandomBool](xref:Qdk.Std.Random.DrawRandomBool) | Given a success probability, returns a single Bernoulli trial that is true with the given probability. |
|
|
18
|
+
| [DrawRandomDouble](xref:Qdk.Std.Random.DrawRandomDouble) | Draws a random real number from a uniform distribution in a given inclusive interval. Fails if `max < min`. |
|
|
19
|
+
| [DrawRandomInt](xref:Qdk.Std.Random.DrawRandomInt) | Draws a random integer from a uniform distribution in a given inclusive range. Fails if `max < min`. |
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Range.IsRangeEmpty
|
|
3
3
|
title: IsRangeEmpty function
|
|
4
|
-
|
|
4
|
+
description: "Q# IsRangeEmpty function: Returns true if and only if the input range is empty."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Range.RangeEnd
|
|
3
3
|
title: RangeEnd function
|
|
4
|
-
|
|
4
|
+
description: "Q# RangeEnd function: Returns the defined end value of the given range, which is not necessarily the last element in the sequence."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Range.RangeReverse
|
|
3
3
|
title: RangeReverse function
|
|
4
|
-
|
|
4
|
+
description: "Q# RangeReverse function: Returns a new range which is the reverse of the input range."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Range.RangeStart
|
|
3
3
|
title: RangeStart function
|
|
4
|
-
|
|
4
|
+
description: "Q# RangeStart function: Returns the defined start value of the given range."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.Range.RangeStep
|
|
3
3
|
title: RangeStep function
|
|
4
|
-
|
|
4
|
+
description: "Q# RangeStep function: Returns the integer that specifies how the next value of a range is calculated."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
uid: Qdk.Std.Range-toc
|
|
3
|
+
title: Std.Range namespace
|
|
4
|
+
description: Table of contents for the Q# Range namespace
|
|
5
|
+
author: {AUTHOR}
|
|
6
|
+
ms.author: {MS_AUTHOR}
|
|
7
|
+
ms.date: 11/15/2024
|
|
8
|
+
ms.topic: landing-page
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Std.Range
|
|
12
|
+
|
|
13
|
+
The Std.Range namespace contains the following items:
|
|
14
|
+
|
|
15
|
+
| Name | Description |
|
|
16
|
+
|------|-------------|
|
|
17
|
+
| [IsRangeEmpty](xref:Qdk.Std.Range.IsRangeEmpty) | Returns true if and only if the input range is empty. |
|
|
18
|
+
| [RangeEnd](xref:Qdk.Std.Range.RangeEnd) | Returns the defined end value of the given range, which is not necessarily the last element in the sequence. |
|
|
19
|
+
| [RangeReverse](xref:Qdk.Std.Range.RangeReverse) | Returns a new range which is the reverse of the input range. |
|
|
20
|
+
| [RangeStart](xref:Qdk.Std.Range.RangeStart) | Returns the defined start value of the given range. |
|
|
21
|
+
| [RangeStep](xref:Qdk.Std.Range.RangeStep) | Returns the integer that specifies how the next value of a range is calculated. |
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.ResourceEstimation.AccountForEstimates
|
|
3
3
|
title: AccountForEstimates operation
|
|
4
|
-
|
|
4
|
+
description: "Q# AccountForEstimates operation: Account for the resource estimates of an unimplemented operation, which were obtained separately. This operation is only available when using resource estimator execution target."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.ResourceEstimation.AuxQubitCount
|
|
3
3
|
title: AuxQubitCount function
|
|
4
|
-
|
|
4
|
+
description: "Q# AuxQubitCount function: Returns a tuple that can be passed to the `AccountForEstimates` operation to specify that the number of auxiliary qubits is equal to the `amount`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.ResourceEstimation.BeginEstimateCaching
|
|
3
3
|
title: BeginEstimateCaching function
|
|
4
|
-
|
|
4
|
+
description: "Q# BeginEstimateCaching function: Informs the resource estimator of the start of the code fragment for which estimates caching can be done. This function is only available when using resource estimator execution target."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.ResourceEstimation.BeginRepeatEstimates
|
|
3
3
|
title: BeginRepeatEstimates operation
|
|
4
|
-
|
|
4
|
+
description: "Q# BeginRepeatEstimates operation: Instructs the resource estimator to assume that the resources from the call of this operation until a call to `EndRepeatEstimates` are accounted for `count` times, without the need to execute the code that many times. Calls to `BeginRepeatEstimates` and `EndRepeatEstimates` can be nested. A helper operation `RepeatEstimates` allows to call the two functions in a `within` block."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.ResourceEstimation.CczCount
|
|
3
3
|
title: CczCount function
|
|
4
|
-
|
|
4
|
+
description: "Q# CczCount function: Returns a tuple that can be passed to the `AccountForEstimates` operation to specify that the number of the CCZ gates is equal to the `amount`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.ResourceEstimation.EndEstimateCaching
|
|
3
3
|
title: EndEstimateCaching function
|
|
4
|
-
|
|
4
|
+
description: "Q# EndEstimateCaching function: Instructs the resource estimator to stop estimates caching because the code fragment in consideration is over. This function is only available when using resource estimator execution target."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: function
|
|
7
8
|
qsharp.package: __Std__
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
uid: Qdk.Std.ResourceEstimation.EndRepeatEstimates
|
|
3
3
|
title: EndRepeatEstimates operation
|
|
4
|
-
|
|
4
|
+
description: "Q# EndRepeatEstimates operation: Companion operation to `BeginRepeatEstimates`."
|
|
5
|
+
ms.date: 11/15/2024
|
|
5
6
|
ms.topic: managed-reference
|
|
6
7
|
qsharp.kind: operation
|
|
7
8
|
qsharp.package: __Std__
|