feat: add forEach method to array/uint64

lib/node_modules/@stdlib/array/uint64/README.md

@@ -316,6 +316,58 @@ The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the
 -   **next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the [iterator][mdn-iterator-protocol] is finished.
 -   **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
 
+<a name="method-for-each"></a>
+
+#### Uint64Array.prototype.forEach( callbackFn\[, thisArg] )
+
+Invokes a function once for each array element.
+
+```javascript
+function log( v, i ) {
+    console.log( '%s: %s', i, v.toString() );
+}
+
+var arr = new Uint64Array( [ 1, 2, 3 ] );
+
+arr.forEach( log );
+/* =>
+    0: 1
+    1: 2
+    2: 3
+*/
+```
+
+The invoked function is provided three arguments:
+
+-   **value**: current array element.
+-   **index**: current array element index.
+-   **arr**: the array on which this method was called.
+
+To set the function execution context, provide a `thisArg`.
+
+```javascript
+function fcn( v, i ) {
+    this.count += 1;
+    console.log( '%s: %s', i, v.toString() );
+}
+
+var arr = new Uint64Array( [ 1, 2, 3 ] );
+
+var context = {
+    'count': 0
+};
+
+arr.forEach( fcn, context );
+/* =>
+    0: 1
+    1: 2
+    2: 3
+*/
+
+var count = context.count;
+// returns 3
+```
+
 <a name="method-get"></a>
 
 #### Uint64Array.prototype.get( i )

lib/node_modules/@stdlib/array/uint64/benchmark/benchmark.for_each.js

@@ -0,0 +1,89 @@
+/**
+* @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 format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var Uint64Array = require( './../lib' );
+
+
+// MAIN //
+
+bench( format( '%s:forEach', pkg ), function benchmark( b ) {
+	var count;
+	var arr;
+	var N;
+	var i;
+
+	arr = new Uint64Array( 2 );
+	N = arr.length;
+
+	count = 0;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		arr.forEach( fcn );
+		if ( count !== N*(i+1) ) {
+			b.fail( 'unexpected result' );
+		}
+	}
+	b.toc();
+	if ( count !== N*i ) {
+		b.fail( 'unexpected result' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+
+	function fcn() {
+		count += 1;
+	}
+});
+
+bench( format( '%s::this_context:forEach', pkg ), function benchmark( b ) {
+	var count;
+	var arr;
+	var N;
+	var i;
+
+	arr = new Uint64Array( 2 );
+	N = arr.length;
+
+	count = 0;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		arr.forEach( fcn, {} );
+		if ( count !== N*(i+1) ) {
+			b.fail( 'unexpected result' );
+		}
+	}
+	b.toc();
+	if ( count !== N*i ) {
+		b.fail( 'unexpected result' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+
+	function fcn() {
+		count += 1;
+	}
+});

lib/node_modules/@stdlib/array/uint64/benchmark/benchmark.for_each.length.js

@@ -0,0 +1,107 @@
+/**
+* @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 pow = require( '@stdlib/math/base/special/pow' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var Uint64Array = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var count;
+	var arr;
+
+	arr = new Uint64Array( len );
+	count = 0;
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			arr.forEach( fcn );
+			if ( count !== count ) {
+				b.fail( 'should not be NaN' );
+			}
+		}
+		b.toc();
+		if ( count !== count ) {
+			b.fail( 'should not be NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+
+	/**
+	* Callback invoked for each tuple element.
+	*
+	* @private
+	*/
+	function fcn() {
+		count += 1;
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( format( '%s:forEach:len=%d', pkg, len ), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/uint64/docs/repl.txt

@@ -275,6 +275,34 @@
     true
 
 
+{{alias}}.prototype.forEach( clbk[, thisArg] )
+    Invokes a function once for each array element.
+
+    A callback function is provided the following arguments:
+
+    - value: current array element.
+    - index: current array element index.
+    - arr: the array on which the method was called.
+
+    Parameters
+    ----------
+    clbk: Function
+        Function to invoke for each array element.
+
+    thisArg: any (optional)
+        Execution context.
+
+    Examples
+    --------
+    > var str = '%';
+    > function clbk( v ) { str += v.toString() + '%'; };
+    > var arr = new {{alias}}( [ 1, 2 ] )
+    <Uint64Array>[ 1n, 2n ]
+    > arr.forEach( clbk );
+    > str
+    '%1%2%'
+
+
 {{alias}}.prototype.get( i )
     Returns an array element located at integer position (index) `i`.
 

lib/node_modules/@stdlib/array/uint64/docs/types/index.d.ts

@@ -28,7 +28,7 @@
 import ArrayBuffer = require( '@stdlib/array/buffer' );
 
 // Define a union type representing both iterable and non-iterable iterators:
 type Iterator = Iter | IterableIterator;
 
 // Define a type representing a value from which a 64-bit unsigned integer can be derived:
 type Uint = Uint64 | bigint | number;
@@ -36,7 +36,7 @@
 /**
 * Locale-specific configuration options.
 */
 interface LocaleOptions<T = unknown> {
 	/**
 	* Configuration property.
 	*/
@@ -118,7 +118,7 @@
 * @param arr - array on which the method was called
 * @returns boolean indicating whether an element in an array passes a test
 */
 type Predicate<U> = NullaryPredicate<U> | UnaryPredicate<U> | BinaryPredicate<U> | TernaryPredicate<U>;
 
 /**
 * Callback invoked for each element in an array.
@@ -206,7 +206,7 @@
 * @param arr - array on which the method was called
 * @returns transformed value
 */
 type MapFcn<U> = NullaryMapFcn<U> | UnaryMapFcn<U> | BinaryMapFcn<U> | TernaryMapFcn<U>;
 
 /**
 * Reducer function invoked for each element in an array.
@@ -260,7 +260,7 @@
 * @param arr - array on which the method was called
 * @returns accumulated result
 */
 type Reducer<U> = NullaryReducer<U> | UnaryReducer<U> | BinaryReducer<U> | TernaryReducer<U> | QuaternaryReducer<U>;
 
 /**
 * Comparator function.
@@ -269,7 +269,7 @@
 * @param b - second value for comparison
 * @returns number indicating comparison result
 */
 type CompareFcn = ( a: Uint64, b: Uint64 ) => number;
 
 /**
 * Class for creating a 64-bit unsigned integer array.
@@ -459,6 +459,24 @@
 	*/
 	entries(): TypedIterator<[number, Uint64]>;
 
+	/**
+	* Invokes a function once for each array element.
+	*
+	* @param fcn - function to invoke
+	* @param thisArg - execution context
+	* @returns undefined
+	*
+	* @example
+	* function log( v, i ) {
+	*     console.log( '%s: %s', i, v.toString() );
+	* }
+	*
+	* var arr = new Uint64Array( [ 1, 2, 3 ] );
+	*
+	* arr.forEach( log );
+	*/
+	forEach<U = unknown>( fcn: Callback<U>, thisArg?: ThisParameterType<Callback<U>> ): void;
+
 	/**
 	* Returns an array element.
 	*

lib/node_modules/@stdlib/array/uint64/lib/main.js

@@ -711,6 +711,43 @@
 	}
 });
 
+/**
+* Invokes a function once for each array element.
+*
+* @name forEach
+* @memberof Uint64Array.prototype
+* @type {Function}
+* @param {Function} fcn - function to invoke
+* @param {*} [thisArg] - function invocation context
+* @throws {TypeError} `this` must be a 64-bit unsigned integer array
+* @throws {TypeError} first argument must be a function
+*
+* @example
+* function log( v, i ) {
+*     console.log( '%s: %s', i, v.toString() );
+* }
+*
+* var arr = new Uint64Array( [ 1, 2, 3 ] );
+*
+* arr.forEach( log );
+*/
+setReadOnly( Uint64Array.prototype, 'forEach', function forEach( fcn, thisArg ) {
+	var buf;
+	var i;
+	var v;
+	if ( !isUint64Array( this ) ) {
+		throw new TypeError( 'invalid invocation. `this` is not a 64-bit unsigned integer array.' );
+	}
+	if ( !isFunction( fcn ) ) {
+		throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', fcn ) );
+	}
+	buf = this._buffer;
+	for ( i = 0; i < this._length; i++ ) {
+		v = getUint64( buf, i );
+		fcn.call( thisArg, v, i, this );
+	}
+});
+
 /**
 * Returns an array element.
 *
@@ -848,7 +885,7 @@
 		buf[ idx+indices.LOW ] = words[ 1 ];
 		return;
 	}
 	if ( isNonNegativeInteger( value ) || ( isBigInt( value ) && isNonNegativeInteger( Number( value ) ) ) ) {
 		if ( idx >= this._length ) {
 			throw new RangeError( format( 'invalid argument. Index argument is out-of-bounds. Value: `%u`.', idx ) );
 		}