qsharp-lang 1.9.2-dev → 1.9.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.
Files changed (268) hide show
  1. package/dist/katas-content.generated.js +4 -4
  2. package/dist/katas-content.generated.md.js +4 -4
  3. package/docs/Microsoft.Quantum.Core/Length.md +1 -1
  4. package/docs/Microsoft.Quantum.Core/Repeated.md +1 -1
  5. package/docs/Microsoft.Quantum.Unstable.Arithmetic/AddLE.md +1 -1
  6. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfEqualL.md +1 -1
  7. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfEqualLE.md +1 -1
  8. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterL.md +1 -1
  9. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterLE.md +1 -1
  10. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterOrEqualL.md +1 -1
  11. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterOrEqualLE.md +1 -1
  12. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessL.md +1 -1
  13. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessLE.md +1 -1
  14. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessOrEqualL.md +1 -1
  15. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessOrEqualLE.md +1 -1
  16. package/docs/Microsoft.Quantum.Unstable.Arithmetic/FourierTDIncByLE.md +1 -1
  17. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByI.md +1 -1
  18. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByIUsingIncByLE.md +1 -1
  19. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByL.md +1 -1
  20. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByLE.md +1 -1
  21. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByLEUsingAddLE.md +1 -1
  22. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByLUsingIncByLE.md +1 -1
  23. package/docs/Microsoft.Quantum.Unstable.Arithmetic/LookAheadDKRSAddLE.md +1 -1
  24. package/docs/Microsoft.Quantum.Unstable.Arithmetic/MAJ.md +1 -1
  25. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ReflectAboutInteger.md +1 -1
  26. package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryCGAddLE.md +1 -1
  27. package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryCGIncByLE.md +1 -1
  28. package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryTTKIncByLE.md +1 -1
  29. package/docs/Microsoft.Quantum.Unstable.StatePreparation/ApproximatelyPreparePureStateCP.md +1 -1
  30. package/docs/Microsoft.Quantum.Unstable.StatePreparation/PreparePureStateD.md +1 -1
  31. package/docs/Microsoft.Quantum.Unstable.TableLookup/Select.md +1 -1
  32. package/docs/Std.Arrays/All.md +1 -1
  33. package/docs/Std.Arrays/Any.md +3 -2
  34. package/docs/Std.Arrays/Chunks.md +3 -2
  35. package/docs/Std.Arrays/CircularlyShifted.md +3 -2
  36. package/docs/Std.Arrays/ColumnAt.md +3 -2
  37. package/docs/Std.Arrays/Count.md +3 -2
  38. package/docs/Std.Arrays/Diagonal.md +3 -2
  39. package/docs/Std.Arrays/DrawMany.md +3 -2
  40. package/docs/Std.Arrays/Enumerated.md +3 -2
  41. package/docs/Std.Arrays/Excluding.md +3 -2
  42. package/docs/Std.Arrays/Filtered.md +3 -2
  43. package/docs/Std.Arrays/FlatMapped.md +3 -2
  44. package/docs/Std.Arrays/Flattened.md +3 -2
  45. package/docs/Std.Arrays/Fold.md +3 -2
  46. package/docs/Std.Arrays/ForEach.md +3 -2
  47. package/docs/Std.Arrays/Head.md +3 -2
  48. package/docs/Std.Arrays/HeadAndRest.md +3 -2
  49. package/docs/Std.Arrays/IndexOf.md +3 -2
  50. package/docs/Std.Arrays/IndexRange.md +3 -2
  51. package/docs/Std.Arrays/Interleaved.md +3 -2
  52. package/docs/Std.Arrays/IsEmpty.md +3 -2
  53. package/docs/Std.Arrays/IsRectangularArray.md +3 -2
  54. package/docs/Std.Arrays/IsSorted.md +3 -2
  55. package/docs/Std.Arrays/IsSquareArray.md +3 -2
  56. package/docs/Std.Arrays/Mapped.md +3 -2
  57. package/docs/Std.Arrays/MappedByIndex.md +3 -2
  58. package/docs/Std.Arrays/MappedOverRange.md +3 -2
  59. package/docs/Std.Arrays/Most.md +3 -2
  60. package/docs/Std.Arrays/MostAndTail.md +3 -2
  61. package/docs/Std.Arrays/Padded.md +3 -2
  62. package/docs/Std.Arrays/Partitioned.md +3 -2
  63. package/docs/Std.Arrays/Rest.md +3 -2
  64. package/docs/Std.Arrays/Reversed.md +3 -2
  65. package/docs/Std.Arrays/SequenceI.md +3 -2
  66. package/docs/Std.Arrays/SequenceL.md +3 -2
  67. package/docs/Std.Arrays/Sorted.md +3 -2
  68. package/docs/Std.Arrays/Subarray.md +3 -2
  69. package/docs/Std.Arrays/Swapped.md +3 -2
  70. package/docs/Std.Arrays/Tail.md +3 -2
  71. package/docs/Std.Arrays/Transposed.md +3 -2
  72. package/docs/Std.Arrays/Unzipped.md +3 -2
  73. package/docs/Std.Arrays/Where.md +3 -2
  74. package/docs/Std.Arrays/Windows.md +3 -2
  75. package/docs/Std.Arrays/Zipped.md +3 -2
  76. package/docs/Std.Canon/ApplyCNOTChain.md +1 -1
  77. package/docs/Std.Canon/ApplyControlledOnBitString.md +1 -1
  78. package/docs/Std.Canon/ApplyControlledOnInt.md +1 -1
  79. package/docs/Std.Canon/ApplyP.md +1 -1
  80. package/docs/Std.Canon/ApplyPauli.md +1 -1
  81. package/docs/Std.Canon/ApplyPauliFromBitString.md +1 -1
  82. package/docs/Std.Canon/ApplyPauliFromInt.md +1 -1
  83. package/docs/Std.Canon/ApplyQFT.md +1 -1
  84. package/docs/Std.Canon/ApplyToEach.md +1 -1
  85. package/docs/Std.Canon/ApplyToEachA.md +1 -1
  86. package/docs/Std.Canon/ApplyToEachC.md +1 -1
  87. package/docs/Std.Canon/ApplyToEachCA.md +1 -1
  88. package/docs/Std.Canon/ApplyXorInPlace.md +1 -1
  89. package/docs/Std.Canon/ApplyXorInPlaceL.md +1 -1
  90. package/docs/Std.Canon/CX.md +1 -1
  91. package/docs/Std.Canon/CY.md +1 -1
  92. package/docs/Std.Canon/CZ.md +1 -1
  93. package/docs/Std.Canon/Fst.md +1 -1
  94. package/docs/Std.Canon/Relabel.md +1 -1
  95. package/docs/Std.Canon/Snd.md +1 -1
  96. package/docs/Std.Canon/SwapReverseRegister.md +1 -1
  97. package/docs/Std.Convert/BigIntAsBoolArray.md +3 -2
  98. package/docs/Std.Convert/BoolArrayAsBigInt.md +3 -2
  99. package/docs/Std.Convert/BoolArrayAsInt.md +3 -2
  100. package/docs/Std.Convert/BoolArrayAsResultArray.md +3 -2
  101. package/docs/Std.Convert/BoolAsResult.md +3 -2
  102. package/docs/Std.Convert/ComplexAsComplexPolar.md +3 -2
  103. package/docs/Std.Convert/ComplexPolarAsComplex.md +3 -2
  104. package/docs/Std.Convert/DoubleAsStringWithPrecision.md +3 -2
  105. package/docs/Std.Convert/IntAsBigInt.md +2 -1
  106. package/docs/Std.Convert/IntAsBoolArray.md +3 -2
  107. package/docs/Std.Convert/IntAsDouble.md +1 -1
  108. package/docs/Std.Convert/ResultArrayAsBoolArray.md +3 -2
  109. package/docs/Std.Convert/ResultArrayAsInt.md +3 -2
  110. package/docs/Std.Convert/ResultAsBool.md +3 -2
  111. package/docs/Std.Core/Length.md +1 -1
  112. package/docs/Std.Core/Repeated.md +1 -1
  113. package/docs/Std.Diagnostics/DumpMachine.md +1 -1
  114. package/docs/Std.Diagnostics/DumpOperation.md +1 -1
  115. package/docs/Std.Diagnostics/DumpRegister.md +3 -2
  116. package/docs/Std.Diagnostics/Fact.md +3 -2
  117. package/docs/Std.Intrinsic/AND.md +3 -2
  118. package/docs/Std.Intrinsic/CCNOT.md +3 -2
  119. package/docs/Std.Intrinsic/CNOT.md +3 -2
  120. package/docs/Std.Intrinsic/Exp.md +3 -2
  121. package/docs/Std.Intrinsic/H.md +3 -2
  122. package/docs/Std.Intrinsic/I.md +3 -2
  123. package/docs/Std.Intrinsic/M.md +3 -2
  124. package/docs/Std.Intrinsic/Measure.md +3 -2
  125. package/docs/Std.Intrinsic/Message.md +3 -2
  126. package/docs/Std.Intrinsic/R.md +3 -2
  127. package/docs/Std.Intrinsic/R1.md +3 -2
  128. package/docs/Std.Intrinsic/R1Frac.md +3 -2
  129. package/docs/Std.Intrinsic/RFrac.md +3 -2
  130. package/docs/Std.Intrinsic/Reset.md +3 -2
  131. package/docs/Std.Intrinsic/ResetAll.md +3 -2
  132. package/docs/Std.Intrinsic/Rx.md +3 -2
  133. package/docs/Std.Intrinsic/Rxx.md +3 -2
  134. package/docs/Std.Intrinsic/Ry.md +3 -2
  135. package/docs/Std.Intrinsic/Ryy.md +3 -2
  136. package/docs/Std.Intrinsic/Rz.md +3 -2
  137. package/docs/Std.Intrinsic/Rzz.md +3 -2
  138. package/docs/Std.Intrinsic/S.md +3 -2
  139. package/docs/Std.Intrinsic/SWAP.md +3 -2
  140. package/docs/Std.Intrinsic/T.md +3 -2
  141. package/docs/Std.Intrinsic/X.md +3 -2
  142. package/docs/Std.Intrinsic/Y.md +3 -2
  143. package/docs/Std.Intrinsic/Z.md +3 -2
  144. package/docs/Std.Logical/Xor.md +1 -1
  145. package/docs/Std.Math/AbsComplex.md +3 -2
  146. package/docs/Std.Math/AbsComplexPolar.md +3 -2
  147. package/docs/Std.Math/AbsD.md +2 -1
  148. package/docs/Std.Math/AbsI.md +2 -1
  149. package/docs/Std.Math/AbsL.md +1 -1
  150. package/docs/Std.Math/AbsSquaredComplex.md +3 -2
  151. package/docs/Std.Math/AbsSquaredComplexPolar.md +3 -2
  152. package/docs/Std.Math/ApproximateFactorial.md +3 -2
  153. package/docs/Std.Math/ArcCos.md +1 -1
  154. package/docs/Std.Math/ArcCosh.md +2 -1
  155. package/docs/Std.Math/ArcSin.md +2 -1
  156. package/docs/Std.Math/ArcSinh.md +2 -1
  157. package/docs/Std.Math/ArcTan.md +2 -1
  158. package/docs/Std.Math/ArcTan2.md +2 -1
  159. package/docs/Std.Math/ArcTanh.md +2 -1
  160. package/docs/Std.Math/ArgComplex.md +3 -2
  161. package/docs/Std.Math/ArgComplexPolar.md +3 -2
  162. package/docs/Std.Math/Binom.md +3 -2
  163. package/docs/Std.Math/BitSizeI.md +1 -1
  164. package/docs/Std.Math/BitSizeL.md +2 -1
  165. package/docs/Std.Math/Ceiling.md +2 -1
  166. package/docs/Std.Math/Complex.md +1 -1
  167. package/docs/Std.Math/ComplexPolar.md +3 -2
  168. package/docs/Std.Math/ContinuedFractionConvergentI.md +2 -1
  169. package/docs/Std.Math/ContinuedFractionConvergentL.md +2 -1
  170. package/docs/Std.Math/Cos.md +2 -1
  171. package/docs/Std.Math/Cosh.md +2 -1
  172. package/docs/Std.Math/DivRemI.md +1 -1
  173. package/docs/Std.Math/DivRemL.md +2 -1
  174. package/docs/Std.Math/DividedByC.md +3 -2
  175. package/docs/Std.Math/DividedByCP.md +3 -2
  176. package/docs/Std.Math/E.md +3 -2
  177. package/docs/Std.Math/ExpModI.md +2 -1
  178. package/docs/Std.Math/ExpModL.md +2 -1
  179. package/docs/Std.Math/ExtendedGreatestCommonDivisorI.md +2 -1
  180. package/docs/Std.Math/ExtendedGreatestCommonDivisorL.md +2 -1
  181. package/docs/Std.Math/FactorialI.md +1 -1
  182. package/docs/Std.Math/FactorialL.md +3 -2
  183. package/docs/Std.Math/Floor.md +2 -1
  184. package/docs/Std.Math/GreatestCommonDivisorI.md +1 -1
  185. package/docs/Std.Math/GreatestCommonDivisorL.md +2 -1
  186. package/docs/Std.Math/HammingWeightI.md +2 -1
  187. package/docs/Std.Math/InverseModI.md +3 -2
  188. package/docs/Std.Math/InverseModL.md +3 -2
  189. package/docs/Std.Math/IsCoprimeI.md +3 -2
  190. package/docs/Std.Math/IsCoprimeL.md +3 -2
  191. package/docs/Std.Math/IsInfinite.md +3 -2
  192. package/docs/Std.Math/IsNaN.md +1 -1
  193. package/docs/Std.Math/LargestFixedPoint.md +3 -2
  194. package/docs/Std.Math/Lg.md +2 -1
  195. package/docs/Std.Math/Log.md +2 -1
  196. package/docs/Std.Math/Log10.md +2 -1
  197. package/docs/Std.Math/LogFactorialD.md +3 -2
  198. package/docs/Std.Math/LogGammaD.md +3 -2
  199. package/docs/Std.Math/LogOf2.md +3 -2
  200. package/docs/Std.Math/Max.md +3 -2
  201. package/docs/Std.Math/MaxD.md +2 -1
  202. package/docs/Std.Math/MaxI.md +2 -1
  203. package/docs/Std.Math/MaxL.md +2 -1
  204. package/docs/Std.Math/Min.md +3 -2
  205. package/docs/Std.Math/MinD.md +2 -1
  206. package/docs/Std.Math/MinI.md +2 -1
  207. package/docs/Std.Math/MinL.md +2 -1
  208. package/docs/Std.Math/MinusC.md +3 -2
  209. package/docs/Std.Math/MinusCP.md +3 -2
  210. package/docs/Std.Math/ModulusI.md +2 -1
  211. package/docs/Std.Math/ModulusL.md +2 -1
  212. package/docs/Std.Math/NegationC.md +3 -2
  213. package/docs/Std.Math/NegationCP.md +3 -2
  214. package/docs/Std.Math/PI.md +1 -1
  215. package/docs/Std.Math/PNorm.md +3 -2
  216. package/docs/Std.Math/PNormalized.md +3 -2
  217. package/docs/Std.Math/PlusC.md +3 -2
  218. package/docs/Std.Math/PlusCP.md +3 -2
  219. package/docs/Std.Math/PowC.md +3 -2
  220. package/docs/Std.Math/PowCP.md +3 -2
  221. package/docs/Std.Math/RealMod.md +3 -2
  222. package/docs/Std.Math/Round.md +2 -1
  223. package/docs/Std.Math/SignD.md +2 -1
  224. package/docs/Std.Math/SignI.md +1 -1
  225. package/docs/Std.Math/SignL.md +2 -1
  226. package/docs/Std.Math/Sin.md +2 -1
  227. package/docs/Std.Math/Sinh.md +2 -1
  228. package/docs/Std.Math/SmallestFixedPoint.md +1 -1
  229. package/docs/Std.Math/Sqrt.md +1 -1
  230. package/docs/Std.Math/SquaredNorm.md +1 -1
  231. package/docs/Std.Math/Tan.md +2 -1
  232. package/docs/Std.Math/Tanh.md +2 -1
  233. package/docs/Std.Math/TimesC.md +3 -2
  234. package/docs/Std.Math/TimesCP.md +3 -2
  235. package/docs/Std.Math/TrailingZeroCountI.md +2 -1
  236. package/docs/Std.Math/TrailingZeroCountL.md +2 -1
  237. package/docs/Std.Math/Truncate.md +1 -1
  238. package/docs/Std.Measurement/MResetEachZ.md +3 -2
  239. package/docs/Std.Measurement/MResetX.md +3 -2
  240. package/docs/Std.Measurement/MResetY.md +3 -2
  241. package/docs/Std.Measurement/MResetZ.md +3 -2
  242. package/docs/Std.Measurement/MeasureAllZ.md +1 -1
  243. package/docs/Std.Measurement/MeasureEachZ.md +3 -2
  244. package/docs/Std.Measurement/MeasureInteger.md +3 -2
  245. package/docs/Std.Range/IsRangeEmpty.md +1 -1
  246. package/docs/Std.Range/RangeEnd.md +1 -1
  247. package/docs/Std.Range/RangeReverse.md +1 -1
  248. package/docs/Std.Range/RangeStart.md +1 -1
  249. package/docs/Std.Range/RangeStep.md +1 -1
  250. package/docs/Std.ResourceEstimation/AccountForEstimates.md +3 -2
  251. package/docs/Std.ResourceEstimation/AuxQubitCount.md +1 -1
  252. package/docs/Std.ResourceEstimation/BeginEstimateCaching.md +3 -2
  253. package/docs/Std.ResourceEstimation/BeginRepeatEstimates.md +3 -2
  254. package/docs/Std.ResourceEstimation/CczCount.md +2 -1
  255. package/docs/Std.ResourceEstimation/EndEstimateCaching.md +2 -1
  256. package/docs/Std.ResourceEstimation/EndRepeatEstimates.md +2 -1
  257. package/docs/Std.ResourceEstimation/MeasurementCount.md +2 -1
  258. package/docs/Std.ResourceEstimation/PSSPCLayout.md +2 -1
  259. package/docs/Std.ResourceEstimation/RepeatEstimates.md +3 -2
  260. package/docs/Std.ResourceEstimation/RotationCount.md +2 -1
  261. package/docs/Std.ResourceEstimation/RotationDepth.md +2 -1
  262. package/docs/Std.ResourceEstimation/SingleVariant.md +1 -1
  263. package/docs/Std.ResourceEstimation/TCount.md +2 -1
  264. package/lib/node/qsc_wasm.cjs +1 -1
  265. package/lib/node/qsc_wasm_bg.wasm +0 -0
  266. package/lib/web/qsc_wasm.js +1 -1
  267. package/lib/web/qsc_wasm_bg.wasm +0 -0
  268. package/package.json +1 -1
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Swapped
3
3
  title: Swapped function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Arrays
8
8
  qsharp.name: Swapped
9
- qsharp.summary: "Applies a swap of two elements in an array. # Input ## firstIndex Index of the first element to be swapped. ## secondIndex Index of the second element to be swapped. ## array Array with elements to be swapped. # Output The array with the in place swap applied. # Example ```qsharp // The following returns [0, 3, 2, 1, 4] Swapped(1, 3, [0, 1, 2, 3, 4]); ```"
9
+ qsharp.summary: "Applies a swap of two elements in an array."
10
10
  ---
11
11
 
12
12
  # Swapped function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Swapped
17
17
  function Swapped<'T>(firstIndex : Int, secondIndex : Int, array : 'T[]) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies a swap of two elements in an array.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Tail
3
3
  title: Tail function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Arrays
8
8
  qsharp.name: Tail
9
- qsharp.summary: "Returns the last element of the array. # Type Parameters ## 'A The type of the array elements. # Input ## array Array of which the last element is taken. Array must have at least 1 element. # Output The last element of the array."
9
+ qsharp.summary: "Returns the last element of the array."
10
10
  ---
11
11
 
12
12
  # Tail function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Tail
17
17
  function Tail<'A>(array : 'A[]) : 'A
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns the last element of the array.
21
22
 
22
23
  ## Type Parameters
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Transposed
3
3
  title: Transposed function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Arrays
8
8
  qsharp.name: Transposed
9
- qsharp.summary: "Returns the transpose of a matrix represented as an array of arrays. # Description Input as an r x c matrix with r rows and c columns. The matrix is row-based, i.e., `matrix[i][j]` accesses the element at row `i` and column `j`. This function returns the c x r matrix that is the transpose of the input matrix. # Type Parameters ## 'T The type of each element of `matrix`. # Input ## matrix Row-based r x c matrix. # Output Transposed c x r matrix. # Example ```qsharp // same as [[1, 4], [2, 5], [3, 6]] let transposed = Transposed([[1, 2, 3], [4, 5, 6]]); ```"
9
+ qsharp.summary: "Returns the transpose of a matrix represented as an array of arrays."
10
10
  ---
11
11
 
12
12
  # Transposed function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Transposed
17
17
  function Transposed<'T>(matrix : 'T[][]) : 'T[][]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns the transpose of a matrix represented as an array
21
22
  of arrays.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Unzipped
3
3
  title: Unzipped function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Arrays
8
8
  qsharp.name: Unzipped
9
- qsharp.summary: "Given an array of 2-tuples, returns a tuple of two arrays, each containing the elements of the tuples of the input array. # Type Parameters ## 'T The type of the first element in each tuple. ## 'U The type of the second element in each tuple. # Input ## array An array containing 2-tuples. # Output Two arrays, the first one containing all first elements of the input tuples, the second one containing all second elements of the input tuples. # Example ```qsharp // split is same as ([5, 4, 3, 2, 1], [true, false, true, true, false]) let split = Unzipped([(5, true), (4, false), (3, true), (2, true), (1, false)]); ``` # See Also - Microsoft.Quantum.Arrays.Zipped"
9
+ qsharp.summary: "Given an array of 2-tuples, returns a tuple of two arrays, each containing the elements of the tuples of the input array."
10
10
  ---
11
11
 
12
12
  # Unzipped function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Unzipped
17
17
  function Unzipped<'T, 'U>(array : ('T, 'U)[]) : ('T[], 'U[])
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array of 2-tuples, returns a tuple of two arrays, each containing
21
22
  the elements of the tuples of the input array.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Where
3
3
  title: Where function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Arrays
8
8
  qsharp.name: Where
9
- qsharp.summary: "Given a predicate and an array, returns the indices of that array where the predicate is true. # Type Parameters ## 'T The type of `array` elements. # Input ## predicate A function from `'T` to Boolean that is used to filter elements. ## array An array of elements over `'T`. # Output An array of indices where `predicate` is true."
9
+ qsharp.summary: "Given a predicate and an array, returns the indices of that array where the predicate is true."
10
10
  ---
11
11
 
12
12
  # Where function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Where
17
17
  function Where<'T>(predicate : ('T -> Bool), array : 'T[]) : Int[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given a predicate and an array, returns the indices of that
21
22
  array where the predicate is true.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Windows
3
3
  title: Windows function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Arrays
8
8
  qsharp.name: Windows
9
- qsharp.summary: "Returns all consecutive subarrays of length `size`. # Description This function returns all `n - size + 1` subarrays of length `size` in order, where `n` is the length of `array`. The first subarrays are `array[0..size - 1], array[1..size], array[2..size + 1]` until the last subarray `array[n - size..n - 1]`. # Type Parameters ## 'T The type of `array` elements. # Input ## size Length of the subarrays. ## array An array of elements. # Example ```qsharp // same as [[1, 2, 3], [2, 3, 4], [3, 4, 5]] let windows = Windows(3, [1, 2, 3, 4, 5]); ``` # Remarks The size of the window must be a positive integer no greater than the size of the array"
9
+ qsharp.summary: "Returns all consecutive subarrays of length `size`."
10
10
  ---
11
11
 
12
12
  # Windows function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Windows
17
17
  function Windows<'T>(size : Int, array : 'T[]) : 'T[][]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns all consecutive subarrays of length `size`.
21
22
 
22
23
  ## Description
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Zipped
3
3
  title: Zipped function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Arrays
8
8
  qsharp.name: Zipped
9
- qsharp.summary: "Given two arrays, returns a new array of pairs such that each pair contains an element from each original array. # Type Parameters ## 'T The type of the left array elements. ## 'U The type of the right array elements. # Input ## left An array containing values for the first element of each tuple. ## right An array containing values for the second element of each tuple. # Output An array containing pairs of the form `(left[index], right[index])` for each `index`. If the two arrays are not of equal length, the output will be as long as the shorter of the inputs. # Example ```qsharp let left = [1, 3, 71]; let right = [false, true]; let pairs = Zipped(left, right); // [(1, false), (3, true)] ``` # See Also - Microsoft.Quantum.Arrays.Unzipped"
9
+ qsharp.summary: "Given two arrays, returns a new array of pairs such that each pair contains an element from each original array."
10
10
  ---
11
11
 
12
12
  # Zipped function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Zipped
17
17
  function Zipped<'T, 'U>(left : 'T[], right : 'U[]) : ('T, 'U)[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given two arrays, returns a new array of pairs such that each pair
21
22
  contains an element from each original array.
22
23
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyCNOTChain
3
3
  title: ApplyCNOTChain operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyControlledOnBitString
3
3
  title: ApplyControlledOnBitString operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyControlledOnInt
3
3
  title: ApplyControlledOnInt operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyP
3
3
  title: ApplyP operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyPauli
3
3
  title: ApplyPauli operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyPauliFromBitString
3
3
  title: ApplyPauliFromBitString operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyPauliFromInt
3
3
  title: ApplyPauliFromInt operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyQFT
3
3
  title: ApplyQFT operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyToEach
3
3
  title: ApplyToEach operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyToEachA
3
3
  title: ApplyToEachA operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyToEachC
3
3
  title: ApplyToEachC operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyToEachCA
3
3
  title: ApplyToEachCA operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyXorInPlace
3
3
  title: ApplyXorInPlace operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.ApplyXorInPlaceL
3
3
  title: ApplyXorInPlaceL operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.CX
3
3
  title: CX operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.CY
3
3
  title: CY operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.CZ
3
3
  title: CZ operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.Fst
3
3
  title: Fst function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.Relabel
3
3
  title: Relabel operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.Snd
3
3
  title: Snd function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Canon
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Canon.SwapReverseRegister
3
3
  title: SwapReverseRegister operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
7
  qsharp.namespace: Std.Canon
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.BigIntAsBoolArray
3
3
  title: BigIntAsBoolArray function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: BigIntAsBoolArray
9
- qsharp.summary: "Produces a binary representation of a non-negative BigInt, using the little-endian representation for the returned array. # Input ## number A non-negative BigInt to be converted to an array of Boolean values. ## bits The number of bits in the binary representation of `number`. # Output An array of Boolean values representing `number`. # Remarks The input `bits` must be non-negative. The input `number` must be between 0 and 2^bits - 1."
9
+ qsharp.summary: "Produces a binary representation of a non-negative BigInt, using the little-endian representation for the returned array."
10
10
  ---
11
11
 
12
12
  # BigIntAsBoolArray function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.BigIntAsBoolArray
17
17
  function BigIntAsBoolArray(number : BigInt, bits : Int) : Bool[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Produces a binary representation of a non-negative BigInt, using the
21
22
  little-endian representation for the returned array.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.BoolArrayAsBigInt
3
3
  title: BoolArrayAsBigInt function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: BoolArrayAsBigInt
9
- qsharp.summary: "Converts an array of Boolean values into a non-negative BigInt, interpreting the array as a binary representation in little-endian format. # Input ## boolArray An array of Boolean values representing the binary digits of a BigInt. # Output A BigInt represented by `boolArray`. # Remarks The function interprets the array in little-endian format, where the first element of the array represents the least significant bit. The input `boolArray` should not be empty."
9
+ qsharp.summary: "Converts an array of Boolean values into a non-negative BigInt, interpreting the array as a binary representation in little-endian format."
10
10
  ---
11
11
 
12
12
  # BoolArrayAsBigInt function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.BoolArrayAsBigInt
17
17
  function BoolArrayAsBigInt(boolArray : Bool[]) : BigInt
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Converts an array of Boolean values into a non-negative BigInt, interpreting the
21
22
  array as a binary representation in little-endian format.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.BoolArrayAsInt
3
3
  title: BoolArrayAsInt function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: BoolArrayAsInt
9
- qsharp.summary: "Produces a non-negative integer from a string of bits in little-endian format. `bits[0]` represents the least significant bit. # Input ## bits Bits in binary representation of number."
9
+ qsharp.summary: "Produces a non-negative integer from a string of bits in little-endian format. `bits[0]` represents the least significant bit."
10
10
  ---
11
11
 
12
12
  # BoolArrayAsInt function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.BoolArrayAsInt
17
17
  function BoolArrayAsInt(bits : Bool[]) : Int
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Produces a non-negative integer from a string of bits in little-endian format.
21
22
  `bits[0]` represents the least significant bit.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.BoolArrayAsResultArray
3
3
  title: BoolArrayAsResultArray function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: BoolArrayAsResultArray
9
- qsharp.summary: "Converts a `Bool[]` type to a `Result[]` type, where `true` is mapped to `One` and `false` is mapped to `Zero`. # Input ## input `Bool[]` to be converted. # Output A `Result[]` representing the `input`."
9
+ qsharp.summary: "Converts a `Bool[]` type to a `Result[]` type, where `true` is mapped to `One` and `false` is mapped to `Zero`."
10
10
  ---
11
11
 
12
12
  # BoolArrayAsResultArray function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.BoolArrayAsResultArray
17
17
  function BoolArrayAsResultArray(input : Bool[]) : Result[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Converts a `Bool[]` type to a `Result[]` type, where `true`
21
22
  is mapped to `One` and `false` is mapped to `Zero`.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.BoolAsResult
3
3
  title: BoolAsResult function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: BoolAsResult
9
- qsharp.summary: "Converts a `Bool` type to a `Result` type, where `true` is mapped to `One` and `false` is mapped to `Zero`. # Input ## input `Bool` to be converted. # Output A `Result` representing the `input`."
9
+ qsharp.summary: "Converts a `Bool` type to a `Result` type, where `true` is mapped to `One` and `false` is mapped to `Zero`."
10
10
  ---
11
11
 
12
12
  # BoolAsResult function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.BoolAsResult
17
17
  function BoolAsResult(input : Bool) : Result
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Converts a `Bool` type to a `Result` type, where `true` is mapped to
21
22
  `One` and `false` is mapped to `Zero`.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.ComplexAsComplexPolar
3
3
  title: ComplexAsComplexPolar function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: ComplexAsComplexPolar
9
- qsharp.summary: "Converts a complex number of type `Complex` to a complex number of type `ComplexPolar`. # Input ## input Complex number c = x + y𝑖. # Output Complex number c = r⋅e^(t𝑖)."
9
+ qsharp.summary: "Converts a complex number of type `Complex` to a complex number of type `ComplexPolar`."
10
10
  ---
11
11
 
12
12
  # ComplexAsComplexPolar function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.ComplexAsComplexPolar
17
17
  function ComplexAsComplexPolar(input : Complex) : ComplexPolar
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Converts a complex number of type `Complex` to a complex
21
22
  number of type `ComplexPolar`.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.ComplexPolarAsComplex
3
3
  title: ComplexPolarAsComplex function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: ComplexPolarAsComplex
9
- qsharp.summary: "Converts a complex number of type `ComplexPolar` to a complex number of type `Complex`. # Input ## input Complex number c = r⋅e^(t𝑖). # Output Complex number c = x + y𝑖."
9
+ qsharp.summary: "Converts a complex number of type `ComplexPolar` to a complex number of type `Complex`."
10
10
  ---
11
11
 
12
12
  # ComplexPolarAsComplex function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.ComplexPolarAsComplex
17
17
  function ComplexPolarAsComplex(input : ComplexPolar) : Complex
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Converts a complex number of type `ComplexPolar` to a complex
21
22
  number of type `Complex`.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.DoubleAsStringWithPrecision
3
3
  title: DoubleAsStringWithPrecision function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: DoubleAsStringWithPrecision
9
- qsharp.summary: "Converts a given double-precision floating-point number to a string representation with desired precision, rounding if required. # Input ## input Double to be converted. ## precision Non-negative number of digits after the decimal point. # Example ```qsharp Message($"{DoubleAsStringWithPrecision(0.354, 2)}"); // Prints 0.35 Message($"{DoubleAsStringWithPrecision(0.485, 1)}"); // Prints 0.5 Message($"{DoubleAsStringWithPrecision(5.6, 4)}"); // Prints 5.6000 Message($"{DoubleAsStringWithPrecision(2.268, 0)}"); // Prints 2 ```"
9
+ qsharp.summary: "Converts a given double-precision floating-point number to a string representation with desired precision, rounding if required."
10
10
  ---
11
11
 
12
12
  # DoubleAsStringWithPrecision function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.DoubleAsStringWithPrecision
17
17
  function DoubleAsStringWithPrecision(input : Double, precision : Int) : String
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Converts a given double-precision floating-point number to a string representation with desired precision, rounding if required.
21
22
 
22
23
  ## Input
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.IntAsBigInt
3
3
  title: IntAsBigInt function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
@@ -17,4 +17,5 @@ Fully qualified name: Std.Convert.IntAsBigInt
17
17
  function IntAsBigInt(number : Int) : BigInt
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Converts a given integer `number` to an equivalent big integer.
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.IntAsBoolArray
3
3
  title: IntAsBoolArray function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: IntAsBoolArray
9
- qsharp.summary: "Produces a binary representation of a non-negative integer, using the little-endian representation for the returned array. # Input ## number A non-negative integer to be converted to an array of Boolean values. ## bits The number of bits in the binary representation of `number`. # Output An array of Boolean values representing `number`. # Remarks The input `bits` must be non-negative. The input `number` must be between 0 and 2^bits - 1."
9
+ qsharp.summary: "Produces a binary representation of a non-negative integer, using the little-endian representation for the returned array."
10
10
  ---
11
11
 
12
12
  # IntAsBoolArray function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.IntAsBoolArray
17
17
  function IntAsBoolArray(number : Int, bits : Int) : Bool[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Produces a binary representation of a non-negative integer, using the
21
22
  little-endian representation for the returned array.
22
23
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.IntAsDouble
3
3
  title: IntAsDouble function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.ResultArrayAsBoolArray
3
3
  title: ResultArrayAsBoolArray function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/17/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: function
7
7
  qsharp.namespace: Std.Convert
8
8
  qsharp.name: ResultArrayAsBoolArray
9
- qsharp.summary: "Converts a `Result[]` type to a `Bool[]` type, where `One` is mapped to `true` and `Zero` is mapped to `false`. # Input ## input `Result[]` to be converted. # Output A `Bool[]` representing the `input`."
9
+ qsharp.summary: "Converts a `Result[]` type to a `Bool[]` type, where `One` is mapped to `true` and `Zero` is mapped to `false`."
10
10
  ---
11
11
 
12
12
  # ResultArrayAsBoolArray function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.ResultArrayAsBoolArray
17
17
  function ResultArrayAsBoolArray(input : Result[]) : Bool[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Converts a `Result[]` type to a `Bool[]` type, where `One`
21
22
  is mapped to `true` and `Zero` is mapped to `false`.
22
23