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.Convert.IntAsBoolArray
3
3
  title: IntAsBoolArray 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.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/26/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/26/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
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.ResultArrayAsInt
3
3
  title: ResultArrayAsInt 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.Convert
8
8
  qsharp.name: ResultArrayAsInt
9
- qsharp.summary: "Produces a non-negative integer from a string of Results in little-endian format. # Input ## results Results in binary representation of number. # Output A non-negative integer # Example ```qsharp // The following returns 1 let int1 = ResultArrayAsInt([One,Zero]) ```"
9
+ qsharp.summary: "Produces a non-negative integer from a string of Results in little-endian format."
10
10
  ---
11
11
 
12
12
  # ResultArrayAsInt function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.ResultArrayAsInt
17
17
  function ResultArrayAsInt(results : Result[]) : Int
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Produces a non-negative integer from a string of Results in little-endian format.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Convert.ResultAsBool
3
3
  title: ResultAsBool 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.Convert
8
8
  qsharp.name: ResultAsBool
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
  # ResultAsBool function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Convert.ResultAsBool
17
17
  function ResultAsBool(input : Result) : Bool
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Converts a `Result` type to a `Bool` type, where `One` is mapped to
21
22
  `true` and `Zero` is mapped to `false`.
22
23
 
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Core.Length
3
3
  title: Length 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.Core
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Core.Repeated
3
3
  title: Repeated 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.Core
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Diagnostics.DumpMachine
3
3
  title: DumpMachine 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.Diagnostics
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  uid: Qdk.Std.Diagnostics.DumpOperation
3
3
  title: DumpOperation 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.Diagnostics
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Diagnostics.DumpRegister
3
3
  title: DumpRegister 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.Diagnostics
8
8
  qsharp.name: DumpRegister
9
- qsharp.summary: "Dumps the current target machine's status associated with the given qubits. # Input ## qubits The list of qubits to report. # Remarks This method allows you to dump the information associated with the state of the given qubits. For the local sparse-state simulator distributed as part of the Quantum Development Kit, this method will write the state of the given qubits (i.e. the wave function of the corresponding subsystem) as a one-dimensional array of pairs of state indices and complex numbers, in which each element represents the amplitudes of the probability of measuring the corresponding state. If the given qubits are entangled with some other qubit and their state can't be separated, it fails with a runtime error indicating that the qubits are entangled. # Example When run on the sparse-state simulator, the following snippet dumps the Bell state (|00⟩ + |11⟩ ) / √2 to the console: ```qsharp use left = Qubit(); use right = Qubit(); within { H(left); CNOT(left, right); } apply { DumpRegister([left, right]); } ```"
9
+ qsharp.summary: "Dumps the current target machine's status associated with the given qubits."
10
10
  ---
11
11
 
12
12
  # DumpRegister function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Diagnostics.DumpRegister
17
17
  function DumpRegister(register : Qubit[]) : Unit
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Dumps the current target machine's status associated with the given qubits.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Diagnostics.Fact
3
3
  title: Fact 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.Diagnostics
8
8
  qsharp.name: Fact
9
- qsharp.summary: "Checks whether a given condition is true, failing with a message if it is not. # Description This function checks whether a given condition is true. If the condition is false, the operation fails with the given message, terminating the program. # Input ## actual The condition to check. ## message The message to use in the failure if the condition is false."
9
+ qsharp.summary: "Checks whether a given condition is true, failing with a message if it is not."
10
10
  ---
11
11
 
12
12
  # Fact function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Diagnostics.Fact
17
17
  function Fact(actual : Bool, message : String) : Unit
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Checks whether a given condition is true, failing with a message if it is not.
21
22
 
22
23
  ## Description
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.AND
3
3
  title: AND 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.Intrinsic
8
8
  qsharp.name: AND
9
- qsharp.summary: "Applies the AND gate that is more efficient for use with decomposition of multi-controlled operations. Note that target qubit must be in |0⟩ state. # Input ## control1 First control qubit for the AND gate. ## control2 Second control qubit for the AND gate. ## target Target qubit for the AND gate. # Remarks Use the Adjoint only for uncomputation purposes."
9
+ qsharp.summary: "Applies the AND gate that is more efficient for use with decomposition of multi-controlled operations. Note that target qubit must be in |0⟩ state."
10
10
  ---
11
11
 
12
12
  # AND operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.AND
17
17
  operation AND(control1 : Qubit, control2 : Qubit, target : Qubit) : Unit is Adj
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies the AND gate that is more efficient for use with decomposition of multi-controlled operations.
21
22
  Note that target qubit must be in |0⟩ state.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.CCNOT
3
3
  title: CCNOT 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.Intrinsic
8
8
  qsharp.name: CCNOT
9
- qsharp.summary: "Applies the doubly controlled–NOT (CCNOT) gate to three qubits. # Input ## control1 First control qubit for the CCNOT gate. ## control2 Second control qubit for the CCNOT gate. ## target Target qubit for the CCNOT gate. # Remarks Equivalent to: ```qsharp Controlled X([control1, control2], target); ```"
9
+ qsharp.summary: "Applies the doubly controlled–NOT (CCNOT) gate to three qubits."
10
10
  ---
11
11
 
12
12
  # CCNOT operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.CCNOT
17
17
  operation CCNOT(control1 : Qubit, control2 : Qubit, target : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies the doubly controlled–NOT (CCNOT) gate to three qubits.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.CNOT
3
3
  title: CNOT 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.Intrinsic
8
8
  qsharp.name: CNOT
9
- qsharp.summary: "Applies the controlled-NOT (CNOT) gate to a pair of qubits. # Input ## control Control qubit for the CNOT gate. ## target Target qubit for the CNOT gate. # Remarks $$ \begin{align} \operatorname{CNOT} \mathrel{:=} \begin{bmatrix} 1 & 0 & 0 & 0 \\\\ 0 & 1 & 0 & 0 \\\\ 0 & 0 & 0 & 1 \\\\ 0 & 0 & 1 & 0 \end{bmatrix}, \end{align} $$ where rows and columns are ordered as in the quantum concepts guide. Equivalent to: ```qsharp Controlled X([control], target); ```"
9
+ qsharp.summary: "Applies the controlled-NOT (CNOT) gate to a pair of qubits."
10
10
  ---
11
11
 
12
12
  # CNOT operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.CNOT
17
17
  operation CNOT(control : Qubit, target : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies the controlled-NOT (CNOT) gate to a pair of qubits.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.Exp
3
3
  title: Exp 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.Intrinsic
8
8
  qsharp.name: Exp
9
- qsharp.summary: "Applies the exponential of a multi-qubit Pauli operator. # Input ## paulis Array of single-qubit Pauli values indicating the tensor product factors on each qubit. ## theta Angle about the given multi-qubit Pauli operator by which the target register is to be rotated. ## qubits Register to apply the given rotation to. # Remarks $$ \begin{align} e^{i \theta [P_0 \otimes P_1 \cdots P_{N-1}]}, \end{align} $$ where $P_i$ is the $i$-th element of `paulis`, and where $N = $`Length(paulis)`."
9
+ qsharp.summary: "Applies the exponential of a multi-qubit Pauli operator."
10
10
  ---
11
11
 
12
12
  # Exp operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.Exp
17
17
  operation Exp(paulis : Pauli[], theta : Double, qubits : Qubit[]) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies the exponential of a multi-qubit Pauli operator.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.H
3
3
  title: H 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.Intrinsic
8
8
  qsharp.name: H
9
- qsharp.summary: "Applies the Hadamard transformation to a single qubit. # Input ## qubit Qubit to which the gate should be applied. # Remarks $$ \begin{align} H \mathrel{:=} \frac{1}{\sqrt{2}} \begin{bmatrix} 1 & 1 \\\\ 1 & -1 \end{bmatrix} \end{align} $$"
9
+ qsharp.summary: "Applies the Hadamard transformation to a single qubit."
10
10
  ---
11
11
 
12
12
  # H operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.H
17
17
  operation H(qubit : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies the Hadamard transformation to a single qubit.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.I
3
3
  title: I 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.Intrinsic
8
8
  qsharp.name: I
9
- qsharp.summary: "Performs the identity operation (no-op) on a single qubit. # Remarks This is a no-op. It is provided for completeness and because sometimes it is useful to call the identity in an algorithm or to pass it as a parameter."
9
+ qsharp.summary: "Performs the identity operation (no-op) on a single qubit."
10
10
  ---
11
11
 
12
12
  # I operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.I
17
17
  operation I(target : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Performs the identity operation (no-op) on a single qubit.
21
22
 
22
23
  ## Remarks
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.M
3
3
  title: M 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.Intrinsic
8
8
  qsharp.name: M
9
- qsharp.summary: "Performs a measurement of a single qubit in the Pauli _Z_ basis. # Input ## qubit Qubit to be measured. # Output `Zero` if the +1 eigenvalue is observed, and `One` if the -1 eigenvalue is observed. # Remarks The output result is given by the distribution $$ \begin{align} \Pr(\texttt{Zero} | \ket{\psi}) = \braket{\psi | 0} \braket{0 | \psi}. \end{align} $$ Equivalent to: ```qsharp Measure([PauliZ], [qubit]); ```"
9
+ qsharp.summary: "Performs a measurement of a single qubit in the Pauli _Z_ basis."
10
10
  ---
11
11
 
12
12
  # M operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.M
17
17
  operation M(qubit : Qubit) : Result
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Performs a measurement of a single qubit in the
21
22
  Pauli _Z_ basis.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.Measure
3
3
  title: Measure 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.Intrinsic
8
8
  qsharp.name: Measure
9
- qsharp.summary: "Performs a joint measurement of one or more qubits in the specified Pauli bases. If the basis array and qubit array are different lengths, then the operation will fail. # Input ## bases Array of single-qubit Pauli values indicating the tensor product factors on each qubit. ## qubits Register of qubits to be measured. # Output `Zero` if the +1 eigenvalue is observed, and `One` if the -1 eigenvalue is observed. # Remarks The probability of getting `Zero` is $\bra{\psi} \frac{I + P_0 \otimes \ldots \otimes P_{N-1}}{2} \ket{\psi}$ where $P_i$ is the $i$-th element of `bases`, and where $N$ is the `Length(bases)`. That is, measurement returns a `Result` $d$ such that the eigenvalue of the observed measurement effect is $(-1)^d$."
9
+ qsharp.summary: "Performs a joint measurement of one or more qubits in the specified Pauli bases. If the basis array and qubit array are different lengths, then the operation will fail."
10
10
  ---
11
11
 
12
12
  # Measure operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.Measure
17
17
  operation Measure(bases : Pauli[], qubits : Qubit[]) : Result
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Performs a joint measurement of one or more qubits in the
21
22
  specified Pauli bases.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.Message
3
3
  title: Message 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.Intrinsic
8
8
  qsharp.name: Message
9
- qsharp.summary: "Logs a message. # Input ## msg The message to be reported. # Remarks The specific behavior of this function is simulator-dependent, but in most cases the given message will be written to the console. ```"
9
+ qsharp.summary: "Logs a message."
10
10
  ---
11
11
 
12
12
  # Message function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.Message
17
17
  function Message(msg : String) : Unit
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Logs a message.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.R
3
3
  title: R 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.Intrinsic
8
8
  qsharp.name: R
9
- qsharp.summary: "Applies a rotation about the given Pauli axis. # Input ## pauli Pauli operator (μ) to be exponentiated to form the rotation. ## theta Angle in radians about which the qubit is to be rotated. ## qubit Qubit to which the gate should be applied. # Remarks $$ \begin{align} R_{\mu}(\theta) \mathrel{:=} e^{-i \theta \sigma_{\mu} / 2}, \end{align} $$ where $\mu \in \{I, X, Y, Z\}$. When called with `pauli = PauliI`, this operation applies a *global phase*. This phase can be significant when used with the `Controlled` functor."
9
+ qsharp.summary: "Applies a rotation about the given Pauli axis."
10
10
  ---
11
11
 
12
12
  # R operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.R
17
17
  operation R(pauli : Pauli, theta : Double, qubit : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies a rotation about the given Pauli axis.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.R1
3
3
  title: R1 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.Intrinsic
8
8
  qsharp.name: R1
9
- qsharp.summary: "Applies a rotation about the |1⟩ state by a given angle. # Input ## theta Angle about which the qubit is to be rotated. ## qubit Qubit to which the gate should be applied. # Remarks $$ \begin{align} R_1(\theta) \mathrel{:=} \operatorname{diag}(1, e^{i\theta}). \end{align} $$ Equivalent to: ```qsharp R(PauliZ, theta, qubit); R(PauliI, -theta, qubit); ```"
9
+ qsharp.summary: "Applies a rotation about the |1⟩ state by a given angle."
10
10
  ---
11
11
 
12
12
  # R1 operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.R1
17
17
  operation R1(theta : Double, qubit : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies a rotation about the |1⟩ state by a given angle.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.R1Frac
3
3
  title: R1Frac 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.Intrinsic
8
8
  qsharp.name: R1Frac
9
- qsharp.summary: "Applies a rotation about the |1⟩ state by an angle specified as a dyadic fraction. WARNING: This operation uses the **opposite** sign convention from Microsoft.Quantum.Intrinsic.R. # Input ## numerator Numerator in the dyadic fraction representation of the angle by which the qubit is to be rotated. This angle is expressed in radians. ## power Power of two specifying the denominator of the angle by which the qubit is to be rotated. This angle is expressed in radians. ## qubit Qubit to which the gate should be applied. # Remarks $$ \begin{align} R_1(n, k) \mathrel{:=} \operatorname{diag}(1, e^{i \pi n / 2^k}). \end{align} $$ Equivalent to: ```qsharp RFrac(PauliZ, -numerator, denominator + 1, qubit); RFrac(PauliI, numerator, denominator + 1, qubit); ```"
9
+ qsharp.summary: "Applies a rotation about the |1⟩ state by an angle specified as a dyadic fraction. WARNING: This operation uses the **opposite** sign convention from Microsoft.Quantum.Intrinsic.R."
10
10
  ---
11
11
 
12
12
  # R1Frac operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.R1Frac
17
17
  operation R1Frac(numerator : Int, power : Int, qubit : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies a rotation about the |1⟩ state by an angle specified
21
22
  as a dyadic fraction.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.RFrac
3
3
  title: RFrac 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.Intrinsic
8
8
  qsharp.name: RFrac
9
- qsharp.summary: "Applies a rotation about the given Pauli axis by an angle specified as a dyadic fraction. WARNING: This operation uses the **opposite** sign convention from Microsoft.Quantum.Intrinsic.R. # Input ## pauli Pauli operator to be exponentiated to form the rotation. ## numerator Numerator in the dyadic fraction representation of the angle by which the qubit is to be rotated. This angle is expressed in radians. ## power Power of two specifying the denominator of the angle by which the qubit is to be rotated. This angle is expressed in radians. ## qubit Qubit to which the gate should be applied. # Remarks $$ \begin{align} R_{\mu}(n, k) \mathrel{:=} e^{i \pi n \sigma_{\mu} / 2^k}, \end{align} $$ where $\mu \in \{I, X, Y, Z\}$. Equivalent to: ```qsharp // PI() is a Q# function that returns an approximation of π. R(pauli, -2.0 * PI() * IntAsDouble(numerator) / IntAsDouble(2 ^ (power - 1)), qubit); ```"
9
+ qsharp.summary: "Applies a rotation about the given Pauli axis by an angle specified as a dyadic fraction. WARNING: This operation uses the **opposite** sign convention from Microsoft.Quantum.Intrinsic.R."
10
10
  ---
11
11
 
12
12
  # RFrac operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.RFrac
17
17
  operation RFrac(pauli : Pauli, numerator : Int, power : Int, qubit : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies a rotation about the given Pauli axis by an angle specified
21
22
  as a dyadic fraction.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.Reset
3
3
  title: Reset 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.Intrinsic
8
8
  qsharp.name: Reset
9
- qsharp.summary: "Given a single qubit, measures it and ensures it is in the |0⟩ state such that it can be safely released. # Input ## qubit The qubit whose state is to be reset to |0⟩."
9
+ qsharp.summary: "Given a single qubit, measures it and ensures it is in the |0⟩ state such that it can be safely released."
10
10
  ---
11
11
 
12
12
  # Reset operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.Reset
17
17
  operation Reset(qubit : Qubit) : Unit
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given a single qubit, measures it and ensures it is in the |0⟩ state
21
22
  such that it can be safely released.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.ResetAll
3
3
  title: ResetAll 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.Intrinsic
8
8
  qsharp.name: ResetAll
9
- qsharp.summary: "Given an array of qubits, measure them and ensure they are in the |0⟩ state such that they can be safely released. # Input ## qubits An array of qubits whose states are to be reset to |0⟩."
9
+ qsharp.summary: "Given an array of qubits, measure them and ensure they are in the |0⟩ state such that they can be safely released."
10
10
  ---
11
11
 
12
12
  # ResetAll operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.ResetAll
17
17
  operation ResetAll(qubits : Qubit[]) : Unit
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Given an array of qubits, measure them and ensure they are in the |0⟩ state
21
22
  such that they can be safely released.
22
23
 
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.Rx
3
3
  title: Rx 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.Intrinsic
8
8
  qsharp.name: Rx
9
- qsharp.summary: "Applies a rotation about the _x_-axis by a given angle. # Input ## theta Angle about which the qubit is to be rotated. ## qubit Qubit to which the gate should be applied. # Remarks $$ \begin{align} R_x(\theta) \mathrel{:=} e^{-i \theta \sigma_x / 2} = \begin{bmatrix} \cos \frac{\theta}{2} & -i\sin \frac{\theta}{2} \\\\ -i\sin \frac{\theta}{2} & \cos \frac{\theta}{2} \end{bmatrix}. \end{align} $$ Equivalent to: ```qsharp R(PauliX, theta, qubit); ```"
9
+ qsharp.summary: "Applies a rotation about the _x_-axis by a given angle."
10
10
  ---
11
11
 
12
12
  # Rx operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.Rx
17
17
  operation Rx(theta : Double, qubit : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies a rotation about the _x_-axis by a given angle.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.Rxx
3
3
  title: Rxx 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.Intrinsic
8
8
  qsharp.name: Rxx
9
- qsharp.summary: "Applies the two qubit Ising _XX_ rotation gate. # Input ## theta The angle about which the qubits are rotated. ## qubit0 The first qubit input to the gate. ## qubit1 The second qubit input to the gate. # Remarks $$ \begin{align} R_{xx}(\theta) \mathrel{:=} \begin{bmatrix} \cos \theta & 0 & 0 & -i\sin \theta \\\\ 0 & \cos \theta & -i\sin \theta & 0 \\\\ 0 & -i\sin \theta & \cos \theta & 0 \\\\ -i\sin \theta & 0 & 0 & \cos \theta \end{bmatrix}. \end{align} $$"
9
+ qsharp.summary: "Applies the two qubit Ising _XX_ rotation gate."
10
10
  ---
11
11
 
12
12
  # Rxx operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.Rxx
17
17
  operation Rxx(theta : Double, qubit0 : Qubit, qubit1 : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies the two qubit Ising _XX_ rotation gate.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.Ry
3
3
  title: Ry 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.Intrinsic
8
8
  qsharp.name: Ry
9
- qsharp.summary: "Applies a rotation about the _y_-axis by a given angle. # Input ## theta Angle about which the qubit is to be rotated. ## qubit Qubit to which the gate should be applied. # Remarks $$ \begin{align} R_y(\theta) \mathrel{:=} e^{-i \theta \sigma_y / 2} = \begin{bmatrix} \cos \frac{\theta}{2} & -\sin \frac{\theta}{2} \\\\ \sin \frac{\theta}{2} & \cos \frac{\theta}{2} \end{bmatrix}. \end{align} $$ Equivalent to: ```qsharp R(PauliY, theta, qubit); ```"
9
+ qsharp.summary: "Applies a rotation about the _y_-axis by a given angle."
10
10
  ---
11
11
 
12
12
  # Ry operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.Ry
17
17
  operation Ry(theta : Double, qubit : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies a rotation about the _y_-axis by a given angle.
21
22
 
22
23
  ## Input
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  uid: Qdk.Std.Intrinsic.Ryy
3
3
  title: Ryy 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.Intrinsic
8
8
  qsharp.name: Ryy
9
- qsharp.summary: "Applies the two qubit Ising _YY_ rotation gate. # Input ## theta The angle about which the qubits are rotated. ## qubit0 The first qubit input to the gate. ## qubit1 The second qubit input to the gate. # Remarks $$ \begin{align} R_{yy}(\theta) \mathrel{:=} \begin{bmatrix} \cos \theta & 0 & 0 & i\sin \theta \\\\ 0 & \cos \theta & -i\sin \theta & 0 \\\\ 0 & -i\sin \theta & \cos \theta & 0 \\\\ i\sin \theta & 0 & 0 & \cos \theta \end{bmatrix}. \end{align} $$"
9
+ qsharp.summary: "Applies the two qubit Ising _YY_ rotation gate."
10
10
  ---
11
11
 
12
12
  # Ryy operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Intrinsic.Ryy
17
17
  operation Ryy(theta : Double, qubit0 : Qubit, qubit1 : Qubit) : Unit is Adj + Ctl
18
18
  ```
19
19
 
20
+ ## Summary
20
21
  Applies the two qubit Ising _YY_ rotation gate.
21
22
 
22
23
  ## Input