1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
{{alias}}( shape, idx[, options] )
Converts a linear index to an array of subscripts.
Parameters
----------
shape: ArrayLike
Array shape.
idx: integer
Linear index.
options: Object (optional)
Options.
options.order: string (optional)
Specifies whether an array is row-major (C-style) or column-major
(Fortran style). Default: 'row-major'.
options.mode: string (optional)
Specifies how to handle a linear index which exceeds array dimensions.
If equal to 'throw', the function throws an error when a linear index
exceeds array dimensions. If equal to 'wrap', the function wraps around
a linear index exceeding array dimensions using modulo arithmetic. If
equal to 'clamp', the function sets a linear index exceeding array
dimensions to either `0` (minimum linear index) or the maximum linear
index. Default: 'throw'.
Returns
-------
out: Array<integer>
Subscripts.
Examples
--------
> var d = [ 3, 3, 3 ];
> var s = {{alias}}( d, 17 )
[ 1, 2, 2 ]
{{alias}}.assign( shape, idx[, options], out )
Converts a linear index to an array of subscripts and assigns results to a
provided output array.
Parameters
----------
shape: ArrayLike
Array shape.
idx: integer
Linear index.
options: Object (optional)
Options.
options.order: string (optional)
Specifies whether an array is row-major (C-style) or column-major
(Fortran style). Default: 'row-major'.
options.mode: string (optional)
Specifies how to handle a linear index which exceeds array dimensions.
If equal to 'throw', the function throws an error when a linear index
exceeds array dimensions. If equal to 'wrap', the function wraps around
a linear index exceeding array dimensions using modulo arithmetic. If
equal to 'clamp', the function sets a linear index exceeding array
dimensions to either `0` (minimum linear index) or the maximum linear
index. Default: 'throw'.
out: Array|TypedArray|Object
Output array.
Returns
-------
out: Array|TypedArray|Object
Subscripts.
Examples
--------
> var d = [ 3, 3, 3 ];
> var out = [ 0, 0, 0 ];
> var s = {{alias}}.assign( d, 17, out )
[ 1, 2, 2 ]
> var bool = ( s === out )
true
See Also
--------
|
