All files / ndarray/find/lib main.js

96.79% Statements 151/156
96.42% Branches 27/28
100% Functions 1/1
96.79% Lines 151/156

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 1571x 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 57x 57x 57x 57x 57x 57x 57x 57x 57x 57x 57x 57x 57x 57x 10x 10x 57x 15x 57x 32x 2x 2x 32x 30x 30x 30x 30x 32x           57x 16x 16x 57x 22x 7x 7x 22x 13x 11x 11x 2x 2x 22x 13x 57x 11x 11x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 57x 8x 57x 5x 5x 13x 13x 13x 13x 57x 31x 18x 18x 31x 31x 11x 11x 31x 2x 57x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2024 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 isPlainObject = require( '@stdlib/assert/is-plain-object' );
var isFunction = require( '@stdlib/assert/is-function' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var isOrder = require( '@stdlib/ndarray/base/assert/is-order' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var zeros = require( '@stdlib/array/base/zeros' );
var getShape = require( '@stdlib/ndarray/shape' );
var getOrder = require( '@stdlib/ndarray/order' );
var numel = require( '@stdlib/ndarray/base/numel' );
var nextCartesianIndex = require( '@stdlib/ndarray/base/next-cartesian-index' ).assign;
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Return the first element in the ndarray that passes a test implemented by a predicate function.
*
* @param {ndarray} x - input ndarray
* @param {Options} [options] - function options
* @param {boolean} [options.order] - index iteration order
* @param {Callback} predicate - predicate function
* @param {*} [thisArg] - predicate execution context
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} options argument must be an object
* @throws {TypeError} callback argument must be a function
* @returns {number} result
*
* @example
* var isEven = require( '@stdlib/assert/is-even' ).isPrimitive;
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
* var ndarray2array = require( '@stdlib/ndarray/to-array' );
*
* var buffer = new Float64Array([1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0]);
* var shape = [2, 3];
* var strides = [ 5, 2 ];
* var offset = 0;
*
* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
* // returns <ndarray>
*
* var arr = ndarray2array( x );
* // returns [ [ 1.0, 3.0, 5.0 ], [ 6.0, 8.0, 10.0 ] ]
*
* var y = findElement( x, isEven );
* // returns 6.0
*/
function findElement( x, options, predicate, thisArg ) {
	var hasOpts;
	var ndims;
	var clbk;
	var opts;
	var ctx;
	var ord;
	var dim;
	var idx;
	var sh;
	var N;
	var v;
	var i;
	if ( !isndarrayLike( x ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be an ndarray-like object. Value: `%s`.', x ) );
	}
	if ( arguments.length < 3 ) {
		clbk = options;
	} else if ( arguments.length === 3 ) {
		if ( isFunction( options ) ) {
			clbk = options;
			ctx = predicate;
		} else {
			hasOpts = true;
			opts = options;
			clbk = predicate;
		}
	} else {
		hasOpts = true;
		opts = options;
		clbk = predicate;
		ctx = thisArg;
	}
	if ( !isFunction( clbk ) ) {
		throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', clbk ) );
	}
	if ( hasOpts ) {
		if ( !isPlainObject( opts ) ) {
			throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', opts ) );
		}
		if ( hasOwnProp( opts, 'order' ) ) {
			if ( !isOrder( opts.order ) ) {
				throw new TypeError( format( 'invalid option. `%s` option must be a recognized order. Option: `%s`.', 'order', opts.order ) );
			}
			ord = opts.order;
		}
	}
	// Resolve the iteration order:
	if ( ord === void 0 ) {
		ord = getOrder( x );
	}
	// Resolve the input array shape:
	sh = getShape( x );
 
	// Compute the number of array elements:
	N = numel( sh );
 
	// Retrieve the number of dimensions:
	ndims = sh.length;
 
	// Resolve the dimension in which indices should iterate fastest:
	if ( ord === 'row-major' ) {
		dim = ndims - 1;
	} else { // ord === 'column-major'
		dim = 0;
	}
	// Initialize an index array workspace:
	idx = zeros( ndims );
 
	// Check elements according to a predicate function...
	for ( i = 0; i < N; i++ ) {
		if ( i > 0 ) {
			idx = nextCartesianIndex( sh, ord, idx, dim, idx );
		}
		v = x.get.apply( x, idx );
		if ( clbk.call( ctx, v, idx.slice(), x ) ) {
			return v;
		}
	}
	return NaN;
}
 
 
// EXPORTS //
 
module.exports = findElement;