Merge branch 'stdlib-js:develop' into test-dnanasumors

Author: Neerajpathak07

lib/node_modules/@stdlib/_tools/scripts/publish_packages.js

@@ -1061,6 +1061,10 @@ function publish( pkg, clbk ) {
 	}
 	fs.copyFileSync( join( __dirname, 'templates', 'workflow_cancel.yml.txt' ), join( dist, '.github', 'workflows', 'cancel.yml' ) );
 
+	workflow = readFileSync( join( __dirname, 'templates', 'workflow_test_published_package.yml.txt' ), 'utf8' );
+	workflow = replace( workflow, '{{cron}}', schedule );
+	writeFileSync( join( dist, '.github', 'workflows', 'test_published_package.yml' ), workflow );
+
 	// Write the current date to the `.keepalive` file...
 	if ( flags[ 'keep-alive' ] ) {
 		fs.writeFileSync( join( dist, '.github', '.keepalive' ), new Date().toISOString() + '\n' );

lib/node_modules/@stdlib/_tools/scripts/templates/workflow_test_published_package.yml.txt

@@ -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.
+#/
+
+# Workflow name:
+name: test_published_package
+
+# Workflow triggers:
+on:
+  # Run workflow on a weekly schedule:
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  '{{cron}}'
+
+  # Run workflow upon completion of `publish` workflow run:
+  workflow_run:
+    workflows: ["publish"]
+    types: [completed]
+
+  # Allow workflow to be manually run:
+  workflow_dispatch:
+
+# Workflow jobs:
+jobs:
+  test-published:
+    # Define a display name:
+    name: 'Test running examples of published package'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define environment variables:
+    env:
+      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+
+    # Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
+
+    # Define the job's steps:
+    steps:
+      # Checkout the repository:
+      - name: 'Checkout repository'
+        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0
+
+      # Install Node.js:
+      - name: 'Install Node.js'
+        uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
+        with:
+          node-version: 20
+        timeout-minutes: 5
+
+      # Create test directory and run examples:
+      - name: 'Create test directory and run examples'
+        run: |
+          cd ..
+          mkdir test-published
+          cd test-published
+
+          # Copy example file:
+          cp $GITHUB_WORKSPACE/examples/index.js .
+
+          # Create a minimal package.json
+          echo '{
+            "name": "test-published",
+            "version": "1.0.0",
+            "main": "index.js",
+            "dependencies": {}
+          }' > package.json
+
+          # Get package name and modify example file:
+          PACKAGE_NAME=$(jq -r '.name' $GITHUB_WORKSPACE/package.json)
+          ESCAPED_PACKAGE_NAME=$(echo "$PACKAGE_NAME" | sed 's/[\/&]/\\&/g')
+
+          sed -i "s/require( '.\/..\/lib' )/require( '$ESCAPED_PACKAGE_NAME' )/g" index.js
+
+          # Extract and install dependencies:
+          DEPS=$(grep -oP "require\(\s*'([^']+)'\s*\)" index.js | sed "s/require(\s*'//" | sed "s/'\s*)//" | grep -v "^\.")
+          for dep in $DEPS; do
+            npm install $dep --save
+          done
+
+          # Run the example:
+          node index.js
+
+      # Send Slack notification if job fails:
+      - name: 'Send notification to Slack in case of failure'
+        uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2
+        with:
+          status: ${{ job.status }}
+          channel: '#npm-ci'
+        if: failure()

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

@@ -869,7 +869,7 @@ Invokes a function once for each array element.
 
 ```javascript
 function log( v, i ) {
-    console.log( '%s: %s', i, v.toString() );
+    console.log( '%s: %s', i.toString(), v.toString() );
 }
 
 var arr = new BooleanArray( 3 );
@@ -897,7 +897,7 @@ To set the function execution context, provide a `thisArg`.
 ```javascript
 function fcn( v, i ) {
     this.count += 1;
-    console.log( '%s: %s', i, v.toString() );
+    console.log( '%s: %s', i.toString(), v.toString() );
 }
 
 var arr = new BooleanArray( 3 );
@@ -911,11 +911,6 @@ arr.set( false, 1 );
 arr.set( true, 2 );
 
 arr.forEach( fcn, context );
-/* =>
-    0: 1 + 1i
-    1: 2 + 2i
-    2: 3 + 3i
-*/
 
 var count = context.count;
 // returns 3

lib/node_modules/@stdlib/array/fixed-endian-factory/README.md

@@ -306,6 +306,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 )

lib/node_modules/@stdlib/array/fixed-endian-factory/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' );
+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' );
+		}
+	}
+});

lib/node_modules/@stdlib/array/fixed-endian-factory/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' );
+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();