qsharp-lang 1.8.2-dev → 1.8.4-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/samples.generated.js +16 -16
- package/docs/Microsoft.Quantum.Core/IsRangeEmpty.md +1 -1
- package/docs/Microsoft.Quantum.Core/Length.md +1 -1
- package/docs/Microsoft.Quantum.Core/RangeEnd.md +1 -1
- package/docs/Microsoft.Quantum.Core/RangeReverse.md +1 -1
- package/docs/Microsoft.Quantum.Core/RangeStart.md +1 -1
- package/docs/Microsoft.Quantum.Core/RangeStep.md +1 -1
- package/docs/Microsoft.Quantum.Core/Repeated.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/AddLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfEqualL.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfEqualLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterL.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterOrEqualL.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterOrEqualLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessL.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessOrEqualL.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessOrEqualLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/FourierTDIncByLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByI.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByIUsingIncByLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByL.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByLEUsingAddLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByLUsingIncByLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/LookAheadDKRSAddLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/MAJ.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/ReflectAboutInteger.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryCGAddLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryCGIncByLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryTTKIncByLE.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.StatePreparation/ApproximatelyPreparePureStateCP.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.StatePreparation/PreparePureStateD.md +1 -1
- package/docs/Microsoft.Quantum.Unstable.TableLookup/Select.md +1 -1
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/All.md +4 -4
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Any.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Chunks.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/CircularlyShifted.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/ColumnAt.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Count.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Diagonal.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/DrawMany.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Enumerated.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Excluding.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Filtered.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/FlatMapped.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Flattened.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Fold.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/ForEach.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Head.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/HeadAndRest.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/IndexOf.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/IndexRange.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Interleaved.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/IsEmpty.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/IsRectangularArray.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/IsSorted.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/IsSquareArray.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Mapped.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/MappedByIndex.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/MappedOverRange.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Most.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/MostAndTail.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Padded.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Partitioned.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Rest.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Reversed.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/SequenceI.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/SequenceL.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Sorted.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Subarray.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Swapped.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Tail.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Transposed.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Unzipped.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Where.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Windows.md +5 -6
- package/docs/{Microsoft.Quantum.Arrays → Std.Arrays}/Zipped.md +5 -6
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyCNOTChain.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyControlledOnBitString.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyControlledOnInt.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyP.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyPauli.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyPauliFromBitString.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyPauliFromInt.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyQFT.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyToEach.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyToEachA.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyToEachC.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyToEachCA.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyXorInPlace.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/ApplyXorInPlaceL.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/CX.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/CY.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/CZ.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/Fst.md +4 -4
- package/docs/Std.Canon/Relabel.md +49 -0
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/Snd.md +4 -4
- package/docs/{Microsoft.Quantum.Canon → Std.Canon}/SwapReverseRegister.md +4 -4
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/BigIntAsBoolArray.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/BoolArrayAsBigInt.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/BoolArrayAsInt.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/BoolArrayAsResultArray.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/BoolAsResult.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/ComplexAsComplexPolar.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/ComplexPolarAsComplex.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/DoubleAsStringWithPrecision.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/IntAsBigInt.md +4 -5
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/IntAsBoolArray.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/IntAsDouble.md +4 -4
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/ResultArrayAsBoolArray.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/ResultArrayAsInt.md +5 -6
- package/docs/{Microsoft.Quantum.Convert → Std.Convert}/ResultAsBool.md +5 -6
- package/docs/{Microsoft.Quantum.Diagnostics → Std.Diagnostics}/DumpMachine.md +4 -4
- package/docs/{Microsoft.Quantum.Diagnostics → Std.Diagnostics}/DumpRegister.md +5 -6
- package/docs/{Microsoft.Quantum.Diagnostics → Std.Diagnostics}/Fact.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/AND.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/CCNOT.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/CNOT.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Exp.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/H.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/I.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/M.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Measure.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Message.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/R.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/R1.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/R1Frac.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/RFrac.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Reset.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/ResetAll.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Rx.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Rxx.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Ry.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Ryy.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Rz.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Rzz.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/S.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/SWAP.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/T.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/X.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Y.md +5 -6
- package/docs/{Microsoft.Quantum.Intrinsic → Std.Intrinsic}/Z.md +5 -6
- package/docs/{Microsoft.Quantum.Logical → Std.Logical}/Xor.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/AbsComplex.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/AbsComplexPolar.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/AbsD.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/AbsI.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/AbsL.md +4 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/AbsSquaredComplex.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/AbsSquaredComplexPolar.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ApproximateFactorial.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ArcCos.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ArcCosh.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ArcSin.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ArcSinh.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ArcTan.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ArcTan2.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ArcTanh.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ArgComplex.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ArgComplexPolar.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Binom.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/BitSizeI.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/BitSizeL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Ceiling.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Complex.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ComplexPolar.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ContinuedFractionConvergentI.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ContinuedFractionConvergentL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Cos.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Cosh.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/DivRemI.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/DivRemL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/DividedByC.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/DividedByCP.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/E.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ExpModI.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ExpModL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ExtendedGreatestCommonDivisorI.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ExtendedGreatestCommonDivisorL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/FactorialI.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/FactorialL.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Floor.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/GreatestCommonDivisorI.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/GreatestCommonDivisorL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/HammingWeightI.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/InverseModI.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/InverseModL.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/IsCoprimeI.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/IsCoprimeL.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/IsInfinite.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/IsNaN.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/LargestFixedPoint.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Lg.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Log.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Log10.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/LogFactorialD.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/LogGammaD.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/LogOf2.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Max.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/MaxD.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/MaxI.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/MaxL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Min.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/MinD.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/MinI.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/MinL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/MinusC.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/MinusCP.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ModulusI.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/ModulusL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/NegationC.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/NegationCP.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/PI.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/PNorm.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/PNormalized.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/PlusC.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/PlusCP.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/PowC.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/PowCP.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/RealMod.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Round.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/SignD.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/SignI.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/SignL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Sin.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Sinh.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/SmallestFixedPoint.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Sqrt.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/SquaredNorm.md +4 -4
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Tan.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Tanh.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/TimesC.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/TimesCP.md +5 -6
- package/docs/{Microsoft.Quantum.Math → Std.Math}/TrailingZeroCountI.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/TrailingZeroCountL.md +4 -5
- package/docs/{Microsoft.Quantum.Math → Std.Math}/Truncate.md +4 -4
- package/docs/{Microsoft.Quantum.Measurement → Std.Measurement}/MResetEachZ.md +5 -6
- package/docs/{Microsoft.Quantum.Measurement → Std.Measurement}/MResetX.md +5 -6
- package/docs/{Microsoft.Quantum.Measurement → Std.Measurement}/MResetY.md +5 -6
- package/docs/{Microsoft.Quantum.Measurement → Std.Measurement}/MResetZ.md +5 -6
- package/docs/{Microsoft.Quantum.Measurement → Std.Measurement}/MeasureAllZ.md +4 -4
- package/docs/{Microsoft.Quantum.Measurement → Std.Measurement}/MeasureEachZ.md +5 -6
- package/docs/{Microsoft.Quantum.Measurement → Std.Measurement}/MeasureInteger.md +5 -6
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/AccountForEstimates.md +5 -6
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/AuxQubitCount.md +4 -4
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/BeginEstimateCaching.md +5 -6
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/BeginRepeatEstimates.md +5 -6
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/CczCount.md +4 -5
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/EndEstimateCaching.md +4 -5
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/EndRepeatEstimates.md +4 -5
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/MeasurementCount.md +4 -5
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/PSSPCLayout.md +4 -5
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/RepeatEstimates.md +5 -6
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/RotationCount.md +4 -5
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/RotationDepth.md +4 -5
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/SingleVariant.md +4 -4
- package/docs/{Microsoft.Quantum.ResourceEstimation → Std.ResourceEstimation}/TCount.md +4 -5
- package/docs/toc.yml +252 -251
- package/lib/node/qsc_wasm.cjs +2 -2
- package/lib/node/qsc_wasm_bg.wasm +0 -0
- package/lib/web/qsc_wasm.js +2 -2
- package/lib/web/qsc_wasm_bg.wasm +0 -0
- package/package.json +1 -1
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.FlatMapped
|
|
3
3
|
title: FlatMapped function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: FlatMapped
|
|
9
|
-
qsharp.summary: "Given an array and a function that maps an array element to some output array, returns the concatenated output arrays for each array element."
|
|
9
|
+
qsharp.summary: "Given an array and a function that maps an array element to some output array, returns the concatenated output arrays for each array element. # Type Parameters ## 'TInput The type of `array` elements. ## 'TOutput The `mapper` function returns arrays of this type. # Input ## mapper A function from `'TInput` to `'TOutput[]` that is used to map array elements. ## array An array of elements. # Output An array of `'TOutput[]` which is the concatenation of all arrays generated by the mapping function. # Example The following code creates an array with each element of the input array repeated twice. ```qsharp let repeatedPairs = FlatMapped(x -> Repeated(x, 2), [1, 2, 3]); // repeatedPairs is [1, 1, 2, 2, 3, 3]. ```"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# FlatMapped function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.FlatMapped
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function FlatMapped<'TInput, 'TOutput>(mapper : ('TInput -> 'TOutput[]), array : 'TInput[]) : 'TOutput[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Given an array and a function that maps an array element to some output
|
|
22
21
|
array, returns the concatenated output arrays for each array element.
|
|
23
22
|
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.Flattened
|
|
3
3
|
title: Flattened function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: Flattened
|
|
9
|
-
qsharp.summary: "Given an array of arrays, returns the concatenation of all arrays."
|
|
9
|
+
qsharp.summary: "Given an array of arrays, returns the concatenation of all arrays. # Type Parameters ## 'T The type of `array` elements. # Input ## arrays Array of arrays. # Output Concatenation of all arrays. # Example ```qsharp let flattened = Flattened([[1, 2], [3], [4, 5, 6]]); // flattened = [1, 2, 3, 4, 5, 6] ```"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Flattened function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.Flattened
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function Flattened<'T>(arrays : 'T[][]) : 'T[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Given an array of arrays, returns the concatenation of all arrays.
|
|
22
21
|
|
|
23
22
|
## Type Parameters
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.Fold
|
|
3
3
|
title: Fold function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: Fold
|
|
9
|
-
qsharp.summary: "Iterates a function `f` through an array `array`, returning `f(...f(f(initialState, array[0]), array[1]), ...)`."
|
|
9
|
+
qsharp.summary: "Iterates a function `f` through an array `array`, returning `f(...f(f(initialState, array[0]), array[1]), ...)`. # Type Parameters ## 'State The type of states the `folder` function operates on, i.e., accepts as its first argument and returns. ## 'T The type of `array` elements. # Input ## folder A function to be folded over the array. ## state The initial state of the folder. ## array An array of values to be folded over. # Output The final state returned by the folder after iterating over all elements of `array`. # Example ```qsharp let sum = Fold((x, y) -> x + y, 0, [1, 2, 3, 4, 5]); // `sum` is 15. ```"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Fold function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.Fold
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function Fold<'State, 'T>(folder : (('State, 'T) -> 'State), state : 'State, array : 'T[]) : 'State
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Iterates a function `f` through an array `array`, returning
|
|
22
21
|
`f(...f(f(initialState, array[0]), array[1]), ...)`.
|
|
23
22
|
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.ForEach
|
|
3
3
|
title: ForEach operation
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: operation
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: ForEach
|
|
9
|
-
qsharp.summary: "Given an array and an operation that is defined for the elements of the array, returns a new array that consists of the images of the original array under the operation."
|
|
9
|
+
qsharp.summary: "Given an array and an operation that is defined for the elements of the array, returns a new array that consists of the images of the original array under the operation. # Type Parameters ## 'T The type of `array` elements. ## 'U The result type of the `action` operation. # Input ## action An operation from `'T` to `'U` that is applied to each element. ## array An array of elements over `'T`. # Output An array `'U[]` of elements that are mapped by the `action` operation. # See Also - Microsoft.Quantum.Arrays.Mapped"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# ForEach operation
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.ForEach
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
operation ForEach<'T, 'U>(action : ('T => 'U), array : 'T[]) : 'U[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Given an array and an operation that is defined
|
|
22
21
|
for the elements of the array, returns a new array that consists
|
|
23
22
|
of the images of the original array under the operation.
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.Head
|
|
3
3
|
title: Head function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: Head
|
|
9
|
-
qsharp.summary: "Returns the first element of the array."
|
|
9
|
+
qsharp.summary: "Returns the first element of the array. # Type Parameters ## 'A The type of the array elements. # Input ## array Array of which the first element is taken. Array must have at least 1 element. # Output The first element of the array."
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Head function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.Head
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function Head<'A>(array : 'A[]) : 'A
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Returns the first element of the array.
|
|
22
21
|
|
|
23
22
|
## Type Parameters
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.HeadAndRest
|
|
3
3
|
title: HeadAndRest function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: HeadAndRest
|
|
9
|
-
qsharp.summary: "Returns a tuple of first and all remaining elements of the array."
|
|
9
|
+
qsharp.summary: "Returns a tuple of first and all remaining elements of the array. # Type Parameters ## 'A The type of the array elements. # Input ## array An array with at least one element. # Output A tuple of first and all remaining elements of the array."
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# HeadAndRest function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.HeadAndRest
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function HeadAndRest<'A>(array : 'A[]) : ('A, 'A[])
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Returns a tuple of first and all remaining elements of the array.
|
|
22
21
|
|
|
23
22
|
## Type Parameters
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.IndexOf
|
|
3
3
|
title: IndexOf function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: IndexOf
|
|
9
|
-
qsharp.summary: "Returns the first index of the first element in an array that satisfies a given predicate. If no such element exists, returns -1."
|
|
9
|
+
qsharp.summary: "Returns the first index of the first element in an array that satisfies a given predicate. If no such element exists, returns -1. # Input ## predicate A predicate function acting on elements of the array. ## array An array to be searched using the given predicate. # Output Either the smallest index of an element for which `predicate(array[index])` is true, or -1 if no such element exists. # Example The following code gets the index of the first even number in the input array. ```qsharp let indexOfFirstEven = IndexOf(x -> x % 2 == 0, [1, 3, 17, 2, 21]); // `indexOfFirstEven` is 3. ```"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# IndexOf function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.IndexOf
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function IndexOf<'T>(predicate : ('T -> Bool), array : 'T[]) : Int
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Returns the first index of the first element in an array that satisfies
|
|
22
21
|
a given predicate. If no such element exists, returns -1.
|
|
23
22
|
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.IndexRange
|
|
3
3
|
title: IndexRange function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: IndexRange
|
|
9
|
-
qsharp.summary: "Given an array, returns a range over the indices of that array, suitable for use in a for loop."
|
|
9
|
+
qsharp.summary: "Given an array, returns a range over the indices of that array, suitable for use in a for loop. # Type Parameters ## 'TElement The type of elements of the array. # Input ## array An array for which a range of indices should be returned. # Output A range over all indices of the array. # Example The following `for` loops are equivalent: ```qsharp for idx in IndexRange(array) { ... } for idx in 0 .. Length(array) - 1 { ... } ```"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# IndexRange function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.IndexRange
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function IndexRange<'TElement>(array : 'TElement[]) : Range
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Given an array, returns a range over the indices of that array, suitable
|
|
22
21
|
for use in a for loop.
|
|
23
22
|
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.Interleaved
|
|
3
3
|
title: Interleaved function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: Interleaved
|
|
9
|
-
qsharp.summary: "Interleaves two arrays of (almost) same size."
|
|
9
|
+
qsharp.summary: "Interleaves two arrays of (almost) same size. # Description This function returns the interleaving of two arrays, starting with the first element from the first array, then the first element from the second array, and so on. The first array must either be of the same length as the second one, or can have one more element. # Type Parameters ## 'T The type of each element of `first` and `second`. # Input ## first The first array to be interleaved. ## second The second array to be interleaved. # Output Interleaved array # Example ```qsharp // same as interleaved = [1, -1, 2, -2, 3, -3] let interleaved = Interleaved([1, 2, 3], [-1, -2, -3]) ```"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Interleaved function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.Interleaved
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function Interleaved<'T>(first : 'T[], second : 'T[]) : 'T[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Interleaves two arrays of (almost) same size.
|
|
22
21
|
|
|
23
22
|
## Description
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.IsEmpty
|
|
3
3
|
title: IsEmpty function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: IsEmpty
|
|
9
|
-
qsharp.summary: "Returns true if and only if an array is empty."
|
|
9
|
+
qsharp.summary: "Returns true if and only if an array is empty. # Input ## array The array to be checked. # Output `true` if and only if the array is empty (has length 0)."
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# IsEmpty function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.IsEmpty
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function IsEmpty<'T>(array : 'T[]) : Bool
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Returns true if and only if an array is empty.
|
|
22
21
|
|
|
23
22
|
## Input
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.IsRectangularArray
|
|
3
3
|
title: IsRectangularArray function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: IsRectangularArray
|
|
9
|
-
qsharp.summary: "Returns whether a 2-dimensional array has a rectangular shape"
|
|
9
|
+
qsharp.summary: "Returns whether a 2-dimensional array has a rectangular shape # Type Parameters ## 'T The type of each element of `array`. # Input ## array A 2-dimensional array of elements. # Output `true` if the array is rectangular, `false` otherwise. # Example ```qsharp IsRectangularArray([[1, 2], [3, 4]]); // true IsRectangularArray([[1, 2, 3], [4, 5, 6]]); // true IsRectangularArray([[1, 2], [3, 4, 5]]); // false ``` # See Also - Microsoft.Quantum.Arrays.IsSquareArray"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# IsRectangularArray function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.IsRectangularArray
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function IsRectangularArray<'T>(array : 'T[][]) : Bool
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Returns whether a 2-dimensional array has a rectangular shape
|
|
22
21
|
|
|
23
22
|
## Type Parameters
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.IsSorted
|
|
3
3
|
title: IsSorted function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: IsSorted
|
|
9
|
-
qsharp.summary: "Given an array, returns whether that array is sorted as defined by a given comparison function."
|
|
9
|
+
qsharp.summary: "Given an array, returns whether that array is sorted as defined by a given comparison function. # Type Parameters ## 'T The type of each element of `array`. # Input ## comparison A function that compares two elements such that `a` is considered to be less than or equal to `b` if `comparison(a, b)` is `true`. ## array The array to be checked. # Output `true` if and only if for each pair of elements `a` and `b` of `array` occurring in that order, `comparison(a, b)` is `true`. # Remarks The function `comparison` is assumed to be transitive, such that if `comparison(a, b)` and `comparison(b, c)`, then `comparison(a, c)` is assumed."
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# IsSorted function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.IsSorted
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function IsSorted<'T>(comparison : (('T, 'T) -> Bool), array : 'T[]) : Bool
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Given an array, returns whether that array is sorted as defined by
|
|
22
21
|
a given comparison function.
|
|
23
22
|
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.IsSquareArray
|
|
3
3
|
title: IsSquareArray function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: IsSquareArray
|
|
9
|
-
qsharp.summary: "Returns whether a 2-dimensional array has a square shape"
|
|
9
|
+
qsharp.summary: "Returns whether a 2-dimensional array has a square shape # Type Parameters ## 'T The type of each element of `array`. # Input ## array A 2-dimensional array of elements. # Example ```qsharp IsSquareArray([[1, 2], [3, 4]]); // true IsSquareArray([[1, 2, 3], [4, 5, 6]]); // false IsSquareArray([[1, 2], [3, 4], [5, 6]]); // false ``` # Output `true` if the array is square, `false` otherwise. # See Also - Microsoft.Quantum.Arrays.IsRectangularArray"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# IsSquareArray function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.IsSquareArray
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function IsSquareArray<'T>(array : 'T[][]) : Bool
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Returns whether a 2-dimensional array has a square shape
|
|
22
21
|
|
|
23
22
|
## Type Parameters
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.Mapped
|
|
3
3
|
title: Mapped function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: Mapped
|
|
9
|
-
qsharp.summary: "Given an array and a function that is defined for the elements of the array, returns a new array that consists of the images of the original array under the function."
|
|
9
|
+
qsharp.summary: "Given an array and a function that is defined for the elements of the array, returns a new array that consists of the images of the original array under the function. # Type Parameters ## 'T The type of `array` elements. ## 'U The result type of the `mapper` function. # Input ## mapper A function from `'T` to `'U` that is used to map elements. ## array An array of elements over `'T`. # Output An array `'U[]` of elements that are mapped by the `mapper` function. # See Also - Microsoft.Quantum.Arrays.ForEach"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Mapped function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.Mapped
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function Mapped<'T, 'U>(mapper : ('T -> 'U), array : 'T[]) : 'U[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Given an array and a function that is defined
|
|
22
21
|
for the elements of the array, returns a new array that consists
|
|
23
22
|
of the images of the original array under the function.
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.MappedByIndex
|
|
3
3
|
title: MappedByIndex function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: MappedByIndex
|
|
9
|
-
qsharp.summary: "Given an array and a function that is defined for the indexed elements of the array, returns a new array that consists of the images of the original array under the function."
|
|
9
|
+
qsharp.summary: "Given an array and a function that is defined for the indexed elements of the array, returns a new array that consists of the images of the original array under the function. # Type Parameters ## 'T The type of `array` elements. ## 'U The result type of the `mapper` function. # Input ## mapper A function from `(Int, 'T)` to `'U` that is used to map elements and their indices. ## array An array of elements over `'T`. # Output An array `'U[]` of elements that are mapped by the `mapper` function. # Example The following two lines are equivalent: ```qsharp let array = MappedByIndex(f, [x0, x1, x2]); ``` and ```qsharp let array = [f(0, x0), f(1, x1), f(2, x2)]; ``` # See Also - Microsoft.Quantum.Arrays.Mapped"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# MappedByIndex function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.MappedByIndex
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function MappedByIndex<'T, 'U>(mapper : ((Int, 'T) -> 'U), array : 'T[]) : 'U[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Given an array and a function that is defined
|
|
22
21
|
for the indexed elements of the array, returns a new array that consists
|
|
23
22
|
of the images of the original array under the function.
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.MappedOverRange
|
|
3
3
|
title: MappedOverRange function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: MappedOverRange
|
|
9
|
-
qsharp.summary: "Given a range and a function that takes an integer as input, returns a new array that consists of the images of the range values under the function."
|
|
9
|
+
qsharp.summary: "Given a range and a function that takes an integer as input, returns a new array that consists of the images of the range values under the function. # Type Parameters ## 'T The result type of the `mapper` function. # Input ## mapper A function from `Int` to `'T` that is used to map range values. ## range A range of integers. # Output An array `'T[]` of elements that are mapped by the `mapper` function. # Example This example adds 1 to a range of even numbers: ```qsharp let numbers = MappedOverRange(x -> x + 1, 0..2..10); // numbers = [1, 3, 5, 7, 9, 11] ``` # See Also - Microsoft.Quantum.Arrays.Mapped"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# MappedOverRange function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.MappedOverRange
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function MappedOverRange<'T>(mapper : (Int -> 'T), range : Range) : 'T[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Given a range and a function that takes an integer as input,
|
|
22
21
|
returns a new array that consists
|
|
23
22
|
of the images of the range values under the function.
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.Most
|
|
3
3
|
title: Most function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: Most
|
|
9
|
-
qsharp.summary: "Creates an array that is equal to an input array except that the last array element is dropped."
|
|
9
|
+
qsharp.summary: "Creates an array that is equal to an input array except that the last array element is dropped. # Type Parameters ## 'T The type of the array elements. # Input ## array An array whose first to second-to-last elements are to form the output array. # Output An array containing the elements `array[0..Length(array) - 2]`."
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Most function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.Most
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function Most<'T>(array : 'T[]) : 'T[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Creates an array that is equal to an input array except that the last array
|
|
22
21
|
element is dropped.
|
|
23
22
|
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.MostAndTail
|
|
3
3
|
title: MostAndTail function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: MostAndTail
|
|
9
|
-
qsharp.summary: "Returns a tuple of all but one and the last element of the array."
|
|
9
|
+
qsharp.summary: "Returns a tuple of all but one and the last element of the array. # Type Parameters ## 'A The type of the array elements. # Input ## array An array with at least one element. # Output A tuple of all but one and the last element of the array."
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# MostAndTail function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.MostAndTail
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function MostAndTail<'A>(array : 'A[]) : ('A[], 'A)
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Returns a tuple of all but one and the last element of the array.
|
|
22
21
|
|
|
23
22
|
## Type Parameters
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.Padded
|
|
3
3
|
title: Padded function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: Padded
|
|
9
|
-
qsharp.summary: "Returns an array padded at with specified values up to a specified length."
|
|
9
|
+
qsharp.summary: "Returns an array padded at with specified values up to a specified length. # Type Parameters ## 'T The type of the array elements. # Input ## paddedLength The length of the padded array. If this is positive, `array` is padded at the head. If this is negative, `array` is padded at the tail. ## defaultElement Default value to use for padding elements. ## array Array to be padded. # Output An array `output` that is the `array` padded at the head or the tail with `defaultElement`s until `output` has length `paddedLength` # Example ```qsharp let array = [10, 11, 12]; // The following line returns [10, 12, 15, 2, 2]. let output = Padded(-5, 2, array); // The following line returns [2, 2, 10, 12, 15]. let output = Padded(5, 2, array); ```"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Padded function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.Padded
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function Padded<'T>(paddedLength : Int, defaultElement : 'T, inputArray : 'T[]) : 'T[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Returns an array padded at with specified values up to a
|
|
22
21
|
specified length.
|
|
23
22
|
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.Partitioned
|
|
3
3
|
title: Partitioned function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: Partitioned
|
|
9
|
-
qsharp.summary: "Splits an array into multiple parts."
|
|
9
|
+
qsharp.summary: "Splits an array into multiple parts. # Input ## partitionSizes Number of elements in each split part of array. ## array Input array to be split. # Output Multiple arrays where the first array is the first `partitionSizes[0]` of `array` and the second array are the next `partitionSizes[1]` of `array` etc. The last array will contain all remaining elements. If the array is split exactly, the last array will be the empty array, indicating there are no remaining elements. In other words, `Tail(Partitioned(...))` will always return the remaining elements, while `Most(Partitioned(...))` will always return the complete partitions of the array. # Example ```qsharp // The following returns [[2, 3], [5], [7]]; let split = Partitioned([2, 1], [2, 3, 5, 7]); // The following returns [[2, 3], [5, 7], []]; let split = Partitioned([2, 2], [2, 3, 5, 7]); ```"
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Partitioned function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.Partitioned
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function Partitioned<'T>(partitionSizes : Int[], array : 'T[]) : 'T[][]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Splits an array into multiple parts.
|
|
22
21
|
|
|
23
22
|
## Input
|
|
@@ -1,23 +1,22 @@
|
|
|
1
1
|
---
|
|
2
|
-
uid: Qdk.
|
|
2
|
+
uid: Qdk.Std.Arrays.Rest
|
|
3
3
|
title: Rest function
|
|
4
|
-
ms.date: 09/
|
|
4
|
+
ms.date: 09/25/2024 12:00:00 AM
|
|
5
5
|
ms.topic: managed-reference
|
|
6
6
|
qsharp.kind: function
|
|
7
|
-
qsharp.namespace:
|
|
7
|
+
qsharp.namespace: Std.Arrays
|
|
8
8
|
qsharp.name: Rest
|
|
9
|
-
qsharp.summary: "Creates an array that is equal to an input array except that the first array element is dropped."
|
|
9
|
+
qsharp.summary: "Creates an array that is equal to an input array except that the first array element is dropped. # Type Parameters ## 'T The type of the array elements. # Input ## array An array whose second to last elements are to form the output array. # Output An array containing the elements `array[1..Length(array) - 1]`."
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
# Rest function
|
|
13
13
|
|
|
14
|
-
Fully qualified name:
|
|
14
|
+
Fully qualified name: Std.Arrays.Rest
|
|
15
15
|
|
|
16
16
|
```qsharp
|
|
17
17
|
function Rest<'T>(array : 'T[]) : 'T[]
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
## Summary
|
|
21
20
|
Creates an array that is equal to an input array except that the first array
|
|
22
21
|
element is dropped.
|
|
23
22
|
|