All files / concat/lib broadcast_arrays.js

62.5% Statements 45/72
100% Branches 1/1
0% Functions 0/1
62.5% Lines 45/72

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 731x 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 broadcastArrayExceptDimensions = require( '@stdlib/ndarray/base/broadcast-array-except-dimensions' ); // eslint-disable-line id-length
var getShape = require( '@stdlib/ndarray/base/shape' );
 
 
// MAIN //
 
/**
* Broadcasts a list of input ndarrays to a common shape.
*
* ## Notes
*
* -   The function mutates the input array.
*
* @private
* @param {Array<ndarray>} arrays - list of input ndarrays
* @param {NegativeInteger} dim - dimension along which to concatenate input ndarrays
* @returns {Array<ndarray>} list of broadcasted ndarrays
*/
function broadcastArrays( arrays, dim ) {
	var dims;
	var tmp;
	var sh;
	var i;
	var j;

	// Find the shape of the ndarray with the most dimensions...
	sh = getShape( arrays[ 0 ], false );
	j = 0;
	for ( i = 1; i < arrays.length; i++ ) {
		tmp = getShape( arrays[ i ], false );
		if ( tmp.length > sh.length ) {
			sh = tmp;
			j = i;
		}
	}
	// Broadcast ndarrays to the shape with the most dimensions...
	dims = [ dim ];
	for ( i = 0; i < arrays.length; i++ ) {
		if ( i === j ) {
			continue;
		}
		arrays[ i ] = broadcastArrayExceptDimensions( arrays[ i ], sh, dims );
	}
	return arrays;
}
 
 
// EXPORTS //
 
module.exports = broadcastArrays;