time-to-botec/squiggle/node_modules/@stdlib/ndarray/index-modes/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

28 lines
707 B
Plaintext

{{alias}}()
Returns a list of ndarray index modes.
The output array contains the following modes:
- throw: specifies that a function should throw an error when an index is
outside a restricted interval.
- wrap: specifies that a function should wrap around an index using modulo
arithmetic.
- clamp: specifies that a function should set an index less than zero to
zero (minimum index) and set an index greater than a maximum index value to
the maximum possible index.
Returns
-------
out: Array<string>
List of ndarray index modes.
Examples
--------
> var out = {{alias}}()
[ 'throw', 'clamp', 'wrap' ]
See Also
--------