Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
// MODULES //
var isArrayLikeObject = require( '@stdlib/assert/is-array-like-object' );
var promoteDataTypes = require( '@stdlib/ndarray/base/promote-dtypes' );
var normalizeIndex = require( '@stdlib/ndarray/base/normalize-index' );
var ndims = require( '@stdlib/ndarray/base/ndims' );
var empty = require( '@stdlib/ndarray/empty' );
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
var normalizeArrays = require( './normalize_arrays.js' );
var broadcastArrays = require( './broadcast_arrays.js' );
var resolveDataTypes = require( './resolve_dtypes.js' );
var resolveShape = require( './resolve_shape.js' );
var resolveOrder = require( './resolve_order.js' );
var validate = require( './validate.js' );
var base = require( './base.js' );
// MAIN //
/**
* Concatenates a list of ndarrays along a specified ndarray dimension.
*
* @param {ArrayLikeObject<ndarrayLike>} arrays - array-like object containing input ndarrays
* @param {Options} [options] - function options
* @param {integer} [options.dim=-1] - dimension along which to concatenate the input ndarrays
* @throws {TypeError} first argument must be an array of ndarray-like objects
* @throws {RangeError} first argument must contain one or more ndarrays
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @throws {Error} must provide ndarrays which can be safely cast to a common data type
* @returns {ndarray} output ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* var xbuf = new Float64Array( [ -1.0, 2.0, -3.0, 4.0 ] );
* var x = new ndarray( 'float64', xbuf, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
*
* var ybuf = new Float64Array( [ -5.0, 6.0, -7.0, 8.0, -9.0, 10.0 ] );
* var y = new ndarray( 'float64', ybuf, [ 2, 3 ], [ 3, 1 ], 0, 'row-major' );
*
* var out = concat( [ x, y ] );
* // returns <ndarray>[ [ -1.0, 2.0, -5.0, 6.0, -7.0 ], [ -3.0, 4.0, 8.0, -9.0, 10.0 ] ]
*/
function concat( arrays ) {
var opts;
var arrs;
var err;
var out;
var dt;
var d;
if ( !isArrayLikeObject( arrays ) || arrays.length < 1 ) {
throw new TypeError( format( 'invalid argument. First argument must be an array of ndarrays. Value: `%s`.', arrays ) );
}
opts = {
'dim': -1
};
if ( arguments.length > 1 ) {
err = validate( opts, arguments[ 1 ] );
if ( err ) {
throw err;
}
}
// Normalize the list of input ndarrays:
arrs = normalizeArrays( arrays );
// Broadcast the input ndarrays to a common shape:
arrs = broadcastArrays( arrs, opts.dim );
// Resolve the data type of the output ndarray by applying type promotion rules to the data types of the input ndarrays:
dt = promoteDataTypes( resolveDataTypes( arrs ) );
if ( dt === null ) {
throw new Error( format( 'invalid argument. Unable to apply type promotion rules when resolving a data type to which the input ndarrays can be safely cast. Data types: [%s].', join( resolveDataTypes( arrs ), ', ' ) ) );
}
// Normalize the dimension index:
d = normalizeIndex( opts.dim, ndims( arrs[ 0 ] )-1 );
// Create an output ndarray:
out = empty( resolveShape( arrs, d ), {
'dtype': dt,
'order': resolveOrder( arrs )
});
// Perform concatenation:
return base( arrs, d, out );
}
// EXPORTS //
module.exports = concat;
|