qsharp-lang 1.9.2-dev → 1.9.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.
Files changed (272) hide show
  1. package/dist/compiler/compiler.d.ts +2 -0
  2. package/dist/compiler/compiler.js +4 -0
  3. package/dist/katas-content.generated.js +4 -4
  4. package/dist/katas-content.generated.md.js +4 -4
  5. package/docs/Microsoft.Quantum.Core/Length.md +1 -1
  6. package/docs/Microsoft.Quantum.Core/Repeated.md +1 -1
  7. package/docs/Microsoft.Quantum.Unstable.Arithmetic/AddLE.md +1 -1
  8. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfEqualL.md +1 -1
  9. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfEqualLE.md +1 -1
  10. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterL.md +1 -1
  11. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterLE.md +1 -1
  12. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterOrEqualL.md +1 -1
  13. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfGreaterOrEqualLE.md +1 -1
  14. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessL.md +1 -1
  15. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessLE.md +1 -1
  16. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessOrEqualL.md +1 -1
  17. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ApplyIfLessOrEqualLE.md +1 -1
  18. package/docs/Microsoft.Quantum.Unstable.Arithmetic/FourierTDIncByLE.md +1 -1
  19. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByI.md +1 -1
  20. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByIUsingIncByLE.md +1 -1
  21. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByL.md +1 -1
  22. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByLE.md +1 -1
  23. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByLEUsingAddLE.md +1 -1
  24. package/docs/Microsoft.Quantum.Unstable.Arithmetic/IncByLUsingIncByLE.md +1 -1
  25. package/docs/Microsoft.Quantum.Unstable.Arithmetic/LookAheadDKRSAddLE.md +1 -1
  26. package/docs/Microsoft.Quantum.Unstable.Arithmetic/MAJ.md +1 -1
  27. package/docs/Microsoft.Quantum.Unstable.Arithmetic/ReflectAboutInteger.md +1 -1
  28. package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryCGAddLE.md +1 -1
  29. package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryCGIncByLE.md +1 -1
  30. package/docs/Microsoft.Quantum.Unstable.Arithmetic/RippleCarryTTKIncByLE.md +1 -1
  31. package/docs/Microsoft.Quantum.Unstable.StatePreparation/ApproximatelyPreparePureStateCP.md +1 -1
  32. package/docs/Microsoft.Quantum.Unstable.StatePreparation/PreparePureStateD.md +1 -1
  33. package/docs/Microsoft.Quantum.Unstable.TableLookup/Select.md +1 -1
  34. package/docs/Std.Arrays/All.md +1 -1
  35. package/docs/Std.Arrays/Any.md +3 -2
  36. package/docs/Std.Arrays/Chunks.md +3 -2
  37. package/docs/Std.Arrays/CircularlyShifted.md +3 -2
  38. package/docs/Std.Arrays/ColumnAt.md +3 -2
  39. package/docs/Std.Arrays/Count.md +3 -2
  40. package/docs/Std.Arrays/Diagonal.md +3 -2
  41. package/docs/Std.Arrays/DrawMany.md +3 -2
  42. package/docs/Std.Arrays/Enumerated.md +3 -2
  43. package/docs/Std.Arrays/Excluding.md +3 -2
  44. package/docs/Std.Arrays/Filtered.md +3 -2
  45. package/docs/Std.Arrays/FlatMapped.md +3 -2
  46. package/docs/Std.Arrays/Flattened.md +3 -2
  47. package/docs/Std.Arrays/Fold.md +3 -2
  48. package/docs/Std.Arrays/ForEach.md +3 -2
  49. package/docs/Std.Arrays/Head.md +3 -2
  50. package/docs/Std.Arrays/HeadAndRest.md +3 -2
  51. package/docs/Std.Arrays/IndexOf.md +3 -2
  52. package/docs/Std.Arrays/IndexRange.md +3 -2
  53. package/docs/Std.Arrays/Interleaved.md +3 -2
  54. package/docs/Std.Arrays/IsEmpty.md +3 -2
  55. package/docs/Std.Arrays/IsRectangularArray.md +3 -2
  56. package/docs/Std.Arrays/IsSorted.md +3 -2
  57. package/docs/Std.Arrays/IsSquareArray.md +3 -2
  58. package/docs/Std.Arrays/Mapped.md +3 -2
  59. package/docs/Std.Arrays/MappedByIndex.md +3 -2
  60. package/docs/Std.Arrays/MappedOverRange.md +3 -2
  61. package/docs/Std.Arrays/Most.md +3 -2
  62. package/docs/Std.Arrays/MostAndTail.md +3 -2
  63. package/docs/Std.Arrays/Padded.md +3 -2
  64. package/docs/Std.Arrays/Partitioned.md +3 -2
  65. package/docs/Std.Arrays/Rest.md +3 -2
  66. package/docs/Std.Arrays/Reversed.md +3 -2
  67. package/docs/Std.Arrays/SequenceI.md +3 -2
  68. package/docs/Std.Arrays/SequenceL.md +3 -2
  69. package/docs/Std.Arrays/Sorted.md +3 -2
  70. package/docs/Std.Arrays/Subarray.md +3 -2
  71. package/docs/Std.Arrays/Swapped.md +3 -2
  72. package/docs/Std.Arrays/Tail.md +3 -2
  73. package/docs/Std.Arrays/Transposed.md +3 -2
  74. package/docs/Std.Arrays/Unzipped.md +3 -2
  75. package/docs/Std.Arrays/Where.md +3 -2
  76. package/docs/Std.Arrays/Windows.md +3 -2
  77. package/docs/Std.Arrays/Zipped.md +3 -2
  78. package/docs/Std.Canon/ApplyCNOTChain.md +1 -1
  79. package/docs/Std.Canon/ApplyControlledOnBitString.md +1 -1
  80. package/docs/Std.Canon/ApplyControlledOnInt.md +1 -1
  81. package/docs/Std.Canon/ApplyP.md +1 -1
  82. package/docs/Std.Canon/ApplyPauli.md +1 -1
  83. package/docs/Std.Canon/ApplyPauliFromBitString.md +1 -1
  84. package/docs/Std.Canon/ApplyPauliFromInt.md +1 -1
  85. package/docs/Std.Canon/ApplyQFT.md +1 -1
  86. package/docs/Std.Canon/ApplyToEach.md +1 -1
  87. package/docs/Std.Canon/ApplyToEachA.md +1 -1
  88. package/docs/Std.Canon/ApplyToEachC.md +1 -1
  89. package/docs/Std.Canon/ApplyToEachCA.md +1 -1
  90. package/docs/Std.Canon/ApplyXorInPlace.md +1 -1
  91. package/docs/Std.Canon/ApplyXorInPlaceL.md +1 -1
  92. package/docs/Std.Canon/CX.md +1 -1
  93. package/docs/Std.Canon/CY.md +1 -1
  94. package/docs/Std.Canon/CZ.md +1 -1
  95. package/docs/Std.Canon/Fst.md +1 -1
  96. package/docs/Std.Canon/Relabel.md +1 -1
  97. package/docs/Std.Canon/Snd.md +1 -1
  98. package/docs/Std.Canon/SwapReverseRegister.md +1 -1
  99. package/docs/Std.Convert/BigIntAsBoolArray.md +3 -2
  100. package/docs/Std.Convert/BoolArrayAsBigInt.md +3 -2
  101. package/docs/Std.Convert/BoolArrayAsInt.md +3 -2
  102. package/docs/Std.Convert/BoolArrayAsResultArray.md +3 -2
  103. package/docs/Std.Convert/BoolAsResult.md +3 -2
  104. package/docs/Std.Convert/ComplexAsComplexPolar.md +3 -2
  105. package/docs/Std.Convert/ComplexPolarAsComplex.md +3 -2
  106. package/docs/Std.Convert/DoubleAsStringWithPrecision.md +3 -2
  107. package/docs/Std.Convert/IntAsBigInt.md +2 -1
  108. package/docs/Std.Convert/IntAsBoolArray.md +3 -2
  109. package/docs/Std.Convert/IntAsDouble.md +1 -1
  110. package/docs/Std.Convert/ResultArrayAsBoolArray.md +3 -2
  111. package/docs/Std.Convert/ResultArrayAsInt.md +3 -2
  112. package/docs/Std.Convert/ResultAsBool.md +3 -2
  113. package/docs/Std.Core/Length.md +1 -1
  114. package/docs/Std.Core/Repeated.md +1 -1
  115. package/docs/Std.Diagnostics/DumpMachine.md +1 -1
  116. package/docs/Std.Diagnostics/DumpOperation.md +1 -1
  117. package/docs/Std.Diagnostics/DumpRegister.md +3 -2
  118. package/docs/Std.Diagnostics/Fact.md +3 -2
  119. package/docs/Std.Intrinsic/AND.md +3 -2
  120. package/docs/Std.Intrinsic/CCNOT.md +3 -2
  121. package/docs/Std.Intrinsic/CNOT.md +3 -2
  122. package/docs/Std.Intrinsic/Exp.md +3 -2
  123. package/docs/Std.Intrinsic/H.md +3 -2
  124. package/docs/Std.Intrinsic/I.md +3 -2
  125. package/docs/Std.Intrinsic/M.md +3 -2
  126. package/docs/Std.Intrinsic/Measure.md +3 -2
  127. package/docs/Std.Intrinsic/Message.md +3 -2
  128. package/docs/Std.Intrinsic/R.md +3 -2
  129. package/docs/Std.Intrinsic/R1.md +3 -2
  130. package/docs/Std.Intrinsic/R1Frac.md +3 -2
  131. package/docs/Std.Intrinsic/RFrac.md +3 -2
  132. package/docs/Std.Intrinsic/Reset.md +3 -2
  133. package/docs/Std.Intrinsic/ResetAll.md +3 -2
  134. package/docs/Std.Intrinsic/Rx.md +3 -2
  135. package/docs/Std.Intrinsic/Rxx.md +3 -2
  136. package/docs/Std.Intrinsic/Ry.md +3 -2
  137. package/docs/Std.Intrinsic/Ryy.md +3 -2
  138. package/docs/Std.Intrinsic/Rz.md +3 -2
  139. package/docs/Std.Intrinsic/Rzz.md +3 -2
  140. package/docs/Std.Intrinsic/S.md +3 -2
  141. package/docs/Std.Intrinsic/SWAP.md +3 -2
  142. package/docs/Std.Intrinsic/T.md +3 -2
  143. package/docs/Std.Intrinsic/X.md +3 -2
  144. package/docs/Std.Intrinsic/Y.md +3 -2
  145. package/docs/Std.Intrinsic/Z.md +3 -2
  146. package/docs/Std.Logical/Xor.md +1 -1
  147. package/docs/Std.Math/AbsComplex.md +3 -2
  148. package/docs/Std.Math/AbsComplexPolar.md +3 -2
  149. package/docs/Std.Math/AbsD.md +2 -1
  150. package/docs/Std.Math/AbsI.md +2 -1
  151. package/docs/Std.Math/AbsL.md +1 -1
  152. package/docs/Std.Math/AbsSquaredComplex.md +3 -2
  153. package/docs/Std.Math/AbsSquaredComplexPolar.md +3 -2
  154. package/docs/Std.Math/ApproximateFactorial.md +3 -2
  155. package/docs/Std.Math/ArcCos.md +1 -1
  156. package/docs/Std.Math/ArcCosh.md +2 -1
  157. package/docs/Std.Math/ArcSin.md +2 -1
  158. package/docs/Std.Math/ArcSinh.md +2 -1
  159. package/docs/Std.Math/ArcTan.md +2 -1
  160. package/docs/Std.Math/ArcTan2.md +2 -1
  161. package/docs/Std.Math/ArcTanh.md +2 -1
  162. package/docs/Std.Math/ArgComplex.md +3 -2
  163. package/docs/Std.Math/ArgComplexPolar.md +3 -2
  164. package/docs/Std.Math/Binom.md +3 -2
  165. package/docs/Std.Math/BitSizeI.md +1 -1
  166. package/docs/Std.Math/BitSizeL.md +2 -1
  167. package/docs/Std.Math/Ceiling.md +2 -1
  168. package/docs/Std.Math/Complex.md +1 -1
  169. package/docs/Std.Math/ComplexPolar.md +3 -2
  170. package/docs/Std.Math/ContinuedFractionConvergentI.md +2 -1
  171. package/docs/Std.Math/ContinuedFractionConvergentL.md +2 -1
  172. package/docs/Std.Math/Cos.md +2 -1
  173. package/docs/Std.Math/Cosh.md +2 -1
  174. package/docs/Std.Math/DivRemI.md +1 -1
  175. package/docs/Std.Math/DivRemL.md +2 -1
  176. package/docs/Std.Math/DividedByC.md +3 -2
  177. package/docs/Std.Math/DividedByCP.md +3 -2
  178. package/docs/Std.Math/E.md +3 -2
  179. package/docs/Std.Math/ExpModI.md +2 -1
  180. package/docs/Std.Math/ExpModL.md +2 -1
  181. package/docs/Std.Math/ExtendedGreatestCommonDivisorI.md +2 -1
  182. package/docs/Std.Math/ExtendedGreatestCommonDivisorL.md +2 -1
  183. package/docs/Std.Math/FactorialI.md +1 -1
  184. package/docs/Std.Math/FactorialL.md +3 -2
  185. package/docs/Std.Math/Floor.md +2 -1
  186. package/docs/Std.Math/GreatestCommonDivisorI.md +1 -1
  187. package/docs/Std.Math/GreatestCommonDivisorL.md +2 -1
  188. package/docs/Std.Math/HammingWeightI.md +2 -1
  189. package/docs/Std.Math/InverseModI.md +3 -2
  190. package/docs/Std.Math/InverseModL.md +3 -2
  191. package/docs/Std.Math/IsCoprimeI.md +3 -2
  192. package/docs/Std.Math/IsCoprimeL.md +3 -2
  193. package/docs/Std.Math/IsInfinite.md +3 -2
  194. package/docs/Std.Math/IsNaN.md +1 -1
  195. package/docs/Std.Math/LargestFixedPoint.md +3 -2
  196. package/docs/Std.Math/Lg.md +2 -1
  197. package/docs/Std.Math/Log.md +2 -1
  198. package/docs/Std.Math/Log10.md +2 -1
  199. package/docs/Std.Math/LogFactorialD.md +3 -2
  200. package/docs/Std.Math/LogGammaD.md +3 -2
  201. package/docs/Std.Math/LogOf2.md +3 -2
  202. package/docs/Std.Math/Max.md +3 -2
  203. package/docs/Std.Math/MaxD.md +2 -1
  204. package/docs/Std.Math/MaxI.md +2 -1
  205. package/docs/Std.Math/MaxL.md +2 -1
  206. package/docs/Std.Math/Min.md +3 -2
  207. package/docs/Std.Math/MinD.md +2 -1
  208. package/docs/Std.Math/MinI.md +2 -1
  209. package/docs/Std.Math/MinL.md +2 -1
  210. package/docs/Std.Math/MinusC.md +3 -2
  211. package/docs/Std.Math/MinusCP.md +3 -2
  212. package/docs/Std.Math/ModulusI.md +2 -1
  213. package/docs/Std.Math/ModulusL.md +2 -1
  214. package/docs/Std.Math/NegationC.md +3 -2
  215. package/docs/Std.Math/NegationCP.md +3 -2
  216. package/docs/Std.Math/PI.md +1 -1
  217. package/docs/Std.Math/PNorm.md +3 -2
  218. package/docs/Std.Math/PNormalized.md +3 -2
  219. package/docs/Std.Math/PlusC.md +3 -2
  220. package/docs/Std.Math/PlusCP.md +3 -2
  221. package/docs/Std.Math/PowC.md +3 -2
  222. package/docs/Std.Math/PowCP.md +3 -2
  223. package/docs/Std.Math/RealMod.md +3 -2
  224. package/docs/Std.Math/Round.md +2 -1
  225. package/docs/Std.Math/SignD.md +2 -1
  226. package/docs/Std.Math/SignI.md +1 -1
  227. package/docs/Std.Math/SignL.md +2 -1
  228. package/docs/Std.Math/Sin.md +2 -1
  229. package/docs/Std.Math/Sinh.md +2 -1
  230. package/docs/Std.Math/SmallestFixedPoint.md +1 -1
  231. package/docs/Std.Math/Sqrt.md +1 -1
  232. package/docs/Std.Math/SquaredNorm.md +1 -1
  233. package/docs/Std.Math/Tan.md +2 -1
  234. package/docs/Std.Math/Tanh.md +2 -1
  235. package/docs/Std.Math/TimesC.md +3 -2
  236. package/docs/Std.Math/TimesCP.md +3 -2
  237. package/docs/Std.Math/TrailingZeroCountI.md +2 -1
  238. package/docs/Std.Math/TrailingZeroCountL.md +2 -1
  239. package/docs/Std.Math/Truncate.md +1 -1
  240. package/docs/Std.Measurement/MResetEachZ.md +3 -2
  241. package/docs/Std.Measurement/MResetX.md +3 -2
  242. package/docs/Std.Measurement/MResetY.md +3 -2
  243. package/docs/Std.Measurement/MResetZ.md +3 -2
  244. package/docs/Std.Measurement/MeasureAllZ.md +1 -1
  245. package/docs/Std.Measurement/MeasureEachZ.md +3 -2
  246. package/docs/Std.Measurement/MeasureInteger.md +3 -2
  247. package/docs/Std.Range/IsRangeEmpty.md +1 -1
  248. package/docs/Std.Range/RangeEnd.md +1 -1
  249. package/docs/Std.Range/RangeReverse.md +1 -1
  250. package/docs/Std.Range/RangeStart.md +1 -1
  251. package/docs/Std.Range/RangeStep.md +1 -1
  252. package/docs/Std.ResourceEstimation/AccountForEstimates.md +3 -2
  253. package/docs/Std.ResourceEstimation/AuxQubitCount.md +1 -1
  254. package/docs/Std.ResourceEstimation/BeginEstimateCaching.md +3 -2
  255. package/docs/Std.ResourceEstimation/BeginRepeatEstimates.md +3 -2
  256. package/docs/Std.ResourceEstimation/CczCount.md +2 -1
  257. package/docs/Std.ResourceEstimation/EndEstimateCaching.md +2 -1
  258. package/docs/Std.ResourceEstimation/EndRepeatEstimates.md +2 -1
  259. package/docs/Std.ResourceEstimation/MeasurementCount.md +2 -1
  260. package/docs/Std.ResourceEstimation/PSSPCLayout.md +2 -1
  261. package/docs/Std.ResourceEstimation/RepeatEstimates.md +3 -2
  262. package/docs/Std.ResourceEstimation/RotationCount.md +2 -1
  263. package/docs/Std.ResourceEstimation/RotationDepth.md +2 -1
  264. package/docs/Std.ResourceEstimation/SingleVariant.md +1 -1
  265. package/docs/Std.ResourceEstimation/TCount.md +2 -1
  266. package/lib/node/qsc_wasm.cjs +43 -5
  267. package/lib/node/qsc_wasm.d.cts +10 -1
  268. package/lib/node/qsc_wasm_bg.wasm +0 -0
  269. package/lib/web/qsc_wasm.d.ts +11 -1
  270. package/lib/web/qsc_wasm.js +41 -5
  271. package/lib/web/qsc_wasm_bg.wasm +0 -0
  272. package/package.json +1 -1
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Enumerated
3
3
  title: Enumerated function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Enumerated
9
- qsharp.summary: "Given an array, returns a new array containing elements of the original array along with the indices of each element. # Type Parameters ## 'TElement The type of elements of the array. # Input ## array An array whose elements are to be enumerated. # Output A new array containing elements of the original array along with their indices. # Example The following `for` loops are equivalent: ```qsharp for (idx in IndexRange(array)) { let element = array[idx]; ... } for ((idx, element) in Enumerated(array)) { ... } ```"
9
+ qsharp.summary: "Given an array, returns a new array containing elements of the original array along with the indices of each element."
10
10
  ---
11
11
 
12
12
  # Enumerated function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Enumerated
17
17
  function Enumerated<'TElement>(array : 'TElement[]) : (Int, 'TElement)[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array, returns a new array containing elements of the original
21
22
  array along with the indices of each element.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Excluding
3
3
  title: Excluding function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Excluding
9
- qsharp.summary: "Returns an array containing the elements of another array, excluding elements at a given list of indices. # Type Parameters ## 'T The type of the array elements. # Input ## remove An array of indices denoting which elements should be excluded. from the output. ## array Array of which the values in the output array are taken. # Output An array `output` such that `output[0]` is the first element of `array` whose index does not appear in `remove`, such that `output[1]` is the second such element, and so forth. # Example ```qsharp let array = [10, 11, 12, 13, 14, 15]; // The following line returns [10, 12, 15]. let subarray = Excluding([1, 3, 4], array); ```"
9
+ qsharp.summary: "Returns an array containing the elements of another array, excluding elements at a given list of indices."
10
10
  ---
11
11
 
12
12
  # Excluding function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Excluding
17
17
  function Excluding<'T>(remove : Int[], array : 'T[]) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns an array containing the elements of another array,
21
22
  excluding elements at a given list of indices.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Filtered
3
3
  title: Filtered function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Filtered
9
- qsharp.summary: "Given an array and a predicate that is defined for the elements of the array, returns an array that consists of those elements that satisfy the predicate. # 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 `'T[]` of elements that satisfy the predicate. # Example The following code creates an array that contains only even numbers. ```qsharp Filtered(x -> x % 2 == 0, [0, 1, 2, 3, 4]) ```"
9
+ qsharp.summary: "Given an array and a predicate that is defined for the elements of the array, returns an array that consists of those elements that satisfy the predicate."
10
10
  ---
11
11
 
12
12
  # Filtered function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Filtered
17
17
  function Filtered<'T>(predicate : ('T -> Bool), array : 'T[]) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array and a predicate that is defined
21
22
  for the elements of the array, returns an array that consists of
22
23
  those elements that satisfy the predicate.
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.FlatMapped
3
3
  title: FlatMapped function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: 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. # 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]. ```"
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."
10
10
  ---
11
11
 
12
12
  # FlatMapped function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.FlatMapped
17
17
  function FlatMapped<'TInput, 'TOutput>(mapper : ('TInput -> 'TOutput[]), array : 'TInput[]) : 'TOutput[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array and a function that maps an array element to some output
21
22
  array, returns the concatenated output arrays for each array element.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Flattened
3
3
  title: Flattened function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Flattened
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] ```"
9
+ qsharp.summary: "Given an array of arrays, returns the concatenation of all arrays."
10
10
  ---
11
11
 
12
12
  # Flattened function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Flattened
17
17
  function Flattened<'T>(arrays : 'T[][]) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array of arrays, returns the concatenation of all arrays.
21
22
 
22
23
  ## Type Parameters
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Fold
3
3
  title: Fold function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Fold
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. ```"
9
+ qsharp.summary: "Iterates a function `f` through an array `array`, returning `f(...f(f(initialState, array[0]), array[1]), ...)`."
10
10
  ---
11
11
 
12
12
  # Fold function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Fold
17
17
  function Fold<'State, 'T>(folder : (('State, 'T) -> 'State), state : 'State, array : 'T[]) : 'State
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Iterates a function `f` through an array `array`, returning
21
22
  `f(...f(f(initialState, array[0]), array[1]), ...)`.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.ForEach
3
3
  title: ForEach operation
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/2024 12:00:00 AM
5
5
  ms.topic: managed-reference
6
6
  qsharp.kind: operation
7
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. # 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"
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."
10
10
  ---
11
11
 
12
12
  # ForEach operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.ForEach
17
17
  operation ForEach<'T, 'U>(action : ('T => 'U), array : 'T[]) : 'U[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array and an operation that is defined
21
22
  for the elements of the array, returns a new array that consists
22
23
  of the images of the original array under the operation.
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Head
3
3
  title: Head function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Head
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."
9
+ qsharp.summary: "Returns the first element of the array."
10
10
  ---
11
11
 
12
12
  # Head function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Head
17
17
  function Head<'A>(array : 'A[]) : 'A
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns the first element of the array.
21
22
 
22
23
  ## Type Parameters
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.HeadAndRest
3
3
  title: HeadAndRest function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: HeadAndRest
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."
9
+ qsharp.summary: "Returns a tuple of first and all remaining elements of the array."
10
10
  ---
11
11
 
12
12
  # HeadAndRest function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.HeadAndRest
17
17
  function HeadAndRest<'A>(array : 'A[]) : ('A, 'A[])
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns a tuple of first and all remaining elements of the array.
21
22
 
22
23
  ## Type Parameters
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.IndexOf
3
3
  title: IndexOf function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: 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. # 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. ```"
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."
10
10
  ---
11
11
 
12
12
  # IndexOf function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IndexOf
17
17
  function IndexOf<'T>(predicate : ('T -> Bool), array : 'T[]) : Int
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns the first index of the first element in an array that satisfies
21
22
  a given predicate. If no such element exists, returns -1.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.IndexRange
3
3
  title: IndexRange function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: IndexRange
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 { ... } ```"
9
+ qsharp.summary: "Given an array, returns a range over the indices of that array, suitable for use in a for loop."
10
10
  ---
11
11
 
12
12
  # IndexRange function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IndexRange
17
17
  function IndexRange<'TElement>(array : 'TElement[]) : Range
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array, returns a range over the indices of that array, suitable
21
22
  for use in a for loop.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Interleaved
3
3
  title: Interleaved function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Interleaved
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]) ```"
9
+ qsharp.summary: "Interleaves two arrays of (almost) same size."
10
10
  ---
11
11
 
12
12
  # Interleaved function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Interleaved
17
17
  function Interleaved<'T>(first : 'T[], second : 'T[]) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Interleaves two arrays of (almost) same size.
21
22
 
22
23
  ## Description
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.IsEmpty
3
3
  title: IsEmpty function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: IsEmpty
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)."
9
+ qsharp.summary: "Returns true if and only if an array is empty."
10
10
  ---
11
11
 
12
12
  # IsEmpty function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IsEmpty
17
17
  function IsEmpty<'T>(array : 'T[]) : Bool
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns true if and only if an array is empty.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.IsRectangularArray
3
3
  title: IsRectangularArray function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: IsRectangularArray
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"
9
+ qsharp.summary: "Returns whether a 2-dimensional array has a rectangular shape"
10
10
  ---
11
11
 
12
12
  # IsRectangularArray function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IsRectangularArray
17
17
  function IsRectangularArray<'T>(array : 'T[][]) : Bool
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns whether a 2-dimensional array has a rectangular shape
21
22
 
22
23
  ## Type Parameters
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.IsSorted
3
3
  title: IsSorted function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: IsSorted
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."
9
+ qsharp.summary: "Given an array, returns whether that array is sorted as defined by a given comparison function."
10
10
  ---
11
11
 
12
12
  # IsSorted function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IsSorted
17
17
  function IsSorted<'T>(comparison : (('T, 'T) -> Bool), array : 'T[]) : Bool
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array, returns whether that array is sorted as defined by
21
22
  a given comparison function.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.IsSquareArray
3
3
  title: IsSquareArray function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: IsSquareArray
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"
9
+ qsharp.summary: "Returns whether a 2-dimensional array has a square shape"
10
10
  ---
11
11
 
12
12
  # IsSquareArray function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IsSquareArray
17
17
  function IsSquareArray<'T>(array : 'T[][]) : Bool
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns whether a 2-dimensional array has a square shape
21
22
 
22
23
  ## Type Parameters
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Mapped
3
3
  title: Mapped function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: 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. # 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"
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."
10
10
  ---
11
11
 
12
12
  # Mapped function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Mapped
17
17
  function Mapped<'T, 'U>(mapper : ('T -> 'U), array : 'T[]) : 'U[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array and a function that is defined
21
22
  for the elements of the array, returns a new array that consists
22
23
  of the images of the original array under the function.
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.MappedByIndex
3
3
  title: MappedByIndex function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: 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. # 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"
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."
10
10
  ---
11
11
 
12
12
  # MappedByIndex function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.MappedByIndex
17
17
  function MappedByIndex<'T, 'U>(mapper : ((Int, 'T) -> 'U), array : 'T[]) : 'U[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array and a function that is defined
21
22
  for the indexed elements of the array, returns a new array that consists
22
23
  of the images of the original array under the function.
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.MappedOverRange
3
3
  title: MappedOverRange function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: 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. # 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"
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."
10
10
  ---
11
11
 
12
12
  # MappedOverRange function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.MappedOverRange
17
17
  function MappedOverRange<'T>(mapper : (Int -> 'T), range : Range) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given a range and a function that takes an integer as input,
21
22
  returns a new array that consists
22
23
  of the images of the range values under the function.
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Most
3
3
  title: Most function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Most
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]`."
9
+ qsharp.summary: "Creates an array that is equal to an input array except that the last array element is dropped."
10
10
  ---
11
11
 
12
12
  # Most function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Most
17
17
  function Most<'T>(array : 'T[]) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Creates an array that is equal to an input array except that the last array
21
22
  element is dropped.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.MostAndTail
3
3
  title: MostAndTail function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: MostAndTail
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."
9
+ qsharp.summary: "Returns a tuple of all but one and the last element of the array."
10
10
  ---
11
11
 
12
12
  # MostAndTail function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.MostAndTail
17
17
  function MostAndTail<'A>(array : 'A[]) : ('A[], 'A)
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns a tuple of all but one and the last element of the array.
21
22
 
22
23
  ## Type Parameters
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Padded
3
3
  title: Padded function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Padded
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); ```"
9
+ qsharp.summary: "Returns an array padded at with specified values up to a specified length."
10
10
  ---
11
11
 
12
12
  # Padded function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Padded
17
17
  function Padded<'T>(paddedLength : Int, defaultElement : 'T, inputArray : 'T[]) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Returns an array padded at with specified values up to a
21
22
  specified length.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Partitioned
3
3
  title: Partitioned function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Partitioned
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]); ```"
9
+ qsharp.summary: "Splits an array into multiple parts."
10
10
  ---
11
11
 
12
12
  # Partitioned function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Partitioned
17
17
  function Partitioned<'T>(partitionSizes : Int[], array : 'T[]) : 'T[][]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Splits an array into multiple parts.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Rest
3
3
  title: Rest function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Rest
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]`."
9
+ qsharp.summary: "Creates an array that is equal to an input array except that the first array element is dropped."
10
10
  ---
11
11
 
12
12
  # Rest function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Rest
17
17
  function Rest<'T>(array : 'T[]) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Creates an array that is equal to an input array except that the first array
21
22
  element is dropped.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.Reversed
3
3
  title: Reversed function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: Reversed
9
- qsharp.summary: "Create an array that contains the same elements as an input array but in reversed order. # Type Parameters ## 'T The type of the array elements. # Input ## array An array whose elements are to be copied in reversed order. # Output An array containing the elements `array[Length(array) - 1]` .. `array[0]`."
9
+ qsharp.summary: "Create an array that contains the same elements as an input array but in reversed order."
10
10
  ---
11
11
 
12
12
  # Reversed function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Reversed
17
17
  function Reversed<'T>(array : 'T[]) : 'T[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Create an array that contains the same elements as an input array but in reversed
21
22
  order.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.SequenceI
3
3
  title: SequenceI function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: SequenceI
9
- qsharp.summary: "Get an array of integers in a given interval. # Input ## from An inclusive start index of the interval. ## to An inclusive end index of the interval that is not smaller than `from`. # Output An array containing the sequence of numbers `from`, `from + 1`, ..., `to`. # Example ```qsharp let arr1 = SequenceI(0, 3); // [0, 1, 2, 3] let arr2 = SequenceI(23, 29); // [23, 24, 25, 26, 27, 28, 29] let arr3 = SequenceI(-5, -2); // [-5, -4, -3, -2] let numbers = SequenceI(0, _); // function to create sequence from 0 to `to` let naturals = SequenceI(1, _); // function to create sequence from 1 to `to` ```"
9
+ qsharp.summary: "Get an array of integers in a given interval."
10
10
  ---
11
11
 
12
12
  # SequenceI function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.SequenceI
17
17
  function SequenceI(from : Int, to : Int) : Int[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Get an array of integers in a given interval.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Arrays.SequenceL
3
3
  title: SequenceL function
4
- ms.date: 09/30/2024 12:00:00 AM
4
+ ms.date: 10/26/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: SequenceL
9
- qsharp.summary: "Get an array of integers in a given interval. # Input ## from An inclusive start index of the interval. ## to An inclusive end index of the interval that is not smaller than `from`. # Output An array containing the sequence of numbers `from`, `from + 1`, ..., `to`. # Remarks The difference between `from` and `to` must fit into an `Int` value. # Example ```qsharp let arr1 = SequenceL(0L, 3L); // [0L, 1L, 2L, 3L] let arr2 = SequenceL(23L, 29L); // [23L, 24L, 25L, 26L, 27L, 28L, 29L] let arr3 = SequenceL(-5L, -2L); // [-5L, -4L, -3L, -2L] ```"
9
+ qsharp.summary: "Get an array of integers in a given interval."
10
10
  ---
11
11
 
12
12
  # SequenceL function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.SequenceL
17
17
  function SequenceL(from : BigInt, to : BigInt) : BigInt[]
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Get an array of integers in a given interval.
21
22
 
22
23
  ## Input