Merge branch 'stdlib-js:develop' into mskunary5d

Author: Vinit-Pandit

.github/workflows/slash_commands.yml

@@ -29,9 +29,12 @@ on:
 # Workflow jobs:
 jobs:
 
-  # Add a new job for adding the initial reaction
+  # Define a job for adding an initial reaction:
   add_initial_reaction:
 
+    # Define a display name:
+    name: 'Add initial reaction'
+
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 
@@ -40,7 +43,21 @@ jobs:
 
     # Define the job's steps:
     steps:
-      # Add initial reaction to the comment
+      # Add "bot: In progress" label to the issue / PR:
+      - name: 'Add in-progress label'
+        # Pin action to full length commit SHA
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          github-token: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
+          script: |
+            github.rest.issues.addLabels({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+              labels: ['bot: In Progress']
+            })
+
+      # Add initial reaction to comment with slash command:
       - name: 'Add initial reaction'
         run: |
           COMMENT="${{ github.event.comment.body }}"
@@ -67,6 +84,12 @@ jobs:
   # Define a job for checking for required files:
   check_files:
 
+    # Define a display name:
+    name: 'Check for required files'
+
+    # Ensure initial reaction job has completed before running this job:
+    needs: [ add_initial_reaction ]
+
     # Define the conditions under which the job should run:
     if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib check-files')
 
@@ -81,6 +104,9 @@ jobs:
   # Define a job for updating copyright header years:
   update_copyright_years:
 
+    # Define a display name:
+    name: 'Update copyright header years'
+
     # Define the conditions under which the job should run:
     if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib update-copyright-years')
 
@@ -97,6 +123,12 @@ jobs:
   # Define a job for auto-fixing lint errors:
   fix_lint_errors:
 
+    # Define a display name:
+    name: 'Auto-fix lint errors'
+
+    # Ensure initial reaction job has completed before running this job:
+    needs: [ add_initial_reaction ]
+
     # Define the conditions under which the job should run:
     if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib lint-autofix')
 
@@ -113,6 +145,12 @@ jobs:
   # Define a job for merging develop branch:
   merge_develop:
 
+    # Define a display name:
+    name: 'Merge changes from develop branch into this PR'
+
+    # Ensure initial reaction job has completed before running this job:
+    needs: [ add_initial_reaction ]
+
     # Define the conditions under which the job should run:
     if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib merge')
 
@@ -129,6 +167,12 @@ jobs:
   # Define a job for rebasing on develop branch:
   rebase_develop:
 
+    # Define a display name:
+    name: 'Rebase this PR on top of develop branch'
+
+    # Ensure initial reaction job has completed before running this job:
+    needs: [ add_initial_reaction ]
+
     # Define the conditions under which the job should run:
     if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib rebase')
 
@@ -146,11 +190,14 @@ jobs:
   help:
 
     # Define a display name:
-    name: 'Help'
+    name: 'Print a list of available slash commands'
 
     # Define the type of virtual host machine:
     runs-on: ubuntu-latest
 
+    # Ensure initial reaction job has completed before running this job:
+    needs: [ add_initial_reaction ]
+
     # Define the conditions under which the job should run:
     if: github.event.issue.pull_request && startsWith(github.event.comment.body, '/stdlib help')
 
@@ -176,3 +223,42 @@ jobs:
 
           # GitHub token:
           token: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
+
+  # Define a job for removing the in-progress label:
+  remove_progress_label:
+
+    # Define a display name:
+    name: 'Remove in-progress label'
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Ensure all previous jobs have completed before running this job:
+    needs: [ add_initial_reaction, check_files, update_copyright_years, fix_lint_errors, merge_develop, rebase_develop, help ]
+
+    # Define the conditions under which the job should run:
+    if: |
+      always() &&
+      github.event.issue.pull_request &&
+      startsWith(github.event.comment.body, '/stdlib')
+
+    # Define the job's steps:
+    steps:
+      - name: Remove in-progress label
+        # Run the step regardless of the outcome of previous steps:
+        if: always()
+        # Pin action to full length commit SHA
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          github-token: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
+          script: |
+            try {
+              await github.rest.issues.removeLabel({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                name: 'bot: In Progress'
+              })
+            } catch (error) {
+              console.log( 'Error removing label:', error );
+            }

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

@@ -338,6 +338,54 @@ v = arr.at( -100 );
 // returns undefined
 ```
 
+<a name="method-every"></a>
+
+#### TypedArrayFE.prototype.every( predicate\[, thisArg] )
+
+Tests whether all the elements in an array pass a test implemented by a predicate function.
+
+```javascript
+function isNegative( v ) {
+    return v < 0;
+}
+
+var Float64ArrayFE = fixedEndianFactory( 'float64' );
+
+var arr = new Float64ArrayFE( 'little-endian', [ -1.0, -2.0, -3.0, -4.0 ] );
+
+var bool = arr.every( isNegative );
+// returns true
+```
+
+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 isPositive( v, i ) {
+    this.count += 1;
+    return v > 0;
+}
+
+var Float64ArrayFE = fixedEndianFactory( 'float64' );
+
+var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, -3.0 ] );
+
+var context = {
+    'count': 0
+};
+
+var bool = arr.every( isPositive, context );
+// returns false
+
+var count = context.count;
+// returns 3
+```
+
 <a name="method-for-each"></a>
 
 #### TypedArrayFE.prototype.forEach( callbackFn\[, thisArg] )

lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.every.js

@@ -0,0 +1,60 @@
+/**
+* @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 isBoolean = require( '@stdlib/assert/is-boolean' );
+var pkg = require( './../package.json' ).name;
+var factory = require( './../lib' );
+
+
+// VARIABLES //
+
+var Float64ArrayFE = factory( 'float64' );
+
+
+// MAIN //
+
+bench( pkg+':every', function benchmark( b ) {
+	var bool;
+	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++ ) {
+		bool = arr.every( predicate );
+		if ( typeof bool !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( bool ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+
+	function predicate( v ) {
+		return v > 0;
+	}
+});

lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.every.length.js

@@ -0,0 +1,113 @@
+/**
+* @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 isBoolean = require( '@stdlib/assert/is-boolean' );
+var pkg = require( './../package.json' ).name;
+var factory = require( './../lib' );
+
+
+// VARIABLES //
+
+var Float64ArrayFE = factory( 'float64' );
+
+
+// FUNCTIONS //
+
+/**
+* Predicate function.
+*
+* @private
+* @param {boolean} value - array element
+* @param {NonNegativeInteger} idx - array element index
+* @param {TypedArray} arr - array instance
+* @returns {boolean} boolean indicating whether a value passes a test
+*/
+function predicate( value ) {
+	return value >= 0;
+}
+
+/**
+* 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 bool;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			bool = arr.every( predicate );
+			if ( typeof bool !== 'boolean' ) {
+				b.fail( 'should return a boolean' );
+			}
+		}
+		b.toc();
+		if ( !isBoolean( bool ) ) {
+			b.fail( 'should return a boolean' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// 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+':every:len='+len, f );
+	}
+}
+
+main();