Concatenate a list of ndarrays along a specified ndarray dimension.
var concat = require( '@stdlib/ndarray/concat' );Concatenates a list of ndarrays along a specified ndarray dimension.
var array = require( '@stdlib/ndarray/array' );
var x = array( [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] );
var y = array( [ [ -5.0, 6.0, -7.0 ], [ 8.0, -9.0, 10.0 ] ] );
var out = concat( [ x, y ], {
'dim': -1
});
// returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]The function accepts the following arguments:
- arrays: a list of input ndarrays. Must be broadcast compatible except for the dimension along which to concatenate. The data type of the output ndarray is determined by applying type promotion rules to the list of input ndarrays. If provided ndarrays having different memory layouts, the output ndarray has the default order.
- options: function options (optional).
The function accepts the following options:
- dim: dimension along which to concatenate input ndarrays. Must be a negative integer. The index of the dimension along which to concatenate is resolved relative to the last dimension, with the last dimension corresponding to the value
-1. Default:-1.
Concatenates a list of ndarrays along a specified ndarray dimension and assigns results to an 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 = array( [ [ -5.0, 6.0, -7.0 ], [ 8.0, -9.0, 10.0 ] ] );
var z = zeros( [ 2, 5 ] );
var out = concat.assign( [ x, y ], z, {
'dim': -1
});
// returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
var bool = ( out === z );
// returns trueThe function accepts the following arguments:
- arrays: a list of input ndarrays. Must be broadcast compatible except for the dimension along which to concatenate. Must promote to a data type which can be (mostly) safely cast to the data type of the output ndarray.
- out: output ndarray.
- options: function options (optional).
The function accepts the following options:
- dim: dimension along which to concatenate input ndarrays. Must be a negative integer. The index of the dimension along which to concatenate is resolved relative to the last dimension, with the last dimension corresponding to the value
-1. Default:-1.
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var ndarray = require( '@stdlib/ndarray/ctor' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var concat = require( '@stdlib/ndarray/concat' );
var xbuf = discreteUniform( 6, 0, 10, {
'dtype': 'generic'
});
var x = new ndarray( 'generic', xbuf, [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );
var ybuf = discreteUniform( 8, 0, 10, {
'dtype': 'generic'
});
var y = new ndarray( 'generic', ybuf, [ 2, 4 ], [ 4, 1 ], 0, 'row-major' );
console.log( ndarray2array( y ) );
var out = concat( [ x, y ] );
console.log( ndarray2array( out ) );