Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,13 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-09-25)
+## Unreleased (2024-11-18)
 
 <section class="features">
 
 ### Features
 
+-   [`956a462`](https://github.com/stdlib-js/stdlib/commit/956a4624c788689b1bca285856b987ea3aa32eb6) - add `forEach` method
 -   [`a3a04e3`](https://github.com/stdlib-js/stdlib/commit/a3a04e32057b878529b86180e38ed3ae383c34ef) - add `array/fixed-endian-factory`
 
 </section>
@@ -22,6 +23,7 @@
 
 <details>
 
+-   [`956a462`](https://github.com/stdlib-js/stdlib/commit/956a4624c788689b1bca285856b987ea3aa32eb6) - **feat:** add `forEach` method _(by Athan Reines)_
 -   [`b9f3b77`](https://github.com/stdlib-js/stdlib/commit/b9f3b776e5f3d426629b77206b682836fe6b390f) - **refactor:** reduce string literals _(by Athan Reines)_
 -   [`17fa3d2`](https://github.com/stdlib-js/stdlib/commit/17fa3d277b28d85634444424f2af75edf60ab030) - **docs:** fix example _(by Athan Reines)_
 -   [`a3a04e3`](https://github.com/stdlib-js/stdlib/commit/a3a04e32057b878529b86180e38ed3ae383c34ef) - **feat:** add `array/fixed-endian-factory` _(by Athan Reines)_

CONTRIBUTORS

@@ -2,7 +2,8 @@
 #
 # Contributors listed in alphabetical order.
 
-Aayush Khanna <96649223+aayush0325@users.noreply.github.com>
+Aayush Khanna <aayushiitbhu23@gmail.com>
+AbhijitRaut04 <121740684+AbhijitRaut04@users.noreply.github.com>
 Adarsh Palaskar <adarshpalaskar99@gmail.com>
 Aditya Sapra <adityaework@gmail.com>
 AgPriyanshu18 <113460573+AgPriyanshu18@users.noreply.github.com>
@@ -21,13 +22,15 @@ Christopher Dambamuromo <chridam@gmail.com>
 Dan Rose <danoftheroses@gmail.com>
 Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
-DebashisMaharana <145602692+DevMhrn@users.noreply.github.com>
+Debashis Maharana <debashismaharana7854@gmail.com>
+Dominic Lim <46486515+domlimm@users.noreply.github.com>
 Dominik Moritz <domoritz@gmail.com>
 Dorrin Sotoudeh <dorrinsotoudeh123@gmail.com>
 EuniceSim142 <77243938+EuniceSim142@users.noreply.github.com>
 Frank Kovacs <fran70kk@gmail.com>
 Golden Kumar <103646877+AuenKr@users.noreply.github.com>
 Gunj Joshi <gunjjoshi8372@gmail.com>
+Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com>
 HarshaNP <96897754+GittyHarsha@users.noreply.github.com>
 Harshita Kalani <harshitakalani02@gmail.com>
 Hridyanshu <124202756+HRIDYANSHU054@users.noreply.github.com>
@@ -44,6 +47,7 @@ Justin Dennison <justin1dennison@gmail.com>
 Kaif Mohd <mdkaifprofession@gmail.com>
 Karthik Prakash <116057817+skoriop@users.noreply.github.com>
 Khaldon <kahmd1444@gmail.com>
+Kohantika Nath <145763549+kohantikanath@users.noreply.github.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
 Lovelin <100030865+lovelindhoni@users.noreply.github.com>
 Manik Sharma <maniksharma.rke@gmail.com>
@@ -55,6 +59,7 @@ Mohammad Kaif <98884589+Kaif987@users.noreply.github.com>
 Momtchil Momtchev <momtchil@momtchev.com>
 Muhammad Haris <harriskhan047@outlook.com>
 Naresh Jagadeesan <naresh.naresh000@gmail.com>
+Neeraj Pathak <neerajrpathak710@gmail.com>
 NightKnight <Ahmedatwa866@yahoo.com>
 Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
 Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com>
@@ -65,15 +70,18 @@ Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <goswami.4@iitj.ac.in>
 Praneki <97080887+PraneGIT@users.noreply.github.com>
 Pratik <97464067+Pratik772846@users.noreply.github.com>
+Pratyush Kumar Chouhan <pratyushkumar0308@gmail.com>
 Priyansh <88396544+itsspriyansh@users.noreply.github.com>
 Pushpendra Chandravanshi <pushpendrachandravanshi4@gmail.com>
+RISHAV <115060907+rishav2404@users.noreply.github.com>
 Raunak Kumar Gupta <raunakmodanwal321@gmail.com>
 Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com>
 Ricky Reusser <rsreusser@gmail.com>
 Ridam Garg <67867319+RidamGarg@users.noreply.github.com>
 Robert Gislason <gztown2216@yahoo.com>
 Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
 Rutam <138517416+performant23@users.noreply.github.com>
+Ruthwik Chikoti <145591715+ruthwikchikoti@users.noreply.github.com>
 Ryan Seal <splrk@users.noreply.github.com>
 Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com>
 SarthakPaandey <145528240+SarthakPaandey@users.noreply.github.com>
@@ -94,6 +102,7 @@ Tudor Pagu <104032457+tudor-pagu@users.noreply.github.com>
 Tufailahmed Bargir <142114244+Tufailahmed-Bargir@users.noreply.github.com>
 Utkarsh <http://utkarsh11105@gmail.com>
 Utkarsh Raj <rajutkarsh2505@gmail.com>
+UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>
 Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
 Varad Gupta <varadgupta21@gmail.com>
 Xiaochuan Ye <tap91624@gmail.com>

README.md

@@ -339,6 +339,65 @@ var v = arr.get( 0 );
 // returns 1.0
 ```
 
+<a name="method-for-each"></a>
+
+#### TypedArrayFE.prototype.forEach( callbackFn\[, thisArg] )
+
+Invokes a function once for each array element.
+
+```javascript
+function log( v, i ) {
+    console.log( '%s: %s', i.toString(), v.toString() );
+}
+
+var Float64ArrayFE = fixedEndianFactory( 'float64' );
+
+var arr = new Float64ArrayFE( 'little-endian', 3 );
+
+arr.set( 1.5, 0 );
+arr.set( 2.5, 1 );
+arr.set( 3.5, 2 );
+
+arr.forEach( log );
+/* =>
+    0: 1.5
+    1: 2.5
+    2: 3.5
+*/
+```
+
+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.toString(), v.toString() );
+}
+
+var Float64ArrayFE = fixedEndianFactory( 'float64' );
+
+var arr = new Float64ArrayFE( 'little-endian', 3 );
+
+var context = {
+    'count': 0
+};
+
+arr.set( 1.0, 0 );
+arr.set( 2.0, 1 );
+arr.set( 3.0, 2 );
+
+arr.forEach( fcn, context );
+
+var count = context.count;
+// returns 3
+```
+
 <a name="method-get"></a>
 
 #### TypedArrayFE.prototype.get( i )

benchmark/benchmark.for_each.js

@@ -0,0 +1,61 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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-harness' );
+var isnan = require( '@stdlib/math-base-assert-is-nan' );
+var pkg = require( './../package.json' ).name;
+var factory = require( './../lib' );
+
+
+// VARIABLES //
+
+var Float64ArrayFE = factory( 'float64' );
+
+
+// MAIN //
+
+bench( pkg+':forEach', function benchmark( b ) {
+	var arr;
+	var i;
+
+	arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 2.0, 1.0 ] );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		arr.forEach( check );
+		if ( arr.length !== 4 ) {
+			b.fail( 'should not change an array length' );
+		}
+	}
+	b.toc();
+	if ( arr.length !== 4 ) {
+		b.fail( 'should not change an array length' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+
+	function check( v ) {
+		if ( isnan( v ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+});

benchmark/benchmark.for_each.length.js

@@ -0,0 +1,105 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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-harness' );
+var pow = require( '@stdlib/math-base-special-pow' );
+var zeroTo = require( '@stdlib/array-zero-to' );
+var isnan = require( '@stdlib/math-base-assert-is-nan' );
+var pkg = require( './../package.json' ).name;
+var factory = require( './../lib' );
+
+
+// VARIABLES //
+
+var Float64ArrayFE = factory( 'float64' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var arr = new Float64ArrayFE( 'little-endian', zeroTo( len ) );
+	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( callback );
+			if ( arr.length !== len ) {
+				b.fail( 'should not change an array length' );
+			}
+		}
+		b.toc();
+		if ( arr.length !== len ) {
+			b.fail( 'should not change an array length' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+
+		function callback( value ) {
+			if ( isnan( value ) ) {
+				throw new Error( 'something went wrong' );
+			}
+		}
+	}
+}
+
+
+// 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( pkg+':forEach:len='+len, f );
+	}
+}
+
+main();