qsharp-lang 1.9.2-dev → 1.9.3-dev

package/docs/Std.Arrays/Filtered.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Filtered
 title: Filtered function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Filtered
-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]) ```"
+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."
 ---
 
 # Filtered function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Filtered
 function Filtered<'T>(predicate : ('T -> Bool), array : 'T[]) : 'T[]
 ```
 
+## 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.

package/docs/Std.Arrays/FlatMapped.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.FlatMapped
 title: FlatMapped function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: FlatMapped
-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]. ```"
+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."
 ---
 
 # FlatMapped function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.FlatMapped
 function FlatMapped<'TInput, 'TOutput>(mapper : ('TInput -> 'TOutput[]), array : 'TInput[]) : 'TOutput[]
 ```
 
+## 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.
 

package/docs/Std.Arrays/Flattened.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Flattened
 title: Flattened function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Flattened
-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] ```"
+qsharp.summary: "Given an array of arrays, returns the concatenation of all arrays."
 ---
 
 # Flattened function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Flattened
 function Flattened<'T>(arrays : 'T[][]) : 'T[]
 ```
 
+## Summary
 Given an array of arrays, returns the concatenation of all arrays.
 
 ## Type Parameters

package/docs/Std.Arrays/Fold.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Fold
 title: Fold function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Fold
-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. ```"
+qsharp.summary: "Iterates a function `f` through an array `array`, returning `f(...f(f(initialState, array[0]), array[1]), ...)`."
 ---
 
 # Fold function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Fold
 function Fold<'State, 'T>(folder : (('State, 'T) -> 'State), state : 'State, array : 'T[]) : 'State
 ```
 
+## Summary
 Iterates a function `f` through an array `array`, returning
 `f(...f(f(initialState, array[0]), array[1]), ...)`.
 

package/docs/Std.Arrays/ForEach.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.ForEach
 title: ForEach operation
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: operation
 qsharp.namespace: Std.Arrays
 qsharp.name: ForEach
-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"
+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."
 ---
 
 # ForEach operation
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.ForEach
 operation ForEach<'T, 'U>(action : ('T => 'U), array : 'T[]) : 'U[]
 ```
 
+## 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.

package/docs/Std.Arrays/Head.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Head
 title: Head function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Head
-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."
+qsharp.summary: "Returns the first element of the array."
 ---
 
 # Head function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Head
 function Head<'A>(array : 'A[]) : 'A
 ```
 
+## Summary
 Returns the first element of the array.
 
 ## Type Parameters

package/docs/Std.Arrays/HeadAndRest.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.HeadAndRest
 title: HeadAndRest function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: HeadAndRest
-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."
+qsharp.summary: "Returns a tuple of first and all remaining elements of the array."
 ---
 
 # HeadAndRest function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.HeadAndRest
 function HeadAndRest<'A>(array : 'A[]) : ('A, 'A[])
 ```
 
+## Summary
 Returns a tuple of first and all remaining elements of the array.
 
 ## Type Parameters

package/docs/Std.Arrays/IndexOf.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.IndexOf
 title: IndexOf function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: IndexOf
-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. ```"
+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."
 ---
 
 # IndexOf function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IndexOf
 function IndexOf<'T>(predicate : ('T -> Bool), array : 'T[]) : Int
 ```
 
+## Summary
 Returns the first index of the first element in an array that satisfies
 a given predicate. If no such element exists, returns -1.
 

package/docs/Std.Arrays/IndexRange.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.IndexRange
 title: IndexRange function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: IndexRange
-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 { ... } ```"
+qsharp.summary: "Given an array, returns a range over the indices of that array, suitable for use in a for loop."
 ---
 
 # IndexRange function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IndexRange
 function IndexRange<'TElement>(array : 'TElement[]) : Range
 ```
 
+## Summary
 Given an array, returns a range over the indices of that array, suitable
 for use in a for loop.
 

package/docs/Std.Arrays/Interleaved.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Interleaved
 title: Interleaved function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Interleaved
-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]) ```"
+qsharp.summary: "Interleaves two arrays of (almost) same size."
 ---
 
 # Interleaved function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Interleaved
 function Interleaved<'T>(first : 'T[], second : 'T[]) : 'T[]
 ```
 
+## Summary
 Interleaves two arrays of (almost) same size.
 
 ## Description

package/docs/Std.Arrays/IsEmpty.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.IsEmpty
 title: IsEmpty function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: IsEmpty
-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)."
+qsharp.summary: "Returns true if and only if an array is empty."
 ---
 
 # IsEmpty function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IsEmpty
 function IsEmpty<'T>(array : 'T[]) : Bool
 ```
 
+## Summary
 Returns true if and only if an array is empty.
 
 ## Input

package/docs/Std.Arrays/IsRectangularArray.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.IsRectangularArray
 title: IsRectangularArray function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: IsRectangularArray
-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"
+qsharp.summary: "Returns whether a 2-dimensional array has a rectangular shape"
 ---
 
 # IsRectangularArray function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IsRectangularArray
 function IsRectangularArray<'T>(array : 'T[][]) : Bool
 ```
 
+## Summary
 Returns whether a 2-dimensional array has a rectangular shape
 
 ## Type Parameters

package/docs/Std.Arrays/IsSorted.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.IsSorted
 title: IsSorted function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: IsSorted
-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."
+qsharp.summary: "Given an array, returns whether that array is sorted as defined by a given comparison function."
 ---
 
 # IsSorted function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IsSorted
 function IsSorted<'T>(comparison : (('T, 'T) -> Bool), array : 'T[]) : Bool
 ```
 
+## Summary
 Given an array, returns whether that array is sorted as defined by
 a given comparison function.
 

package/docs/Std.Arrays/IsSquareArray.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.IsSquareArray
 title: IsSquareArray function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: IsSquareArray
-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"
+qsharp.summary: "Returns whether a 2-dimensional array has a square shape"
 ---
 
 # IsSquareArray function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.IsSquareArray
 function IsSquareArray<'T>(array : 'T[][]) : Bool
 ```
 
+## Summary
 Returns whether a 2-dimensional array has a square shape
 
 ## Type Parameters

package/docs/Std.Arrays/Mapped.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Mapped
 title: Mapped function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Mapped
-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"
+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."
 ---
 
 # Mapped function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Mapped
 function Mapped<'T, 'U>(mapper : ('T -> 'U), array : 'T[]) : 'U[]
 ```
 
+## 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.

package/docs/Std.Arrays/MappedByIndex.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.MappedByIndex
 title: MappedByIndex function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: MappedByIndex
-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"
+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."
 ---
 
 # MappedByIndex function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.MappedByIndex
 function MappedByIndex<'T, 'U>(mapper : ((Int, 'T) -> 'U), array : 'T[]) : 'U[]
 ```
 
+## 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.

package/docs/Std.Arrays/MappedOverRange.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.MappedOverRange
 title: MappedOverRange function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: MappedOverRange
-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"
+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."
 ---
 
 # MappedOverRange function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.MappedOverRange
 function MappedOverRange<'T>(mapper : (Int -> 'T), range : Range) : 'T[]
 ```
 
+## 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.

package/docs/Std.Arrays/Most.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Most
 title: Most function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Most
-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]`."
+qsharp.summary: "Creates an array that is equal to an input array except that the last array element is dropped."
 ---
 
 # Most function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Most
 function Most<'T>(array : 'T[]) : 'T[]
 ```
 
+## Summary
 Creates an array that is equal to an input array except that the last array
 element is dropped.
 

package/docs/Std.Arrays/MostAndTail.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.MostAndTail
 title: MostAndTail function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: MostAndTail
-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."
+qsharp.summary: "Returns a tuple of all but one and the last element of the array."
 ---
 
 # MostAndTail function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.MostAndTail
 function MostAndTail<'A>(array : 'A[]) : ('A[], 'A)
 ```
 
+## Summary
 Returns a tuple of all but one and the last element of the array.
 
 ## Type Parameters

package/docs/Std.Arrays/Padded.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Padded
 title: Padded function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Padded
-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); ```"
+qsharp.summary: "Returns an array padded at with specified values up to a specified length."
 ---
 
 # Padded function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Padded
 function Padded<'T>(paddedLength : Int, defaultElement : 'T, inputArray : 'T[]) : 'T[]
 ```
 
+## Summary
 Returns an array padded at with specified values up to a
 specified length.
 

package/docs/Std.Arrays/Partitioned.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Partitioned
 title: Partitioned function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Partitioned
-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]); ```"
+qsharp.summary: "Splits an array into multiple parts."
 ---
 
 # Partitioned function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Partitioned
 function Partitioned<'T>(partitionSizes : Int[], array : 'T[]) : 'T[][]
 ```
 
+## Summary
 Splits an array into multiple parts.
 
 ## Input

package/docs/Std.Arrays/Rest.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Rest
 title: Rest function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Rest
-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]`."
+qsharp.summary: "Creates an array that is equal to an input array except that the first array element is dropped."
 ---
 
 # Rest function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Rest
 function Rest<'T>(array : 'T[]) : 'T[]
 ```
 
+## Summary
 Creates an array that is equal to an input array except that the first array
 element is dropped.
 

package/docs/Std.Arrays/Reversed.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Reversed
 title: Reversed function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Reversed
-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]`."
+qsharp.summary: "Create an array that contains the same elements as an input array but in reversed order."
 ---
 
 # Reversed function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Reversed
 function Reversed<'T>(array : 'T[]) : 'T[]
 ```
 
+## Summary
 Create an array that contains the same elements as an input array but in reversed
 order.
 

package/docs/Std.Arrays/SequenceI.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.SequenceI
 title: SequenceI function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: SequenceI
-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` ```"
+qsharp.summary: "Get an array of integers in a given interval."
 ---
 
 # SequenceI function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.SequenceI
 function SequenceI(from : Int, to : Int) : Int[]
 ```
 
+## Summary
 Get an array of integers in a given interval.
 
 ## Input

package/docs/Std.Arrays/SequenceL.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.SequenceL
 title: SequenceL function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: SequenceL
-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] ```"
+qsharp.summary: "Get an array of integers in a given interval."
 ---
 
 # SequenceL function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.SequenceL
 function SequenceL(from : BigInt, to : BigInt) : BigInt[]
 ```
 
+## Summary
 Get an array of integers in a given interval.
 
 ## Input

package/docs/Std.Arrays/Sorted.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Sorted
 title: Sorted function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Sorted
-qsharp.summary: "Given an array, returns the elements of that array sorted 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 sorted.  # Output An array containing the same elements as `array`, such that for all elements `a` occurring earlier than elements `b`, `comparison(a, b)` is `true`.  # Example The following snippet sorts an array of integers to occur in ascending order: ```qsharp let sortedArray = Sorted(LessThanOrEqualI, [3, 17, 11, -201, -11]); ```  # 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. If this property does not hold, then the output of this function may be incorrect."
+qsharp.summary: "Given an array, returns the elements of that array sorted by a given comparison function."
 ---
 
 # Sorted function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Sorted
 function Sorted<'T>(comparison : (('T, 'T) -> Bool), array : 'T[]) : 'T[]
 ```
 
+## Summary
 Given an array, returns the elements of that array sorted by a given
 comparison function.
 

package/docs/Std.Arrays/Subarray.md

@@ -1,12 +1,12 @@
 ---
 uid: Qdk.Std.Arrays.Subarray
 title: Subarray function
-ms.date: 09/30/2024 12:00:00 AM
+ms.date: 10/17/2024 12:00:00 AM
 ms.topic: managed-reference
 qsharp.kind: function
 qsharp.namespace: Std.Arrays
 qsharp.name: Subarray
-qsharp.summary: "Takes an array and a list of locations and produces a new array formed from the elements of the original array that match the given locations.  # Remarks If `locations` contains repeated elements, the corresponding elements of `array` will likewise be repeated.  # Type Parameters ## 'T The type of `array` elements.  # Input ## locations A list of locations in the input array that is used to define the subarray. ## array An array from which a subarray will be generated.  # Output An array `out` of elements whose locations correspond to the subarray, such that `out[index] == array[locations[index]]`.  # Example  ```qsharp let array = [1, 2, 3, 4]; let permutation = Subarray([3, 0, 2, 1], array); // [4, 1, 3, 2] let duplicates = Subarray([1, 2, 2], array);     // [2, 3, 3] ```"
+qsharp.summary: "Takes an array and a list of locations and produces a new array formed from the elements of the original array that match the given locations."
 ---
 
 # Subarray function
@@ -17,6 +17,7 @@ Fully qualified name: Std.Arrays.Subarray
 function Subarray<'T>(locations : Int[], array : 'T[]) : 'T[]
 ```
 
+## Summary
 Takes an array and a list of locations and
 produces a new array formed from the elements of the original
 array that match the given locations.