File: repl.txt

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (44 lines) | stat: -rw-r--r-- 1,180 bytes parent folder | download
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

{{alias}}( collection )
    Removes and returns the last element of a collection.

    The function returns an array with two elements: the shortened collection
    and the removed element.

    If the input collection is a typed array whose length is greater than `0`,
    the first return value does not equal the input reference.

    For purposes of generality, always treat the output collection as distinct
    from the input collection.

    Parameters
    ----------
    collection: Array|TypedArray|Object
        A collection. If the collection is an `Object`, the value should be
        array-like.

    Returns
    -------
    out: Array
        Updated collection and the removed item.

    Examples
    --------
    // Arrays:
    > var arr = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
    > var out = {{alias}}( arr )
    [ [ 1.0, 2.0, 3.0, 4.0 ], 5.0 ]

    // Typed arrays:
    > arr = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0 ] );
    > out = {{alias}}( arr )
    [ <Float64Array>[ 1.0 ], 2.0 ]

    // Array-like object:
    > arr = { 'length': 2, '0': 1.0, '1': 2.0 };
    > out = {{alias}}( arr )
    [ { 'length': 1, '0': 1.0 }, 2.0 ]

    See Also
    --------