All files main.js

97.78% Statements 221/226
93.75% Branches 15/16
100% Functions 1/1
97.78% Lines 221/226

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 2275x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 80x 80x 80x 80x 80x 80x 80x 80x 80x 80x 80x 80x 6x 3x 3x 3x 3x 74x 74x 1x 1x 73x 80x 45x 45x 22x 22x 23x 23x 28x 28x 28x 14x 14x 14x 14x           80x 5x 5x 5x 5x 5x  
/**
* @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 iterationOrder = require( '@stdlib/ndarray/base/iteration-order' );
var ndarray2object = require( '@stdlib/ndarray/base/ndarraylike2object' );
var numel = require( '@stdlib/ndarray/base/numel' );
var blockedaccessorUntilEach2d = require( './2d_blocked_accessors.js' );
var blockedaccessorUntilEach3d = require( './3d_blocked_accessors.js' );
var blockedaccessorUntilEach4d = require( './4d_blocked_accessors.js' );
var blockedaccessorUntilEach5d = require( './5d_blocked_accessors.js' );
var blockedaccessorUntilEach6d = require( './6d_blocked_accessors.js' );
var blockedaccessorUntilEach7d = require( './7d_blocked_accessors.js' );
var blockedaccessorUntilEach8d = require( './8d_blocked_accessors.js' );
var blockedaccessorUntilEach9d = require( './9d_blocked_accessors.js' );
var blockedaccessorUntilEach10d = require( './10d_blocked_accessors.js' );
var blockedUntilEach2d = require( './2d_blocked.js' );
var blockedUntilEach3d = require( './3d_blocked.js' );
var blockedUntilEach4d = require( './4d_blocked.js' );
var blockedUntilEach5d = require( './5d_blocked.js' );
var blockedUntilEach6d = require( './6d_blocked.js' );
var blockedUntilEach7d = require( './7d_blocked.js' );
var blockedUntilEach8d = require( './8d_blocked.js' );
var blockedUntilEach9d = require( './9d_blocked.js' );
var blockedUntilEach10d = require( './10d_blocked.js' );
var accessorUntilEach0d = require( './0d_accessors.js' );
var accessorUntilEach1d = require( './1d_accessors.js' );
var accessorUntilEach2d = require( './2d_accessors.js' );
var accessorUntilEach3d = require( './3d_accessors.js' );
var accessorUntilEach4d = require( './4d_accessors.js' );
var accessorUntilEach5d = require( './5d_accessors.js' );
var accessorUntilEach6d = require( './6d_accessors.js' );
var accessorUntilEach7d = require( './7d_accessors.js' );
var accessorUntilEach8d = require( './8d_accessors.js' );
var accessorUntilEach9d = require( './9d_accessors.js' );
var accessorUntilEach10d = require( './10d_accessors.js' );
var accessorUntilEachnd = require( './nd_accessors.js' );
var untilEach0d = require( './0d.js' );
var untilEach1d = require( './1d.js' );
var untilEach2d = require( './2d.js' );
var untilEach3d = require( './3d.js' );
var untilEach4d = require( './4d.js' );
var untilEach5d = require( './5d.js' );
var untilEach6d = require( './6d.js' );
var untilEach7d = require( './7d.js' );
var untilEach8d = require( './8d.js' );
var untilEach9d = require( './9d.js' );
var untilEach10d = require( './10d.js' );
var untilEachnd = require( './nd.js' );
 
 
// VARIABLES //
 
var UNTIL_EACH = [
	untilEach0d,
	untilEach1d,
	untilEach2d,
	untilEach3d,
	untilEach4d,
	untilEach5d,
	untilEach6d,
	untilEach7d,
	untilEach8d,
	untilEach9d,
	untilEach10d
];
var ACCESSOR_UNTIL_EACH = [
	accessorUntilEach0d,
	accessorUntilEach1d,
	accessorUntilEach2d,
	accessorUntilEach3d,
	accessorUntilEach4d,
	accessorUntilEach5d,
	accessorUntilEach6d,
	accessorUntilEach7d,
	accessorUntilEach8d,
	accessorUntilEach9d,
	accessorUntilEach10d
];
var BLOCKED_UNTIL_EACH = [
	blockedUntilEach2d, // 0
	blockedUntilEach3d,
	blockedUntilEach4d,
	blockedUntilEach5d,
	blockedUntilEach6d,
	blockedUntilEach7d,
	blockedUntilEach8d,
	blockedUntilEach9d,
	blockedUntilEach10d // 8
];
var BLOCKED_ACCESSOR_UNTIL_EACH = [
	blockedaccessorUntilEach2d, // 0
	blockedaccessorUntilEach3d,
	blockedaccessorUntilEach4d,
	blockedaccessorUntilEach5d,
	blockedaccessorUntilEach6d,
	blockedaccessorUntilEach7d,
	blockedaccessorUntilEach8d,
	blockedaccessorUntilEach9d,
	blockedaccessorUntilEach10d // 8
];
var MAX_DIMS = UNTIL_EACH.length - 1;
 
 
// MAIN //
 
/**
* Invokes a callback function for each element in an ndarray until a predicate function returns a truthy value.
*
* ## Notes
*
* -   A provided ndarray should be an object with the following properties:
*
*     -   **dtype**: data type.
*     -   **data**: data buffer.
*     -   **shape**: dimensions.
*     -   **strides**: stride lengths.
*     -   **offset**: index offset.
*     -   **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
*
* @param {ArrayLikeObject<Object>} arrays - array-like object containing one input array
* @param {Function} predicate - predicate function
* @param {Callback} fcn - callback function
* @param {*} [thisArg] - callback function execution context
* @returns {void}
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var naryFunction = require( '@stdlib/utils/nary-function' );
* var log = require( '@stdlib/console/log' );
*
* function predicate() {
*     return false;
* }
*
* // Create a data buffer:
* var xbuf = new Float64Array( 12 );
*
* // Define the shape of the array:
* var shape = [ 3, 1, 2 ];
*
* // Define the array strides:
* var sx = [ 4, 4, 1 ];
*
* // Define the index offset:
* var ox = 1;
*
* // Create an ndarray-like object:
* var x = {
*     'ref': null,
*     'dtype': 'float64',
*     'data': xbuf,
*     'shape': shape,
*     'strides': sx,
*     'offset': ox,
*     'order': 'row-major'
* };
*
* // Apply the callback function:
* untilEach( [ x ], predicate, naryFunction( log, 1 ) );
*/
function untilEach( arrays, predicate, fcn, thisArg ) {
	var ndims;
	var shx;
	var x;
 
	// Unpack the ndarray and standardize ndarray meta data:
	x = ndarray2object( arrays[ 0 ] );
	shx = x.shape;
	ndims = shx.length;
 
	// Determine whether we can avoid iteration altogether...
	if ( ndims === 0 ) {
		if ( x.accessorProtocol ) {
			return ACCESSOR_UNTIL_EACH[ ndims ]( x, predicate, fcn, thisArg );
		}
		return UNTIL_EACH[ ndims ]( x, predicate, fcn, thisArg );
	}
	// Check whether we were provided an empty ndarray...
	if ( numel( shx ) === 0 ) {
		return;
	}
	// Determine whether we can avoid blocked iteration...
	if ( ndims <= MAX_DIMS && iterationOrder( x.strides ) !== 0 ) {
		// So long as iteration always moves in the same direction (i.e., no mixed sign strides), we can leverage cache-optimal (i.e., normal) nested loops without resorting to blocked iteration...
		if ( x.accessorProtocol ) {
			return ACCESSOR_UNTIL_EACH[ ndims ]( x, predicate, fcn, thisArg );
		}
		return UNTIL_EACH[ ndims ]( x, predicate, fcn, thisArg );
	}
	// Determine whether we can perform blocked iteration...
	if ( ndims <= MAX_DIMS ) {
		if ( x.accessorProtocol ) {
			return BLOCKED_ACCESSOR_UNTIL_EACH[ ndims-2 ]( x, predicate, fcn, thisArg ); // eslint-disable-line max-len
		}
		return BLOCKED_UNTIL_EACH[ ndims-2 ]( x, predicate, fcn, thisArg );
	}
	// Fall-through to linear view iteration without regard for how data is stored in memory (i.e., take the slow path)...
	if ( x.accessorProtocol ) {
		return accessorUntilEachnd( x, predicate, fcn, thisArg );
	}
	untilEachnd( x, predicate, fcn, thisArg );
}
 
 
// EXPORTS //
 
module.exports = untilEach;