slice

Return a shallow copy of a portion of an array.

Usage

var slice = require( '@stdlib/array/base/slice' );

slice( x, start, end )

Returns a shallow copy of a portion of an array from an inclusive start index to an exclusive end index.

var x = [ 1, 2, 3, 4, 5, 6 ];

var out = slice( x, 1, 4 );
// returns [ 2, 3, 4 ]

var bool = ( out === x );
// returns false

Notes

  • If provided an array-like object having a slice method, the function defers execution to that method and assumes that the method API has the following signature:

    x.slice( start, end )
    
  • If provided an array-like object without a slice method, the function copies input array elements to a new generic array.

Examples

var Float64Array = require( '@stdlib/array/float64' );
var zeroTo = require( '@stdlib/array/base/zero-to' );
var slice = require( '@stdlib/array/base/slice' );

var x = new Float64Array( zeroTo( 6 ) );
// returns <Float64Array>[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]

var s = slice( x, 0, 6 );
// returns <Float64Array>[ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ]

s = slice( x, 0, 4 );
// returns <Float64Array>[ 0.0, 1.0, 2.0, 3.0 ]

s = slice( x, 2, 6 );
// returns <Float64Array>[ 2.0, 3.0, 4.0, 5.0 ]

s = slice( x, 2, 4 );
// returns <Float64Array>[ 2.0, 3.0 ]
Did you find this page helpful?