All files / rowcat/lib assign.js

62.9% Statements 78/124
100% Branches 1/1
0% Functions 0/1
62.9% Lines 78/124

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 116 117 118 119 120 121 122 123 124 1251x 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 1x                                                                                             1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var ndarraylike2ndarray = require( '@stdlib/ndarray/base/ndarraylike2ndarray' );
var prependSingletonDimensions = require( '@stdlib/ndarray/base/prepend-singleton-dimensions' );
var ndims = require( '@stdlib/ndarray/base/ndims' );
var getShape = require( '@stdlib/ndarray/base/shape' );
var concat = require( '@stdlib/ndarray/concat' ).assign;
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Concatenates a list of one-dimensional or two-dimensional ndarrays as rows and assigns results to a provided output ndarray.
*
* ## Notes
*
* -   One-dimensional input ndarrays having length `N` are promoted to two-dimensional ndarrays having shape `[1, N]`.
* -   Input ndarrays must have the same number of columns.
*
* @param {ArrayLikeObject<ndarrayLike>} arrays - array-like object containing input ndarrays
* @param {ndarrayLike} out - output ndarray
* @throws {TypeError} first argument must be an array-like object
* @throws {RangeError} first argument must contain one or more ndarrays
* @throws {TypeError} first argument must contain ndarray-like objects
* @throws {TypeError} second argument must be an ndarray-like object
* @throws {RangeError} second argument must be a two-dimensional ndarray
* @throws {RangeError} must provide one- or two-dimensional ndarrays
* @throws {Error} must provide ndarrays having the same number of columns
* @throws {Error} must provide ndarrays which can be safely cast to a common data type
* @returns {ndarrayLike} output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x = array( [ 1.0, 2.0, 3.0 ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0 ]
*
* var y = array( [ [ 4.0, 5.0, 6.0 ], [ 7.0, 8.0, 9.0 ] ] );
* // returns <ndarray>[ [ 4.0, 5.0, 6.0 ], [ 7.0, 8.0, 9.0 ] ]
*
* var z = zeros( [ 3, 3 ] );
* // returns <ndarray>[ [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ] ]
*
* var out = assign( [ x, y ], z );
* // returns <ndarray>[ [ 1.0, 2.0, 3.0 ], [ 4.0, 5.0, 6.0 ], [ 7.0, 8.0, 9.0 ] ]
*
* var bool = ( out === z );
* // returns true
*/
function assign( arrays, out ) {
	var ncols;
	var arrs;
	var arr;
	var sh;
	var n;
	var i;

	if ( !isArrayLikeObject( arrays ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be an array-like object. Value: `%s`.', arrays ) );
	}
	if ( arrays.length < 1 ) {
		throw new RangeError( format( 'invalid argument. First argument must contain one or more ndarrays. Value: `%s`.', arrays ) );
	}
	if ( !isndarrayLike( out ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be an ndarray. Value: `%s`.', out ) );
	}
	if ( ndims( out ) !== 2 ) {
		throw new RangeError( format( 'invalid argument. Second argument must be a two-dimensional ndarray. Number of dimensions: `%u`.', ndims( out ) ) );
	}
	arrs = [];
	for ( i = 0; i < arrays.length; i++ ) {
		arr = arrays[ i ];
		if ( !isndarrayLike( arr ) ) {
			throw new TypeError( format( 'invalid argument. First argument must be an array-like object containing one or more ndarrays. Value: `%s`.', arr ) );
		}
		n = ndims( arr );
		if ( n !== 1 && n !== 2 ) {
			throw new RangeError( format( 'invalid argument. Must provide one- or two-dimensional ndarrays. Number of dimensions: `%u`.', n ) );
		}
		if ( n === 1 ) {
			arr = prependSingletonDimensions( ndarraylike2ndarray( arr ), 1, false );
		}
		sh = getShape( arr, false );
		if ( i === 0 ) {
			ncols = sh[ 1 ];
		} else if ( sh[ 1 ] !== ncols ) {
			throw new Error( format( 'invalid argument. All ndarrays must have the same number of columns. Expected number of columns: `%u`. Actual number of columns: `%u`.', ncols, sh[ 1 ] ) );
		}
		arrs.push( arr );
	}
	concat( arrs, out, {
		'dim': -2
	});
	return out;
}
 
 
// EXPORTS //
 
module.exports = assign;