stdlib/lib/node_modules/@stdlib/ndarray/push/docs/repl.txt at 92a67f975a102a9affed4c6fb7563845752fd032 · 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

{{alias}}( x, ...values )
    Returns a one-dimensional ndarray formed by appending the provided scalar
    values to the input ndarray.

    Parameters
    ----------
    x: ndarray
        Input ndarray.

    values: ...any
        Scalar values to append.

    Returns
    -------
    out: ndarray
        Output ndarray.

    Examples
    --------
    > var x = {{alias:@stdlib/ndarray/array}}( [ 1.0, 2.0, 3.0, 4.0 ] );
    > var out = {{alias}}( x, 5.0, 6.0 )
    <ndarray>
    > var arr = {{alias:@stdlib/ndarray/to-array}}( out )
    [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]


{{alias}}.assign( x, ...values, out )
    Appends the provided scalar values to the input ndarray and assigns the
    result to a provided one-dimensional output ndarray.

    Parameters
    ----------
    x: ndarray
        Input ndarray.

    values: ...any
        Scalar values to append.

    out: ndarray
        Output ndarray.

    Returns
    -------
    out: ndarray
        Output ndarray.

    Examples
    --------
    > var x = {{alias:@stdlib/ndarray/array}}( [ 1.0, 2.0 ] );
    > var y = {{alias:@stdlib/ndarray/array}}( [ 0.0, 0.0, 0.0, 0.0 ] );
    > var out = {{alias}}.assign( x, 3.0, 4.0, y )
    <ndarray>
    > var bool = ( out === y )
    true
    > var arr = {{alias:@stdlib/ndarray/to-array}}( out )
    [ 1.0, 2.0, 3.0, 4.0 ]

    See Also
    --------