All files assign.js

100% Statements 142/142
100% Branches 22/22
100% Functions 1/1
100% Lines 142/142

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 1433x 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 146x 146x 146x 146x 146x 146x 146x 146x 146x 146x 146x 40x 40x 146x 40x 40x 66x 146x 13x 9x 9x 4x 4x 53x 53x 18x 18x 18x 18x 9x 9x 9x 9x 35x 35x 1x 1x 1x 34x 34x 16x 16x 16x 16x 18x 18x 18x 18x 30x 30x 30x 30x 30x 30x 30x 146x 25x 16x 16x 9x 9x 5x 146x 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 isObject = require( '@stdlib/assert/is-plain-object' );
var isFunction = require( '@stdlib/assert/is-function' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var reverse = require( '@stdlib/ndarray/base/reverse' );
var base = require( '@stdlib/ndarray/find' ).assign;
var format = require( '@stdlib/string/format' );
var wrap = require( './callback_wrapper.js' );
 
 
// MAIN //
 
/**
* Finds the last elements which pass a test implemented by a predicate function along one or more ndarray dimensions and assigns results to a provided output ndarray.
*
* @param {ndarray} x - input ndarray
* @param {ndarray} out - output ndarray
* @param {Options} [options] - function options
* @param {IntegerArray} [options.dims] - list of dimensions over which to perform a reduction
* @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
* @param {(*|ndarray)} [options.sentinelValue] - sentinel value
* @param {Function} predicate - predicate function
* @param {*} [thisArg] - predicate function execution context
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} second argument must be an ndarray-like object
* @throws {TypeError} options argument must be an object
* @throws {TypeError} predicate argument must be a function
* @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 isEven = require( '@stdlib/assert/is-even' ).isPrimitive;
* var array = require( '@stdlib/ndarray/array' );
* var empty = require( '@stdlib/ndarray/empty' );
*
* // Create an input ndarray:
* var x = array( [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ] ] );
* // returns <ndarray>
*
* // Create an output ndarray:
* var y = empty( [], {
*     'dtype': x.dtype
* });
*
* // Perform reduction:
* var out = assign( x, y, isEven );
* // returns <ndarray>
*
* var v = out.get();
* // returns 8.0
*/
function assign( x, out, options, predicate, thisArg ) {
	var nargs;
	var flg;
	var ctx;
	var cb;
	var o;
	var f;
	var y;
 
	nargs = arguments.length;
	if ( !isndarrayLike( x ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object. Value: `%s`.', x ) );
	}
	if ( !isndarrayLike( out ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be an ndarray-like object. Value: `%s`.', x ) );
	}
	// Case: assign( x, out, predicate )
	if ( nargs < 4 ) {
		if ( !isFunction( options ) ) {
			throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', options ) );
		}
		cb = options;
	}
	// Case: assign( x, out, options, predicate, thisArg )
	else if ( nargs > 4 ) {
		flg = true;
		o = options;
		cb = predicate;
		if ( !isFunction( cb ) ) {
			throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', cb ) );
		}
		ctx = thisArg;
	}
	// Case: assign( x, out, predicate, thisArg )
	else if ( isFunction( options ) ) {
		cb = options;
		ctx = predicate;
	}
	// Case: assign( x, out, options, predicate )
	else if ( isFunction( predicate ) ) {
		flg = true;
		o = options;
		cb = predicate;
	}
	// Case: find( x, out, ???, ??? )
	else {
		throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', predicate ) );
	}
 
	// Wrap the callback function...
	f = wrap( x, cb, ctx );
 
	// Create a reversed view of the input ndarray...
	y = reverse( x, false );
 
	if ( flg ) {
		if ( !isObject( o ) ) {
			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', o ) );
		}
		return base( y, out, o, f );
	}
	return base( y, out, f );
}
 
 
// EXPORTS //
 
module.exports = assign;