All files assign.js

100% Statements 141/141
100% Branches 28/28
100% Functions 1/1
100% Lines 141/141

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 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 1422x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 3x 3x 17x 4x 4x 16x 16x 4x 17x 10x 7x 10x 3x 3x 3x 10x 14x 17x 3x 3x 11x 11x 11x 17x 36x 18x 18x 3x 3x 15x 15x 36x 17x 6x 6x 6x 8x 8x 17x 32x 14x 6x 6x 32x 12x 18x 6x 6x 32x 8x 17x 2x 2x 2x 2x 2x  
/**
* @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 broadcastScalar = require( '@stdlib/ndarray/base/broadcast-scalar' );
var concat = require( '@stdlib/ndarray/concat' );
var ndims = require( '@stdlib/ndarray/base/ndims' );
var isArray = require( '@stdlib/assert/is-array' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var broadcastArray = require( '@stdlib/ndarray/broadcast-array' );
var format = require( '@stdlib/string/format' );
var defaults = require( '@stdlib/ndarray/defaults' );
var normalizeArrays = require( './normalize_arrays.js' );
var resolveDataTypes = require( './resolve_dtypes.js' );
var resolveOrder = require( './resolve_order.js' );
 
 
// VARIABLES //
 
var DEFAULT_ORDER = defaults.get( 'order' );
var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
 
 
// MAIN //
 
/**
* Concatenates provided input arguments and assigns the result to a provided one-dimensional output ndarray.
*
* @param {...*} args - input arguments
* @param {ndarray} out - output ndarray
* @throws {Error} function must be provided an array of inputs or more than one separate input arguments and an output ndarray
* @throws {RangeError} function must be provided a one-dimensional ndarray or a zero-dimensional ndarray
* @throws {Error} output argument must be a one-dimensional ndarray-like object
* @returns {ndarray} output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var empty = require( '@stdlib/ndarray/empty' );
* var ndarray2array = require( '@stdlib/ndarray/to-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 z = empty( [ 10 ] );
*
* var out = assign( x, y, z );
* // returns <ndarray>
*
* var bool = ( out === z );
* // returns true
*
* var arr = ndarray2array( z );
* // returns [ -1.0, 2.0, 3.0, 4.0, -5.0, 6.0, -7.0, -8.0, 9.0, -10.0 ]
*/
function assign() {
	var nargs;
	var args;
	var arrs;
	var ord;
	var out;
	var dt;
	var i;
	var d;
 
	nargs = arguments.length;
 
	// Resolve function arguments...
	if ( nargs < 2 ) {
		throw new Error( format( 'invalid argument. The function must be provided an array of inputs or more than one separate input arguments and an output ndarray. Value: `%s`.', nargs ) );
	}
	if ( nargs > 2 ) {
		args = [];
		for ( i = 0; i < nargs - 1; i++ ) {
			args.push( arguments[ i ] );
		}
	}
	if ( nargs === 2 ) {
		if ( isArray( arguments[ 0 ] ) ) {
			args = arguments[ 0 ];
		} else {
			args = [];
			args.push( arguments[ 0 ] );
		}
	}
	out = arguments[ nargs - 1 ];
	if ( !isndarrayLike( out ) || ndims( out ) !== 1 ) {
		throw new Error( format( 'invalid argument. Output argument must be a one-dimensional ndarray. Value: `%s`.', out ) );
	}
 
	// Resolve the `dtype` and `order` of input ndarrays...
	arrs = [];
	for ( i = 0; i < args.length; i++ ) {
		if ( isndarrayLike( args[ i ] ) ) {
			d = ndims( args[ i ] );
			if ( d > 1 ) {
				throw new RangeError( format( 'invalid argument. The function must be provided a one-dimensional ndarray or a zero-dimensional ndarray.. Value: `%s`.', d ) );
			}
			arrs.push( args[ i ] );
		}
	}
	if ( arrs.length >= 1 ) {
		dt = resolveDataTypes( arrs );
		ord = resolveOrder( arrs );
	}
 
	// Broadcast scalar or 0d ndarray inputs...
	for ( i = 0; i < args.length; i++ ) {
		if ( isndarrayLike( args[ i ] ) ) {
			if ( ndims( args[ i ] ) === 0 ) {
				args[ i ] = broadcastArray( args[ i ], [ 1 ] );
			}
		} else if ( !dt && !ord ) {
			args[ i ] = broadcastScalar( args[ i ], DEFAULT_DTYPE, [ 1 ], DEFAULT_ORDER ); // eslint-disable-line max-len
		} else {
			args[ i ] = broadcastScalar( args[ i ], dt, [ 1 ], ord );
		}
	}
	return concat.assign( normalizeArrays( args ), out );
}
 
 
// EXPORTS //
 
module.exports = assign;