feat: add ndarray/base/while-each

lib/node_modules/@stdlib/ndarray/base/while-each/README.md

@@ -0,0 +1,200 @@
+<!--
+
+@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.
+
+-->
+
+# whileEach
+
+> While a test condition is true, invoke a callback function for each element in an ndarray.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var whileEach = require( '@stdlib/ndarray/base/while-each' );
+```
+
+#### whileEach( arrays, predicate, fcn\[, thisArg] )
+
+While a test condition is true, invokes a callback function for each element in an ndarray.
+
+```javascript
+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 data buffers:
+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 = {
+    'dtype': 'float64',
+    'data': xbuf,
+    'shape': shape,
+    'strides': sx,
+    'offset': ox,
+    'order': 'row-major'
+};
+
+// Apply the callback function:
+whileEach( [ x ], predicate, naryFunction( log, 1 ) );
+```
+
+The function accepts the following arguments:
+
+-   **arrays**: array-like object containing an input ndarray.
+-   **predicate**: predicate function which determines whether to continue iterating.
+-   **fcn**: callback to apply.
+-   **thisArg**: callback execution context.
+
+Both the predicate function and the callback function are provided the following arguments:
+
+-   **value**: current array element.
+-   **indices**: current array element indices.
+-   **arr**: the input ndarray.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The 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).
+
+-   For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before applying a callback function in order to achieve better performance.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
+var zeroTo = require( '@stdlib/array/base/zero-to' );
+var naryFunction = require( '@stdlib/utils/nary-function' );
+var log = require( '@stdlib/console/log' );
+var whileEach = require( '@stdlib/ndarray/base/while-each' );
+
+function predicate( value ) {
+    return value < 6;
+}
+
+var x = {
+    'dtype': 'generic',
+    'data': zeroTo( 10 ),
+    'shape': [ 5, 2 ],
+    'strides': [ -2, 1 ],
+    'offset': 8,
+    'order': 'row-major'
+};
+
+log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );
+whileEach( [ x ], predicate, naryFunction( log, 1 ) );
+
+x = {
+    'dtype': 'generic',
+    'data': zeroTo( 10 ),
+    'shape': [ 5, 2 ],
+    'strides': [ 1, -5 ],
+    'offset': 5,
+    'order': 'column-major'
+};
+
+log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );
+whileEach( [ x ], predicate, naryFunction( log, 1 ) );
+
+x = {
+    'dtype': 'generic',
+    'data': zeroTo( 18 ),
+    'shape': [ 2, 3, 3 ],
+    'strides': [ 9, 3, 1 ],
+    'offset': 0,
+    'order': 'row-major'
+};
+
+log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );
+whileEach( [ x ], predicate, naryFunction( log, 1 ) );
+
+x = {
+    'dtype': 'generic',
+    'data': zeroTo( 18 ),
+    'shape': [ 2, 3, 3 ],
+    'strides': [ -1, -2, -6 ],
+    'offset': 17,
+    'order': 'column-major'
+};
+
+log( ndarray2array( x.data, x.shape, x.strides, x.offset, x.order ) );
+whileEach( [ x ], predicate, naryFunction( log, 1 ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<section class="links">
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/ndarray/base/while-each/benchmark/benchmark.10d_blocked_columnmajor.js

@@ -0,0 +1,157 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var floor = require( '@stdlib/math/base/special/floor' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var whileEach = require( './../lib/10d_blocked.js' );
+
+
+// VARIABLES //
+
+var types = [ 'float64' ];
+var order = 'column-major';
+
+
+// FUNCTIONS //
+
+/**
+* Predicate function invoked for each element in an ndarray.
+*
+* @private
+* @param {number} value - array element
+* @returns {boolean} result
+*/
+function predicate( value ) {
+	return value === value;
+}
+
+/**
+* Callback invoked for each element in an ndarray.
+*
+* @private
+* @param {number} value - array element
+* @throws {Error} unexpected error
+*/
+function fcn( value ) {
+	if ( isnan( value ) ) {
+		throw new Error( 'unexpected error' );
+	}
+}
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - ndarray length
+* @param {NonNegativeIntegerArray} shape - ndarray shape
+* @param {string} xtype - input ndarray data type
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len, shape, xtype ) {
+	var x;
+
+	x = discreteUniform( len, -100, 100 );
+	x = {
+		'dtype': xtype,
+		'data': x,
+		'shape': shape,
+		'strides': shape2strides( shape, order ),
+		'offset': 0,
+		'order': order
+	};
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			whileEach( x, predicate, fcn );
+			if ( isnan( x.data[ i%len ] ) ) {
+				b.fail( 'should not return NaN' );
+			}
+		}
+		b.toc();
+		if ( isnan( x.data[ i%len ] ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var sh;
+	var t1;
+	var f;
+	var i;
+	var j;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( j = 0; j < types.length; j++ ) {
+		t1 = types[ j ];
+		for ( i = min; i <= max; i++ ) {
+			len = pow( 10, i );
+
+			sh = [ len/2, 2, 1, 1, 1, 1, 1, 1, 1, 1 ];
+			f = createBenchmark( len, sh, t1 );
+			bench( format( '%s::blocked:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join(','), order, t1 ), f );
+
+			sh = [ 1, 1, 1, 1, 1, 1, 1, 1, 2, len/2 ];
+			f = createBenchmark( len, sh, t1 );
+			bench( format( '%s::blocked:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join(','), order, t1 ), f );
+
+			len = floor( pow( len, 1.0/10.0 ) );
+			sh = [ len, len, len, len, len, len, len, len, len, len ];
+			len *= pow( len, 9 );
+			f = createBenchmark( len, sh, t1 );
+			bench( format( '%s::blocked:ndims=%d,len=%d,shape=[%s],xorder=%s,xtype=%s', pkg, sh.length, len, sh.join(','), order, t1 ), f );
+		}
+	}
+}
+
+main();