All files main.js

97.78% Statements 221/226
94.11% Branches 16/17
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 84x 84x 84x 84x 84x 84x 84x 84x 84x 84x 84x 84x 6x 2x 2x 4x 4x 78x 78x 1x 1x 77x 84x 49x 49x 24x 24x 25x 25x 28x 28x 28x 14x 14x 14x 14x           84x 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 blockedaccessorWhileEach2d = require( './2d_blocked_accessors.js' );
var blockedaccessorWhileEach3d = require( './3d_blocked_accessors.js' );
var blockedaccessorWhileEach4d = require( './4d_blocked_accessors.js' );
var blockedaccessorWhileEach5d = require( './5d_blocked_accessors.js' );
var blockedaccessorWhileEach6d = require( './6d_blocked_accessors.js' );
var blockedaccessorWhileEach7d = require( './7d_blocked_accessors.js' );
var blockedaccessorWhileEach8d = require( './8d_blocked_accessors.js' );
var blockedaccessorWhileEach9d = require( './9d_blocked_accessors.js' );
var blockedaccessorWhileEach10d = require( './10d_blocked_accessors.js' );
var blockedWhileEach2d = require( './2d_blocked.js' );
var blockedWhileEach3d = require( './3d_blocked.js' );
var blockedWhileEach4d = require( './4d_blocked.js' );
var blockedWhileEach5d = require( './5d_blocked.js' );
var blockedWhileEach6d = require( './6d_blocked.js' );
var blockedWhileEach7d = require( './7d_blocked.js' );
var blockedWhileEach8d = require( './8d_blocked.js' );
var blockedWhileEach9d = require( './9d_blocked.js' );
var blockedWhileEach10d = require( './10d_blocked.js' );
var accessorWhileEach0d = require( './0d_accessors.js' );
var accessorWhileEach1d = require( './1d_accessors.js' );
var accessorWhileEach2d = require( './2d_accessors.js' );
var accessorWhileEach3d = require( './3d_accessors.js' );
var accessorWhileEach4d = require( './4d_accessors.js' );
var accessorWhileEach5d = require( './5d_accessors.js' );
var accessorWhileEach6d = require( './6d_accessors.js' );
var accessorWhileEach7d = require( './7d_accessors.js' );
var accessorWhileEach8d = require( './8d_accessors.js' );
var accessorWhileEach9d = require( './9d_accessors.js' );
var accessorWhileEach10d = require( './10d_accessors.js' );
var accessorWhileEachnd = require( './nd_accessors.js' );
var whileEach0d = require( './0d.js' );
var whileEach1d = require( './1d.js' );
var whileEach2d = require( './2d.js' );
var whileEach3d = require( './3d.js' );
var whileEach4d = require( './4d.js' );
var whileEach5d = require( './5d.js' );
var whileEach6d = require( './6d.js' );
var whileEach7d = require( './7d.js' );
var whileEach8d = require( './8d.js' );
var whileEach9d = require( './9d.js' );
var whileEach10d = require( './10d.js' );
var whileEachnd = require( './nd.js' );
 
 
// VARIABLES //
 
var WHILE_EACH = [
	whileEach0d,
	whileEach1d,
	whileEach2d,
	whileEach3d,
	whileEach4d,
	whileEach5d,
	whileEach6d,
	whileEach7d,
	whileEach8d,
	whileEach9d,
	whileEach10d
];
var ACCESSOR_WHILE_EACH = [
	accessorWhileEach0d,
	accessorWhileEach1d,
	accessorWhileEach2d,
	accessorWhileEach3d,
	accessorWhileEach4d,
	accessorWhileEach5d,
	accessorWhileEach6d,
	accessorWhileEach7d,
	accessorWhileEach8d,
	accessorWhileEach9d,
	accessorWhileEach10d
];
var BLOCKED_WHILE_EACH = [
	blockedWhileEach2d, // 0
	blockedWhileEach3d,
	blockedWhileEach4d,
	blockedWhileEach5d,
	blockedWhileEach6d,
	blockedWhileEach7d,
	blockedWhileEach8d,
	blockedWhileEach9d,
	blockedWhileEach10d // 8
];
var BLOCKED_ACCESSOR_WHILE_EACH = [
	blockedaccessorWhileEach2d, // 0
	blockedaccessorWhileEach3d,
	blockedaccessorWhileEach4d,
	blockedaccessorWhileEach5d,
	blockedaccessorWhileEach6d,
	blockedaccessorWhileEach7d,
	blockedaccessorWhileEach8d,
	blockedaccessorWhileEach9d,
	blockedaccessorWhileEach10d // 8
];
var MAX_DIMS = WHILE_EACH.length - 1;
 
 
// MAIN //
 
/**
* While a test condition is true, invokes a callback function for each element in an ndarray.
*
* ## 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( value ) {
*     return value === value;
* }
*
* // 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:
* whileEach( [ x ], predicate, naryFunction( log, 1 ) );
*/
function whileEach( 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_WHILE_EACH[ ndims ]( x, predicate, fcn, thisArg );
		}
		return WHILE_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_WHILE_EACH[ ndims ]( x, predicate, fcn, thisArg );
		}
		return WHILE_EACH[ ndims ]( x, predicate, fcn, thisArg );
	}
	// Determine whether we can perform blocked iteration...
	if ( ndims <= MAX_DIMS ) {
		if ( x.accessorProtocol ) {
			return BLOCKED_ACCESSOR_WHILE_EACH[ ndims-2 ]( x, predicate, fcn, thisArg );
		}
		return BLOCKED_WHILE_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 accessorWhileEachnd( x, predicate, fcn, thisArg );
	}
	whileEachnd( x, predicate, fcn, thisArg );
}
 
 
// EXPORTS //
 
module.exports = whileEach;