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 | 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 153x 153x 153x 153x 153x 153x 153x 153x 153x 153x 153x 153x 60x 60x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 93x 153x 41x 41x 6x 6x 35x 35x 5x 5x 5x 30x 30x 30x 30x 30x 41x 52x 52x 48x 48x 20x 20x 28x 28x 20x 20x 20x 8x 8x 8x 8x 40x 40x 40x 153x 70x 26x 26x 44x 70x 22x 22x 70x 4x 4x 70x 6x 6x 70x 59x 59x 153x 3x 3x 56x 56x 56x 153x 43x 153x 13x 13x 50x 153x 3x 3x 3x 3x 3x | /**
* @license Apache-2.0
*
* Copyright (c) 2026 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 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 format = require( '@stdlib/string/format' );
var defaults = require( '@stdlib/ndarray/defaults' );
var base = require( './base.js' );
// VARIABLES //
var DEFAULT_DTYPE = defaults.get( 'dtypes.integer_index' );
// MAIN //
/**
* Returns the index of the first falsy element along an ndarray dimension.
*
* ## Notes
*
* - If unable to find a falsy element along an ndarray dimension, the corresponding element in the returned ndarray is `-1`.
* - The function explicitly treats `NaN` values as falsy.
*
* @param {ndarrayLike} x - input ndarray
* @param {(ndarrayLike|integer)} [fromIndex=0] - index from which to begin searching
* @param {Options} [options] - function options
* @param {integer} [options.dim=-1] - dimension over which to perform operation
* @param {boolean} [options.keepdims=false] - boolean indicating whether the reduced dimensions should be included in the returned ndarray as singleton dimensions
* @param {*} [options.dtype] - output ndarray data type
* @throws {TypeError} first argument must be an ndarray-like object
* @throws {TypeError} second argument must be either an ndarray-like object or an integer
* @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 Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* // Create a data buffer:
* var xbuf = new Float64Array( [ 1.0, 3.0, 0.0, 2.0, 0.0, 4.0 ] );
*
* // Define the shape of the input array:
* var sh = [ 2, 3 ];
*
* // Define the array strides:
* var sx = [ 3, 1 ];
*
* // Define the index offset:
* var ox = 0;
*
* // Create an input ndarray:
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
*
* // Perform operation:
* var out = indexOfFalsy( x );
* // returns <ndarray>[ 2, 1 ]
*/
function indexOfFalsy( x, fromIndex ) {
var hasOptions;
var options;
var nargs;
var opts;
var fidx;
var iflg;
var ord;
var sh;
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
'keepdims': false
};
// 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: indexOfFalsy( x, ??? )
if ( nargs === 2 ) {
// Case: indexOfFalsy( x, from_index_scalar )
if ( isInteger( fromIndex ) ) {
fidx = fromIndex;
}
// Case: indexOfFalsy( x, from_index_ndarray )
else if ( isndarrayLike( fromIndex ) ) {
fidx = fromIndex;
iflg = false;
}
// Case: indexOfFalsy( x, options )
else {
options = fromIndex;
hasOptions = true;
}
}
// Case: indexOfFalsy( x, from_index, options )
else if ( nargs > 2 ) {
// Case: indexOfFalsy( x, from_index_scalar, options )
if ( isInteger( fromIndex ) ) {
fidx = fromIndex;
}
// Case: indexOfFalsy( x, from_index_ndarray, options )
else if ( isndarrayLike( fromIndex ) ) {
fidx = fromIndex;
iflg = false;
}
// Case: indexOfFalsy( x, ???, options )
else {
throw new TypeError( format( 'invalid argument. Second argument must be either an ndarray or an integer. Value: `%s`.', fromIndex ) );
}
options = arguments[ 2 ];
hasOptions = true;
}
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 ( hasOwnProp( options, 'keepdims' ) ) {
opts.keepdims = options.keepdims;
}
if ( hasOwnProp( options, 'dtype' ) ) {
opts.dtype = options.dtype;
}
}
// Resolve the list of non-reduced dimensions:
sh = getShape( x );
if ( sh.length < 1 ) {
throw new RangeError( 'invalid argument. First argument must have at least one dimension.' );
}
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, opts );
}
// EXPORTS //
module.exports = indexOfFalsy;
|