stdlib/lib/node_modules/@stdlib/ndarray/base/unflatten-shape/docs/repl.txt at 2444ee053e9edba973b97066fd61713bd6688f2c · headlessNode/stdlib · GitHub

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

{{alias}}( shape, dim, sizes )
    Expands a dimension over multiple dimensions.

    Parameters
    ----------
    shape: ArrayLike<number>
        Array shape.

    dim: integer
        Dimension to be unflattened. If less than zero, the index is resolved
        relative to the last dimension, with the last dimension corresponding to
        the value `-1`.

    sizes: ArrayLike<number>
        New shape of the unflattened dimension.

    Returns
    -------
    out: Array<number>
        Unflattened shape.

    Examples
    --------
    > var sh = [ 6, 2, 1 ];
    > var sizes = [ 3, 2 ];
    > var out = {{alias}}( sh, 0, sizes )
    [ 3, 2, 2, 1 ]


{{alias}}.assign( shape, dim, sizes, out )
    Expands a dimension over multiple dimensions and assigns results to a
    provided output array.

    Parameters
    ----------
    shape: ArrayLike<number>
        Array shape.

    dim: integer
        Dimension to be unflattened. If less than zero, the index is resolved
        relative to the last dimension, with the last dimension corresponding to
        the value `-1`.

    sizes: ArrayLike<number>
        New shape of the unflattened dimension.

    out: Array|TypedArray|Object
        Output array.

    Returns
    -------
    out: Array|TypedArray|Object
        Output array.

    Examples
    --------
    > var sh = [ 6, 2, 1 ];
    > var sizes = [ 3, 2 ];
    > var o = [ 0, 0, 0, 0 ];
    > var out = {{alias}}.assign( sh, 0, sizes, o )
    [ 3, 2, 2, 1 ]
    > var bool = ( o === out )
    true

    See Also
    --------