You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -98,7 +98,7 @@ The function accepts the following `options`:
98
98
-**dtype**: output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or "generic". Default: `'float64'`.
99
99
-**order**: array order (i.e., memory layout), which is either `row-major` (C-style) or `column-major` (Fortran-style). Default: `'row-major'`.
100
100
-**mode**: specifies how to handle indices which exceed array dimensions. For a list of supported modes, see [`ndarray`][@stdlib/ndarray/ctor]. Default: `'throw'`.
101
-
-**submode**: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions. If provided fewer modes than dimensions, the returned function recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
101
+
-**submode**: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions. If provided fewer modes than dimensions, an [ndarray][@stdlib/ndarray/ctor] instance recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
102
102
-**readonly**: `boolean` indicating whether an array should be **read-only**. Default: `false`.
103
103
104
104
By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a `float64` data type. To return an [ndarray][@stdlib/ndarray/ctor] having a different data type, set the `dtype` option.
@@ -174,7 +174,7 @@ The function accepts the following `options`:
174
174
-**dtype**: default output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or "generic". Default: `'float64'`.
175
175
-**order**: default array order (i.e., memory layout), which is either `row-major` (C-style) or `column-major` (Fortran-style). Default: `'row-major'`.
176
176
-**mode**: default specifying how to handle indices which exceed array dimensions. For a list of supported modes, see [`ndarray`][@stdlib/ndarray/ctor]. Default: `'throw'`.
177
-
-**submode**: default specifying for each dimension how to handle subscripts which exceed array dimensions. If provided fewer modes than dimensions, the constructor recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
177
+
-**submode**: default specifying for each dimension how to handle subscripts which exceed array dimensions. If the returned function is provided fewer modes than dimensions, an [ndarray][@stdlib/ndarray/ctor] instance recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
178
178
-**readonly**: default indicating whether an array should be **read-only**. Default: `false`.
179
179
180
180
To use a custom PRNG as the underlying source of uniformly distributed pseudorandom numbers, set the `prng` option.
@@ -208,7 +208,7 @@ The returned function accepts the following `options`, each of which overrides t
208
208
-**dtype**: output array data type. Must be a [real-valued floating-point data type][@stdlib/array/typed-real-float-dtypes] or "generic".
209
209
-**order**: array order (i.e., memory layout), which is either `row-major` (C-style) or `column-major` (Fortran-style).
210
210
-**mode**: specifies how to handle indices which exceed array dimensions. For a list of supported modes, see [`ndarray`][@stdlib/ndarray/ctor].
211
-
-**submode**: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions. If provided fewer modes than dimensions, the returned function recycles modes using modulo arithmetic.
211
+
-**submode**: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions. If provided fewer modes than dimensions, an [ndarray][@stdlib/ndarray/ctor] instance recycles modes using modulo arithmetic.
212
212
-**readonly**: `boolean` indicating whether an array should be **read-only**.
213
213
214
214
To override the default output array data type, set the `dtype` option.
<
8000
span class="CopyToClipboardButton-module__tooltip--Dq1IB prc-TooltipV2-Tooltip-cYMVY" data-direction="s" aria-label="Copy file name to clipboard" aria-hidden="true" id=":R9ndlab:">Copy file name to clipboardExpand all lines: docs/repl.txt
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -36,8 +36,8 @@
36
36
array dimensions using modulo arithmetic. If equal to 'clamp', an
37
37
ndarray instance sets a subscript exceeding array dimensions to either
38
38
`0` (minimum index) or the maximum index. If the number of modes is
39
-
fewer than the number of dimensions, the function recycles modes using
40
-
modulo arithmetic. Default: [ options.mode ].
39
+
fewer than the number of dimensions, an ndarray instance recycles modes
40
+
using modulo arithmetic. Default: [ options.mode ].
41
41
42
42
options.readonly: boolean (optional)
43
43
Boolean indicating whether an array should be read-only. Default: false.
@@ -145,8 +145,8 @@
145
145
subscripts exceeding array dimensions using modulo arithmetic. If equal
146
146
to 'clamp', an ndarray instance sets a subscript exceeding array
147
147
dimensions to either `0` (minimum index) or the maximum index. If the
148
-
number of modes is fewer than the number of dimensions, the returned
149
-
function recycles modes using modulo arithmetic. Default:
148
+
number of modes is fewer than the number of dimensions, an ndarray
149
+
instance recycles modes using modulo arithmetic. Default:
0 commit comments