All files / blas/ext/index-of/lib assign.js

98.87% Statements 176/178
96.29% Branches 26/27
100% Functions 1/1
98.87% Lines 176/178

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 1793x 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 238x 238x 238x 238x 238x 238x 238x 238x 238x 3x 3x 235x 238x 120x 120x 115x 115x 115x 115x 115x 115x 115x 115x 115x 238x 5x 5x 5x 110x 110x 110x 110x 110x 46x 110x 30x 30x 30x 30x 80x 80x 55x 36x 36x 19x 19x 79x 79x 238x 39x 238x 40x 40x 77x 77x 238x 20x 238x 57x 57x 71x 71x 238x 28x 238x 43x 43x     65x 65x 238x 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 objectAssign = require( '@stdlib/object/assign' );
var isObject = require( '@stdlib/assert/is-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 getDType = require( '@stdlib/ndarray/dtype' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var format = require( '@stdlib/string/format' );
var defaults = require( '@stdlib/ndarray/defaults' );
var nonCoreShape = require( './non_core_shape.js' );
var base = require( './base.js' ).assign;
 
 
// VARIABLES //
 
var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' );
 
 
// MAIN //
 
/**
* Returns the first index of a specified search element along one or more ndarray dimensions and assigns the results to a provided output ndarray.
*
* @name assign
* @type {Function}
* @param {ndarrayLike} x - input ndarray
* @param {(ndarrayLike|*)} searchElement - search element
* @param {(ndarrayLike|integer)} [fromIndex] - index from which to begin searching
* @param {ndarrayLike} out - output ndarray
* @param {Options} [options] - function options
* @param {IntegerArray} [options.dims] - list of dimensions over which to perform operation
* @throws {TypeError} function must be provided at least three arguments
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} third argument must be either an ndarray-like object or an integer
* @throws {TypeError} fourth argument must be an ndarray-like object
* @throws {TypeError} options argument must be an object
* @throws {RangeError} dimension indices must not exceed input ndarray bounds
* @throws {RangeError} number of dimension indices must not exceed the number of input ndarray dimensions
* @throws {Error} must provide valid options
* @returns {ndarray} output ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var zeros = require( '@stdlib/ndarray/zeros' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create data buffers:
* var xbuf = new Float64Array( [ 1.0, 2.0, -3.0, 4.0, -5.0, 6.0 ] );
*
* // Define the shape of the input array:
* var shape = [ 3, 1, 2 ];
*
* // Define the array strides:
* var strides = [ 2, 2, 1 ];
*
* // Define the index offset:
* var offset = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'float64', xbuf, shape, strides, offset, 'row-major' );
*
* // Create an output ndarray:
* var y = zeros( [], {
*     'dtype': 'int32'
* });
*
* // Perform operation:
* var out = assign( x, 4.0, y );
* // returns <ndarray>
*
* var bool = ( out === y );
* // returns true
*
* var idx = out.get();
* // returns 3
*/
function assign( x, searchElement, fromIndex, out, options ) {
	var nargs;
	var opts;
	var ord;
	var dt;
	var sh;
 
	nargs = arguments.length;
	if ( nargs < 3 ) {
		throw new TypeError( format( 'invalid argument. The function must be provided at least two arguments. Value: `%s`.', nargs ) );
	}
 
	if ( !isndarrayLike( x ) ) {
		throw new TypeError( format( 'invalid argument. The first argument must be an ndarray-like object. Value: `%s`.', x ) );
	}
 
	// Resolve input ndarray meta data:
	dt = getDType( x );
	ord = getOrder( x );
 
	// Initialize options object:
	opts = {};
 
	// Case: assign( x, searchElement, out )
	if ( nargs === 3 ) {
		out = fromIndex;
		fromIndex = 0;
	}
	// Case: assign( x, searchElement, out, options )
	else if (
		nargs === 4 &&
		isndarrayLike( fromIndex ) &&
		!isndarrayLike( out ) &&
		isObject( out )
	) {
		opts = objectAssign( opts, out );
		out = fromIndex;
		fromIndex = 0;
	}
	// Case: assign( x, searchElement, fromIndex, out, options )
	else if ( nargs === 5 ) {
		if ( !isObject( options ) ) {
			throw new TypeError( format( 'invalid argument. The fifth argument must be an object. Value: `%s`.', options ) );
		}
		opts = objectAssign( opts, options );
	}
 
	// Resolve shape for broadcasting
	if ( hasOwnProp( opts, 'dims' ) ) {
		sh = nonCoreShape( getShape( x ), opts.dims );
	} else {
		sh = [];
	}
 
	// Normalize search element:
	if ( isndarrayLike( searchElement ) ) {
		searchElement = maybeBroadcastArray( searchElement, sh );
	} else {
		searchElement = broadcastScalar( searchElement, dt, sh, ord );
	}
 
	// Normalize from index:
	if ( isndarrayLike( fromIndex ) ) {
		fromIndex = maybeBroadcastArray( fromIndex, sh );
	} else if ( isInteger( fromIndex ) ) {
		fromIndex = broadcastScalar( fromIndex, DEFAULT_DTYPE, sh, ord );
	} else {
		throw new TypeError( format( 'invalid argument. Third argument must be either an ndarray or an integer. Value: `%s`.', fromIndex ) );
	}
 
	return base( x, searchElement, fromIndex, out, opts );
}
 
 
// EXPORTS //
 
module.exports = assign;