{"route":"/en-US-v0.14.1/reference/foundations/array/","title":"Array","description":"Documentation for the Array type.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"constructor","name":"Constructor","children":[{"id":"constructor-value","name":"value","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-len","name":"Length","children":[]},{"id":"definitions-first","name":"First","children":[{"id":"definitions-first-default","name":"default","children":[]}]},{"id":"definitions-last","name":"Last","children":[{"id":"definitions-last-default","name":"default","children":[]}]},{"id":"definitions-at","name":"At","children":[{"id":"definitions-at-index","name":"index","children":[]},{"id":"definitions-at-default","name":"default","children":[]}]},{"id":"definitions-push","name":"Push","children":[{"id":"definitions-push-value","name":"value","children":[]}]},{"id":"definitions-pop","name":"Pop","children":[]},{"id":"definitions-insert","name":"Insert","children":[{"id":"definitions-insert-index","name":"index","children":[]},{"id":"definitions-insert-value","name":"value","children":[]}]},{"id":"definitions-remove","name":"Remove","children":[{"id":"definitions-remove-index","name":"index","children":[]},{"id":"definitions-remove-default","name":"default","children":[]}]},{"id":"definitions-slice","name":"Slice","children":[{"id":"definitions-slice-start","name":"start","children":[]},{"id":"definitions-slice-end","name":"end","children":[]},{"id":"definitions-slice-count","name":"count","children":[]}]},{"id":"definitions-contains","name":"Contains","children":[{"id":"definitions-contains-value","name":"value","children":[]}]},{"id":"definitions-find","name":"Find","children":[{"id":"definitions-find-searcher","name":"searcher","children":[]}]},{"id":"definitions-position","name":"Position","children":[{"id":"definitions-position-searcher","name":"searcher","children":[]}]},{"id":"definitions-range","name":"Range","children":[{"id":"definitions-range-start","name":"start","children":[]},{"id":"definitions-range-end","name":"end","children":[]},{"id":"definitions-range-step","name":"step","children":[]}]},{"id":"definitions-filter","name":"Filter","children":[{"id":"definitions-filter-test","name":"test","children":[]}]},{"id":"definitions-map","name":"Map","children":[{"id":"definitions-map-mapper","name":"mapper","children":[]}]},{"id":"definitions-enumerate","name":"Enumerate","children":[{"id":"definitions-enumerate-start","name":"start","children":[]}]},{"id":"definitions-zip","name":"Zip","children":[{"id":"definitions-zip-exact","name":"exact","children":[]},{"id":"definitions-zip-others","name":"others","children":[]}]},{"id":"definitions-fold","name":"Fold","children":[{"id":"definitions-fold-init","name":"init","children":[]},{"id":"definitions-fold-folder","name":"folder","children":[]}]},{"id":"definitions-sum","name":"Sum","children":[{"id":"definitions-sum-default","name":"default","children":[]}]},{"id":"definitions-product","name":"Product","children":[{"id":"definitions-product-default","name":"default","children":[]}]},{"id":"definitions-any","name":"Any","children":[{"id":"definitions-any-test","name":"test","children":[]}]},{"id":"definitions-all","name":"All","children":[{"id":"definitions-all-test","name":"test","children":[]}]},{"id":"definitions-flatten","name":"Flatten","children":[]},{"id":"definitions-rev","name":"Reverse","children":[]},{"id":"definitions-split","name":"Split","children":[{"id":"definitions-split-at","name":"at","children":[]}]},{"id":"definitions-join","name":"Join","children":[{"id":"definitions-join-separator","name":"separator","children":[]},{"id":"definitions-join-last","name":"last","children":[]},{"id":"definitions-join-default","name":"default","children":[]}]},{"id":"definitions-intersperse","name":"Intersperse","children":[{"id":"definitions-intersperse-separator","name":"separator","children":[]}]},{"id":"definitions-chunks","name":"Chunks","children":[{"id":"definitions-chunks-chunk-size","name":"chunk-size","children":[]},{"id":"definitions-chunks-exact","name":"exact","children":[]}]},{"id":"definitions-windows","name":"Windows","children":[{"id":"definitions-windows-window-size","name":"window-size","children":[]}]},{"id":"definitions-sorted","name":"Sorted","children":[{"id":"definitions-sorted-key","name":"key","children":[]},{"id":"definitions-sorted-by","name":"by","children":[]}]},{"id":"definitions-dedup","name":"Deduplicate","children":[{"id":"definitions-dedup-key","name":"key","children":[]}]},{"id":"definitions-to-dict","name":"To Dict","children":[]},{"id":"definitions-reduce","name":"Reduce","children":[{"id":"definitions-reduce-reducer","name":"reducer","children":[]}]}]}],"body":{"kind":"type","content":{"name":"array","title":"Array","keywords":[],"oneliner":"A sequence of values.","details":"

A sequence of values.

\n

You can construct an array by enclosing a comma-separated sequence of values\nin parentheses. The values do not have to be of the same type.

\n

You can access and update array items with the .at() method. Indices are\nzero-based and negative indices wrap around to the end of the array. You can\niterate over an array using a for loop. Arrays can be\nadded together with the + operator, joined together\nand multiplied with integers.

\n

Note: An array of length one needs a trailing comma, as in (1,).\nThis is to disambiguate from a simple parenthesized expressions like (1 + 2) * 3. An empty array is written as ().

\n

Example

\n
#let values = (1, 7, 4, -3, 2)\n\n#values.at(0) \\\n#(values.at(0) = 3)\n#values.at(-1) \\\n#values.find(calc.even) \\\n#values.filter(calc.odd) \\\n#values.map(calc.abs) \\\n#values.rev() \\\n#(1, (2, 3)).flatten() \\\n#(("A", "B", "C")\n    .join(", ", last: " and "))\n
\"Preview\"
","constructor":{"path":[],"name":"array","title":"Construct","keywords":[],"oneliner":"Converts a value to an array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Converts a value to an array.

\n

Note that this function is only intended for conversion of a collection-like\nvalue to an array, not for creation of an array from individual items. Use\nthe array syntax (1, 2, 3) (or (1,) for a single-element array) instead.

"},{"kind":"example","content":{"body":"
#let hi = "Hello 😃"\n#array(bytes(hi))\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"value","details":[{"kind":"html","content":"

The value that should be converted to an array.

"}],"types":["bytes","array","version"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},"scope":[{"path":["array"],"name":"len","title":"Length","keywords":[],"oneliner":"The number of values in the array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

The number of values in the array.

"}],"self":true,"params":[],"returns":["int"],"scope":[]},{"path":["array"],"name":"first","title":"First","keywords":[],"oneliner":"Returns the first item in the array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the first item in the array. May be used on the left-hand side\nan assignment. Returns the default value if the array is empty\nor fails with an error is no default value was specified.

"}],"self":true,"params":[{"name":"default","details":[{"kind":"html","content":"

A default value to return if the array is empty.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["array"],"name":"last","title":"Last","keywords":[],"oneliner":"Returns the last item in the array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the last item in the array. May be used on the left-hand side of\nan assignment. Returns the default value if the array is empty\nor fails with an error is no default value was specified.

"}],"self":true,"params":[{"name":"default","details":[{"kind":"html","content":"

A default value to return if the array is empty.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["array"],"name":"at","title":"At","keywords":[],"oneliner":"Returns the item at the specified index in the array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns the item at the specified index in the array. May be used on the\nleft-hand side of an assignment. Returns the default value if the index\nis out of bounds or fails with an error if no default value was\nspecified.

"}],"self":true,"params":[{"name":"index","details":[{"kind":"html","content":"

The index at which to retrieve the item. If negative, indexes from\nthe back.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"default","details":[{"kind":"html","content":"

A default value to return if the index is out of bounds.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["array"],"name":"push","title":"Push","keywords":[],"oneliner":"Adds a value to the end of the array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Adds a value to the end of the array.

"}],"self":true,"params":[{"name":"value","details":[{"kind":"html","content":"

The value to insert at the end of the array.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":[],"scope":[]},{"path":["array"],"name":"pop","title":"Pop","keywords":[],"oneliner":"Removes the last item from the array and returns it.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Removes the last item from the array and returns it. Fails with an error\nif the array is empty.

"}],"self":true,"params":[],"returns":["any"],"scope":[]},{"path":["array"],"name":"insert","title":"Insert","keywords":[],"oneliner":"Inserts a value into the array at the specified index, shifting all subsequent elements to the right.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Inserts a value into the array at the specified index, shifting all\nsubsequent elements to the right. Fails with an error if the index is\nout of bounds.

\n

To replace an element of an array, use at.

"}],"self":true,"params":[{"name":"index","details":[{"kind":"html","content":"

The index at which to insert the item. If negative, indexes from\nthe back.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"value","details":[{"kind":"html","content":"

The value to insert into the array.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":[],"scope":[]},{"path":["array"],"name":"remove","title":"Remove","keywords":[],"oneliner":"Removes the value at the specified index from the array and return it.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Removes the value at the specified index from the array and return it.

"}],"self":true,"params":[{"name":"index","details":[{"kind":"html","content":"

The index at which to remove the item. If negative, indexes from\nthe back.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"default","details":[{"kind":"html","content":"

A default value to return if the index is out of bounds.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["array"],"name":"slice","title":"Slice","keywords":[],"oneliner":"Extracts a subslice of the array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Extracts a subslice of the array. Fails with an error if the start or end\nindex is out of bounds.

"}],"self":true,"params":[{"name":"start","details":[{"kind":"html","content":"

The start index (inclusive). If negative, indexes from the back.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"end","details":[{"kind":"html","content":"

The end index (exclusive). If omitted, the whole slice until the end\nof the array is extracted. If negative, indexes from the back.

"}],"types":["none","int"],"strings":[],"default":"none","positional":true,"named":false,"required":false,"variadic":false,"settable":false},{"name":"count","details":[{"kind":"html","content":"

The number of items to extract. This is equivalent to passing\nstart + count as the end position. Mutually exclusive with end.

"}],"types":["int"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"contains","title":"Contains","keywords":[],"oneliner":"Whether the array contains the specified value.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Whether the array contains the specified value.

\n

This method also has dedicated syntax: You can write 2 in (1, 2, 3)\ninstead of (1, 2, 3).contains(2).

"}],"self":true,"params":[{"name":"value","details":[{"kind":"html","content":"

The value to search for.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bool"],"scope":[]},{"path":["array"],"name":"find","title":"Find","keywords":[],"oneliner":"Searches for an item for which the given function returns `{true}` and returns the first match or `{none}` if there is no match.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Searches for an item for which the given function returns true and\nreturns the first match or none if there is no match.

"}],"self":true,"params":[{"name":"searcher","details":[{"kind":"html","content":"

The function to apply to each item. Must return a boolean.

"}],"types":["function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any","none"],"scope":[]},{"path":["array"],"name":"position","title":"Position","keywords":[],"oneliner":"Searches for an item for which the given function returns `{true}` and returns the index of the first match or `{none}` if there is no match.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Searches for an item for which the given function returns true and\nreturns the index of the first match or none if there is no match.

"}],"self":true,"params":[{"name":"searcher","details":[{"kind":"html","content":"

The function to apply to each item. Must return a boolean.

"}],"types":["function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["none","int"],"scope":[]},{"path":["array"],"name":"range","title":"Range","keywords":[],"oneliner":"Create an array consisting of a sequence of numbers.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Create an array consisting of a sequence of numbers.

\n

If you pass just one positional parameter, it is interpreted as the\nend of the range. If you pass two, they describe the start and end\nof the range.

\n

This function is available both in the array function's scope and\nglobally.

"},{"kind":"example","content":{"body":"
#range(5) \\\n#range(2, 5) \\\n#range(20, step: 4) \\\n#range(21, step: 4) \\\n#range(5, 2, step: -1)\n
\"Preview\"
","title":null}}],"self":false,"params":[{"name":"start","details":[{"kind":"html","content":"

The start of the range (inclusive).

"}],"types":["int"],"strings":[],"default":"0","positional":true,"named":false,"required":false,"variadic":false,"settable":false},{"name":"end","details":[{"kind":"html","content":"

The end of the range (exclusive).

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"step","details":[{"kind":"html","content":"

The distance between the generated numbers.

"}],"types":["int"],"strings":[],"default":"1","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"filter","title":"Filter","keywords":[],"oneliner":"Produces a new array with only the items from the original one for which the given function returns true.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Produces a new array with only the items from the original one for which\nthe given function returns true.

"}],"self":true,"params":[{"name":"test","details":[{"kind":"html","content":"

The function to apply to each item. Must return a boolean.

"}],"types":["function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"map","title":"Map","keywords":[],"oneliner":"Produces a new array in which all items from the original one were transformed with the given function.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Produces a new array in which all items from the original one were\ntransformed with the given function.

"}],"self":true,"params":[{"name":"mapper","details":[{"kind":"html","content":"

The function to apply to each item.

"}],"types":["function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"enumerate","title":"Enumerate","keywords":[],"oneliner":"Returns a new array with the values alongside their indices.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns a new array with the values alongside their indices.

\n

The returned array consists of (index, value) pairs in the form of\nlength-2 arrays. These can be destructured with\na let binding or for loop.

"},{"kind":"example","content":{"body":"
#for (i, value) in ("A", "B", "C").enumerate() {\n  [#i: #value \\ ]\n}\n\n#("A", "B", "C").enumerate(start: 1)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"start","details":[{"kind":"html","content":"

The index returned for the first pair of the returned list.

"}],"types":["int"],"strings":[],"default":"0","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"zip","title":"Zip","keywords":[],"oneliner":"Zips the array with other arrays.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Zips the array with other arrays.

\n

Returns an array of arrays, where the ith inner array contains all the\nith elements from each original array.

\n

If the arrays to be zipped have different lengths, they are zipped up to\nthe last element of the shortest array and all remaining elements are\nignored.

\n

This function is variadic, meaning that you can zip multiple arrays\ntogether at once: (1, 2).zip(("A", "B"), (10, 20)) yields\n((1, "A", 10), (2, "B", 20)).

"}],"self":true,"params":[{"name":"exact","details":[{"kind":"html","content":"

Whether all arrays have to have the same length.\nFor example, (1, 2).zip((1, 2, 3), exact: true) produces an\nerror.

"}],"types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"others","details":[{"kind":"html","content":"

The arrays to zip with.

"}],"types":["array"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":true,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"fold","title":"Fold","keywords":[],"oneliner":"Folds all items into a single value using an accumulator function.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Folds all items into a single value using an accumulator function.

"},{"kind":"example","content":{"body":"
#let array = (1, 2, 3, 4)\n#array.fold(0, (acc, x) => acc + x)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"init","details":[{"kind":"html","content":"

The initial value to start with.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"folder","details":[{"kind":"html","content":"

The folding function. Must have two parameters: One for the\naccumulated value and one for an item.

"}],"types":["function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["array"],"name":"sum","title":"Sum","keywords":[],"oneliner":"Sums all items (works for all types that can be added).","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Sums all items (works for all types that can be added).

"}],"self":true,"params":[{"name":"default","details":[{"kind":"html","content":"

What to return if the array is empty. Must be set if the array can\nbe empty.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["array"],"name":"product","title":"Product","keywords":[],"oneliner":"Calculates the product of all items (works for all types that can be multiplied).","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Calculates the product of all items (works for all types that can be\nmultiplied).

"}],"self":true,"params":[{"name":"default","details":[{"kind":"html","content":"

What to return if the array is empty. Must be set if the array can\nbe empty.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["array"],"name":"any","title":"Any","keywords":[],"oneliner":"Whether the given function returns `{true}` for any item in the array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Whether the given function returns true for any item in the array.

"}],"self":true,"params":[{"name":"test","details":[{"kind":"html","content":"

The function to apply to each item. Must return a boolean.

"}],"types":["function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bool"],"scope":[]},{"path":["array"],"name":"all","title":"All","keywords":[],"oneliner":"Whether the given function returns `{true}` for all items in the array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Whether the given function returns true for all items in the array.

"}],"self":true,"params":[{"name":"test","details":[{"kind":"html","content":"

The function to apply to each item. Must return a boolean.

"}],"types":["function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["bool"],"scope":[]},{"path":["array"],"name":"flatten","title":"Flatten","keywords":[],"oneliner":"Combine all nested arrays into a single flat one.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Combine all nested arrays into a single flat one.

"}],"self":true,"params":[],"returns":["array"],"scope":[]},{"path":["array"],"name":"rev","title":"Reverse","keywords":[],"oneliner":"Return a new array with the same items, but in reverse order.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Return a new array with the same items, but in reverse order.

"}],"self":true,"params":[],"returns":["array"],"scope":[]},{"path":["array"],"name":"split","title":"Split","keywords":[],"oneliner":"Split the array at occurrences of the specified value.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Split the array at occurrences of the specified value.

"},{"kind":"example","content":{"body":"
#(1, 1, 2, 3, 2, 4, 5).split(2)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"at","details":[{"kind":"html","content":"

The value to split at.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"join","title":"Join","keywords":[],"oneliner":"Combine all items in the array into one.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Combine all items in the array into one.

"}],"self":true,"params":[{"name":"separator","details":[{"kind":"html","content":"

A value to insert between each item of the array.

"}],"types":["any","none"],"strings":[],"default":"none","positional":true,"named":false,"required":false,"variadic":false,"settable":false},{"name":"last","details":[{"kind":"html","content":"

An alternative separator between the last two items.

"}],"types":["any"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"default","details":[{"kind":"html","content":"

What to return if the array is empty.

"}],"types":["any","none"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["array"],"name":"intersperse","title":"Intersperse","keywords":[],"oneliner":"Returns an array with a copy of the separator value placed between adjacent elements.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns an array with a copy of the separator value placed between\nadjacent elements.

"},{"kind":"example","content":{"body":"
#("A", "B", "C").intersperse("-")\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"separator","details":[{"kind":"html","content":"

The value that will be placed between each adjacent element.

"}],"types":["any"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"chunks","title":"Chunks","keywords":[],"oneliner":"Splits an array into non-overlapping chunks, starting at the beginning, ending with a single remainder chunk.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Splits an array into non-overlapping chunks, starting at the beginning,\nending with a single remainder chunk.

\n

All chunks but the last have chunk-size elements.\nIf exact is set to true, the remainder is dropped if it\ncontains less than chunk-size elements.

"},{"kind":"example","content":{"body":"
#let array = (1, 2, 3, 4, 5, 6, 7, 8)\n#array.chunks(3) \\\n#array.chunks(3, exact: true)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"chunk-size","details":[{"kind":"html","content":"

How many elements each chunk may at most contain.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"exact","details":[{"kind":"html","content":"

Whether to keep the remainder if its size is less than chunk-size.

"}],"types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"windows","title":"Windows","keywords":[],"oneliner":"Returns sliding windows of `window-size` elements over an array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Returns sliding windows of window-size elements over an array.

\n

If the array length is less than window-size, this will return an empty array.

"},{"kind":"example","content":{"body":"
#let array = (1, 2, 3, 4, 5, 6, 7, 8)\n#array.windows(5)\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"window-size","details":[{"kind":"html","content":"

How many elements each window will contain.

"}],"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"sorted","title":"Sorted","keywords":[],"oneliner":"Return a sorted version of this array, optionally by a given key function.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Return a sorted version of this array, optionally by a given key\nfunction. The sorting algorithm used is stable.

\n

Returns an error if two values could not be compared or if the key\nor comparison function (if given) yields an error.

\n

To sort according to multiple criteria at once, e.g. in case of equality\nbetween some criteria, the key function can return an array. The results\nare in lexicographic order.

"},{"kind":"example","content":{"body":"
#let array = (\n  (a: 2, b: 4),\n  (a: 1, b: 5),\n  (a: 2, b: 3),\n)\n#array.sorted(key: it => (it.a, it.b))\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"key","details":[{"kind":"html","content":"

If given, applies this function to each element in the array to\ndetermine the keys to sort by.

"}],"types":["function"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"by","details":[{"kind":"html","content":"

If given, uses this function to compare every two elements in the\narray.

\n

The function will receive two elements in the array for comparison,\nand should return a boolean indicating their order: true\nindicates that the elements are in order, while false indicates\nthat they should be swapped. To keep the sort stable, if the two\nelements are equal, the function should return true.

\n

If this function does not order the elements properly (e.g., by\nreturning false for both (x, y) and (y, x), or for\n(x, x)), the resulting array will be in unspecified order.

\n

When used together with key, by will be passed the keys instead\nof the elements.

"},{"kind":"example","content":{"body":"
#(\n  "sorted",\n  "by",\n  "decreasing",\n  "length",\n).sorted(\n  key: s => s.len(),\n  by: (l, r) => l >= r,\n)\n
\"Preview\"
","title":null}}],"types":["function"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"dedup","title":"Deduplicate","keywords":[],"oneliner":"Deduplicates all items in the array.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Deduplicates all items in the array.

\n

Returns a new array with all duplicate items removed. Only the first\nelement of each duplicate is kept.

"},{"kind":"example","content":{"body":"
#(3, 3, 1, 2, 3).dedup()\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"key","details":[{"kind":"html","content":"

If given, applies this function to each element in the array to\ndetermine the keys to deduplicate by.

"},{"kind":"example","content":{"body":"
#("apple", "banana", " apple ").dedup(key: s => s.trim())\n
\"Preview\"
","title":null}}],"types":["function"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["array"],"scope":[]},{"path":["array"],"name":"to-dict","title":"To Dict","keywords":[],"oneliner":"Converts an array of pairs into a dictionary.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Converts an array of pairs into a dictionary.\nThe first value of each pair is the key, the second the value.

\n

If the same key occurs multiple times, the last value is selected.

"},{"kind":"example","content":{"body":"
#(\n  ("apples", 2),\n  ("peaches", 3),\n  ("apples", 5),\n).to-dict()\n
\"Preview\"
","title":null}}],"self":true,"params":[],"returns":["dictionary"],"scope":[]},{"path":["array"],"name":"reduce","title":"Reduce","keywords":[],"oneliner":"Reduces the elements to a single one, by repeatedly applying a reducing operation.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

Reduces the elements to a single one, by repeatedly applying a reducing\noperation.

\n

If the array is empty, returns none, otherwise, returns the result\nof the reduction.

\n

The reducing function is a closure with two arguments: an "accumulator",\nand an element.

\n

For arrays with at least one element, this is the same as array.fold\nwith the first element of the array as the initial accumulator value,\nfolding every subsequent element into it.

"},{"kind":"example","content":{"body":"
#let array = (2, 1, 4, 3)\n#array.reduce((acc, x) => calc.max(acc, x))\n
\"Preview\"
","title":null}}],"self":true,"params":[{"name":"reducer","details":[{"kind":"html","content":"

The reducing function. Must have two parameters: One for the\naccumulated value and one for an item.

"}],"types":["function"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[]}]}}}