All files assign.js

88.5% Statements 254/287
89.47% Branches 51/57
100% Functions 1/1
88.5% Lines 254/287

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 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 2883x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 183x 183x 183x 183x 183x 183x 183x 183x 183x 183x 183x 183x 183x 183x 183x 41x 41x 142x 142x 142x 142x 142x 142x 142x 142x 142x 142x 142x 142x 142x 142x 142x 142x 142x 142x 183x 24x 24x 11x 11x 13x 24x 10x 10x 24x 118x 118x 70x 70x 1x 1x 1x 1x 69x 69x 23x 23x 23x 23x 23x 10x 10x 23x 46x 46x 46x 4x 46x 16x 16x 42x 26x 26x 20x 46x 17x 17x 3x 46x     46x 70x 48x 48x 48x 48x 18x 18x 18x 18x 18x 9x 9x 9x 9x 30x 30x 17x 1x 17x 7x 7x 16x 9x 9x 8x 8x 8x 8x       13x 13x 13x 2x 13x 3x 3x 11x 8x 8x 5x 13x     5x 5x 5x 13x     13x 48x                                             183x 27x     27x 27x 25x 25x 27x 183x 1x 1x 33x 33x 33x 33x 33x 183x 29x 183x 4x 4x 33x 183x 3x 3x 3x 3x 3x  
/**
* @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 hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isFunction = require( '@stdlib/assert/is-function' );
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var broadcastScalar = require( '@stdlib/ndarray/base/broadcast-scalar' );
var maybeBroadcastArray = require( '@stdlib/ndarray/base/maybe-broadcast-array' );
var nonCoreShape = require( '@stdlib/ndarray/base/complement-shape' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var ndims = require( '@stdlib/ndarray/ndims' );
var format = require( '@stdlib/string/format' );
var defaults = require( '@stdlib/ndarray/defaults' );
var base = require( './base.js' ).assign;
 
 
// VARIABLES //
 
var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' );
 
 
// MAIN //
 
/**
* Returns the index of the first element along an ndarray dimension which passes a test implemented by a predicate function and assigns the results to a provided output ndarray.
*
* @param {ndarrayLike} x - input ndarray
* @param {(ndarrayLike|integer)} [fromIndex=0] - index from which to begin searching
* @param {ndarrayLike} out - output ndarray
* @param {Options} [options] - function options
* @param {integer} [options.dim=-1] - dimension over which to perform operation
* @param {Function} clbk - callback function
* @param {*} [thisArg] - callback execution context
* @throws {TypeError} function must be provided at least three arguments
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} `fromIndex` argument must be either an ndarray-like object or an integer
* @throws {TypeError} output argument must be an ndarray-like object
* @throws {TypeError} callback argument must be a function
* @throws {TypeError} options argument must be an object
* @throws {RangeError} dimension index must not exceed input ndarray bounds
* @throws {RangeError} first argument must have at least one dimension
* @throws {Error} must provide valid options
* @returns {ndarray} output ndarray
*
* @example
* var zeros = require( '@stdlib/ndarray/zeros' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* function isEven( v ) {
*     return v % 2.0 === 0.0;
* }
*
* // Create data buffers:
* var xbuf = [ 1.0, 2.0, -3.0, 4.0, -5.0, 6.0 ];
*
* // Define the shape of the input array:
* var shape = [ 2, 3 ];
*
* // Define the array strides:
* var strides = [ 3, 1 ];
*
* // Define the index offset:
* var offset = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'generic', xbuf, shape, strides, offset, 'row-major' );
*
* // Create an output ndarray:
* var y = zeros( [ 2 ], {
*     'dtype': 'int32'
* });
*
* // Perform operation:
* var out = assign( x, y, isEven );
* // returns <ndarray>[ 1, 0 ]
*
* var bool = ( out === y );
* // returns true
*/
function assign( x, fromIndex, out ) {
	var hasOptions;
	var options;
	var nargs;
	var opts;
	var fidx;
	var iflg;
	var ord;
	var ctx;
	var sh;
	var cb;
	var o;
 
	nargs = arguments.length;
	if ( !isndarrayLike( x ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be an ndarray. Value: `%s`.', x ) );
	}
	// Resolve input ndarray meta data:
	ord = getOrder( x );
 
	// Initialize an options object:
	opts = {
		'dims': [ -1 ] // default behavior is to perform a reduction over the last dimension
	};
 
	// Initialize the `fromIndex` to the first element along a dimension:
	fidx = 0;
 
	// Initialize a flag indicating whether the `fromIndex` argument is a scalar:
	iflg = true;
 
	// Initialize a flag indicating whether an `options` argument was provided:
	hasOptions = false;
 
	// Case: assign( x, out, clbk )
	if ( nargs <= 3 ) {
		o = fromIndex;
		if ( !isndarrayLike( o ) ) {
			throw new TypeError( format( 'invalid argument. Second argument must be an ndarray. Value: `%s`.', o ) );
		}
		cb = out;
		if ( !isFunction( cb ) ) {
			throw new TypeError( format( 'invalid argument. Third argument must be a function. Value: `%s`.', cb ) );
		}
	}
	// Case: assign( x, ???, ???, ??? )
	else if ( nargs === 4 ) {
		// Case: assign( x, out, clbk, thisArg )
		if ( isndarrayLike( fromIndex ) && isFunction( out ) ) {
			o = fromIndex;
			cb = out;
			ctx = arguments[ 3 ];
		}
		// Case: assign( x, out, options, clbk )
		else if ( isndarrayLike( fromIndex ) && isPlainObject( out ) ) {
			o = fromIndex;
			options = out;
			hasOptions = true;
			cb = arguments[ 3 ];
			if ( !isFunction( cb ) ) {
				throw new TypeError( format( 'invalid argument. Fourth argument must be a function. Value: `%s`.', cb ) );
			}
		}
		// Case: assign( x, from_index, out, clbk )
		else {
			if ( isInteger( fromIndex ) ) {
				fidx = fromIndex;
			} else if ( isndarrayLike( fromIndex ) ) {
				fidx = fromIndex;
				iflg = false;
			} else {
				throw new TypeError( format( 'invalid argument. Second argument must be either an ndarray or an integer. Value: `%s`.', fromIndex ) );
			}
			o = out;
			if ( !isndarrayLike( o ) ) {
				throw new TypeError( format( 'invalid argument. Third argument must be an ndarray. Value: `%s`.', o ) );
			}
			cb = arguments[ 3 ];
			if ( !isFunction( cb ) ) {
				throw new TypeError( format( 'invalid argument. Fourth argument must be a function. Value: `%s`.', cb ) );
			}
		}
	}
	// Case: assign( x, ???, ???, ???, ??? )
	else if ( nargs === 5 ) {
		// Case: assign( x, out, options, clbk, thisArg )
		if ( isndarrayLike( fromIndex ) && isPlainObject( out ) ) {
			o = fromIndex;
			options = out;
			hasOptions = true;
			cb = arguments[ 3 ];
			if ( !isFunction( cb ) ) {
				throw new TypeError( format( 'invalid argument. Fourth argument must be a function. Value: `%s`.', cb ) );
			}
			ctx = arguments[ 4 ];
		}
		// Case: assign( x, from_index, out, clbk, thisArg )
		else if ( isFunction( arguments[ 3 ] ) ) {
			if ( isInteger( fromIndex ) ) {
				fidx = fromIndex;
			} else if ( isndarrayLike( fromIndex ) ) {
				fidx = fromIndex;
				iflg = false;
			} else {
				throw new TypeError( format( 'invalid argument. Second argument must be either an ndarray or an integer. Value: `%s`.', fromIndex ) );
			}
			o = out;
			if ( !isndarrayLike( o ) ) {
				throw new TypeError( format( 'invalid argument. Third argument must be an ndarray. Value: `%s`.', o ) );
			}
			cb = arguments[ 3 ];
			ctx = arguments[ 4 ];
		}
		// Case: assign( x, from_index, out, options, clbk )
		else {
			if ( isInteger( fromIndex ) ) {
				fidx = fromIndex;
			} else if ( isndarrayLike( fromIndex ) ) {
				fidx = fromIndex;
				iflg = false;
			} else {
				throw new TypeError( format( 'invalid argument. Second argument must be either an ndarray or an integer. Value: `%s`.', fromIndex ) );
			}
			o = out;
			if ( !isndarrayLike( o ) ) {
				throw new TypeError( format( 'invalid argument. Third argument must be an ndarray. Value: `%s`.', o ) );
			}
			options = arguments[ 3 ];
			hasOptions = true;
			cb = arguments[ 4 ];
			if ( !isFunction( cb ) ) {
				throw new TypeError( format( 'invalid argument. Fifth argument must be a function. Value: `%s`.', cb ) );
			}
		}
	}
	// Case: assign( x, from_index, out, options, clbk, thisArg )
	else {
		if ( isInteger( fromIndex ) ) {
			fidx = fromIndex;
		} else if ( isndarrayLike( fromIndex ) ) {
			fidx = fromIndex;
			iflg = false;
		} else {
			throw new TypeError( format( 'invalid argument. Second argument must be either an ndarray or an integer. Value: `%s`.', fromIndex ) );
		}
		o = out;
		if ( !isndarrayLike( o ) ) {
			throw new TypeError( format( 'invalid argument. Third argument must be an ndarray. Value: `%s`.', o ) );
		}
		options = arguments[ 3 ];
		hasOptions = true;
		cb = arguments[ 4 ];
		if ( !isFunction( cb ) ) {
			throw new TypeError( format( 'invalid argument. Fifth argument must be a function. Value: `%s`.', cb ) );
		}
		ctx = arguments[ 5 ];
	}
	if ( hasOptions ) {
		if ( !isPlainObject( options ) ) {
			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
		}
		// Resolve provided options...
		if ( hasOwnProp( options, 'dim' ) ) {
			opts.dims[ 0 ] = options.dim;
		}
	}
	if ( ndims( x ) < 1 ) {
		throw new RangeError( 'invalid argument. First argument must have at least one dimension.' );
	}
	// Resolve the list of non-reduced dimensions:
	sh = getShape( x );
	sh = nonCoreShape( sh, opts.dims );
 
	// Broadcast the `fromIndex` to match the shape of the non-reduced dimensions...
	if ( iflg ) {
		fidx = broadcastScalar( fidx, DEFAULT_DTYPE, sh, ord );
	} else {
		fidx = maybeBroadcastArray( fidx, sh );
	}
	return base( x, fidx, o, opts, cb, ctx );
}
 
 
// EXPORTS //
 
module.exports = assign;