Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

unshift

Return a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray.

Usage

var unshift = require( '@stdlib/ndarray/unshift' );

unshift( x, ...values )

Returns a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray.

var array = require( '@stdlib/ndarray/array' );

var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );

var out = unshift( x, -2.0, -1.0, 0.0 );
// returns <ndarray>[ -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]

The function accepts the following arguments:

  • x: input ndarray. Must be one-dimensional.
  • ...values: scalar values to prepend.

unshift.assign( x, ...values, out )

Prepends provided scalar values to a one-dimensional input ndarray and assigns the result to a provided one-dimensional output ndarray.

var array = require( '@stdlib/ndarray/array' );
var zeros = require( '@stdlib/ndarray/zeros' );

var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
var y = zeros( [ 7 ] );

var out = unshift.assign( x, -2.0, -1.0, 0.0, y );
// returns <ndarray>[ -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]

var bool = ( out === y );
// returns true

The function accepts the following arguments:

  • x: input ndarray. Must be one-dimensional.
  • ...values: scalar values to prepend.
  • out: output ndarray. Must be one-dimensional.

Notes

Examples

var discreteUniform = require( '@stdlib/random/discrete-uniform' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var unshift = require( '@stdlib/ndarray/unshift' );

var opts = {
    'dtype': 'generic'
};
var x = discreteUniform( [ 6 ], 0, 10, opts );
console.log( ndarray2array( x ) );

var out = unshift( x, 12, 14 );
console.log( ndarray2array( out ) );