Copy an input ndarray to a new ndarray having the same shape and data type.
var copy = require( '@stdlib/ndarray/copy' );Copies an input ndarray to a new ndarray having the same shape and data type.
var getShape = require( '@stdlib/ndarray/shape' );
var zeros = require( '@stdlib/ndarray/zeros' );
var x = zeros( [ 2, 2 ] );
// returns <ndarray>
var y = copy( x );
// returns <ndarray>
var sh = getShape( y );
// returns [ 2, 2 ]The function supports the following options:
- dtype: output ndarray data type. Overrides the input ndarray's inferred data type.
- order: specifies whether the output ndarray should be
'row-major'(C-style) or'column-major'(Fortran-style). Overrides the input ndarray's inferred order. - mode: specifies how to handle indices which exceed array dimensions (see
ndarray). Default:'throw'. - submode: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions (see
ndarray). If provided fewer modes than dimensions, the constructor recycles modes using modulo arithmetic. Default:[ options.mode ].
To override either the dtype or order, specify the corresponding option. For example, to override the inferred data type,
var getShape = require( '@stdlib/ndarray/shape' );
var getDtype = require( '@stdlib/ndarray/dtype' );
var zeros = require( '@stdlib/ndarray/zeros' );
var x = zeros( [ 2, 2 ] );
// returns <ndarray>
var dt = String( getDtype( x ) );
// returns 'float64'
var y = copy( x, {
'dtype': 'float32'
});
// returns <ndarray>
var sh = getShape( y );
// returns [ 2, 2 ]
dt = String( getDtype( y ) );
// returns 'float32'- The function performs a full copy in which an ndarray's underlying data is copied to a new underlying data buffer.
var uniform = require( '@stdlib/random/uniform' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var copy = require( '@stdlib/ndarray/copy' );
var x = uniform( [ 5, 2 ], -10.0, 10.0, {
'dtype': 'generic'
});
console.log( ndarray2array( x ) );
var y = copy( x );
console.log( ndarray2array( y ) );