Merge branch 'temp' into find_index

Author: pranav-1720

.github/workflows/lint_random_files.yml

@@ -389,7 +389,11 @@ jobs:
 
       # Create sub-issue for C linting failures:
       - name: 'Create sub-issue for C lint failures'
+<<<<<<< HEAD
         if: ( github.event.inputs.c != 'false' ) && failure() && contains(steps.*.outcome, 'failure') && contains(steps.lint-c.outcome, 'failure')
+=======
+        if: ( github.event.inputs.c != 'false' ) && failure() && contains(steps.*.outcome, 'failure') && contains(job.steps.*.name, 'Lint C files')
+>>>>>>> temp
         env:
           GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_GITHUB_TOKEN }}
         run: |

CONTRIBUTORS

@@ -3,7 +3,12 @@
 # Contributors listed in alphabetical order.
 
 Aayush Khanna <[email protected]>
+<<<<<<< HEAD
 Abhijit Raut <[email protected]>
+=======
+Abhijit <[email protected]>
+AbhijitRaut04 <[email protected]>
+>>>>>>> temp
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
 AgPriyanshu18 <[email protected]>

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

@@ -354,13 +354,12 @@ function isNegative( v ) {
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', [ -1.0, -2.0, -3.0, -4.0 ] );
-// returns <Float64ArrayFE>
 
 var bool = arr.every( isNegative );
 // returns true
 ```
 
-The `predicate` function is provided three arguments:
+The invoked function is provided three arguments:
 
 -   **value**: current array element.
 -   **index**: current array element index.
@@ -377,7 +376,6 @@ function isPositive( v, i ) {
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
 var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, -3.0 ] );
-// returns <Float64ArrayFE>
 
 var context = {
     'count': 0
@@ -390,14 +388,14 @@ var count = context.count;
 // returns 3
 ```
 
-<a name="method-every"></a>
+<a name="method-find-index"></a>
 
-#### TypedArrayFE.prototype.findIndex( callbackFn\[, thisArg] )
+#### TypedArrayFE.prototype.findIndex( predicate\[, thisArg] )
 
-Tests whether all the elements in an array pass a test implemented by a predicate function.
+Returns the index of the first element in a typed array for which a predicate function returns a truthy value.
 
 ```javascript
-function greaterthantwo( v ) {
+function predicate( v ) {
     return ( v > 2.0 );
 }
 
@@ -409,11 +407,11 @@ arr.set( 1.5, 0 );
 arr.set( 2.5, 1 );
 arr.set( 3.5, 2 );
 
-var bool = arr.every( isNegative );
-// returns true
+var idx = arr.findIndex( predicate );
+// returns 1
 ```
 
-The invoked function is provided three arguments:
+The `predicate` function is provided three arguments:
 
 -   **value**: current array element.
 -   **index**: current array element index.
@@ -422,24 +420,27 @@ The invoked function is provided three arguments:
 To set the function execution context, provide a `thisArg`.
 
 ```javascript
-function isPositive( v, i ) {
+function predicate( v, i ) {
     this.count += 1;
-    return v > 0;
+    return ( v === 2.0 );
 }
 
 var Float64ArrayFE = fixedEndianFactory( 'float64' );
 
-var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, -3.0 ] );
+var arr = new Float64ArrayFE( 'little-endian', 3 );
 
 var context = {
     'count': 0
 };
 
-var bool = arr.every( isPositive, context );
-// returns false
+arr.set( 1.0, 0 );
+arr.set( 2.0, 1 );
+arr.set( 3.0, 2 );
+
+arr.findIndex( predicate, context );
 
 var count = context.count;
-// returns 3
+// returns 2
 ```
 
 <a name="method-for-each"></a>

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

@@ -0,0 +1,58 @@
+/**
+* @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 isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var factory = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+':findIndex', function benchmark( b ) {
+	var ctor;
+	var arr;
+	var idx;
+	var i;
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0 ] );
+	idx = arr.findIndex( predicate );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		idx = arr.findIndex( predicate );
+		if ( typeof idx !== 'number' ) {
+			b.fail( 'should return an integer' );
+		}
+	}
+	b.toc();
+	if ( !isInteger( idx ) ) {
+		b.fail( 'should return an integer' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+
+	function predicate( v ) {
+		return ( v === 3.0 );
+	}
+});

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

@@ -0,0 +1,106 @@
+/**
+* @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 idx;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			idx = arr.findIndex( callback );
+			if ( typeof idx !== 'number' ) {
+				b.fail( 'should return an integer' );
+			}
+		}
+		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+':findIndex:len='+len, f );
+	}
+}
+
+main();

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

@@ -538,37 +538,6 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
 	*/
 	setReadOnly( TypedArray.prototype, 'BYTES_PER_ELEMENT', TypedArray.BYTES_PER_ELEMENT );
 
-	/**
-	* Tests whether all elements in an array pass a test implemented by a predicate function.
-	*
-	* @name every
-	* @memberof TypedArray.prototype
-	* @type {Function}
-	* @param {Function} predicate - predicate function
-	* @param {*} [thisArg] - predicate function execution context
-	* @throws {TypeError} `this` must be a typed array instance
-	* @throws {TypeError} first argument must be a function
-	* @returns {boolean} boolean indicating whether all elements pass a test
-	*/
-	setReadOnly( TypedArray.prototype, 'every', function every( predicate, thisArg ) {
-		var buf;
-		var i;
-
-		if ( !isTypedArray( this ) ) {
-			throw new TypeError( format( 'invalid invocation. `this` is not %s %s.', CHAR2ARTICLE[ dtype[0] ], CTOR_NAME ) );
-		}
-		if ( !isFunction( predicate ) ) {
-			throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', predicate ) );
-		}
-		buf = this._buffer;
-		for ( i = 0; i < this._length; i++ ) {
-			if ( !predicate.call( thisArg, buf[ GETTER ]( i * BYTES_PER_ELEMENT, this._isLE ), i, this ) ) {
-				return false;
-			}
-		}
-		return true;
-	});
-
 	/**
 	* Tests whether all elements in an array pass a test implemented by a predicate function.
 	*
@@ -601,18 +570,18 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
 	});
 
 	/**
-	* Tests whether all elements in an array pass a test implemented by a predicate function.
+	*  Returns the index of the first element in an array for which a predicate function returns a truthy value.
 	*
-	* @name every
+	* @name findIndex
 	* @memberof TypedArray.prototype
 	* @type {Function}
-	* @param {Function} predicate - predicate function
+	* @param {Function} predicate - function to invoke
 	* @param {*} [thisArg] - function invocation context
 	* @throws {TypeError} `this` must be a typed array instance
 	* @throws {TypeError} first argument must be a function
-	* @returns {boolean} boolean indicating whether all elements pass a test
+	* @returns {integer} index or -1
 	*/
-	setReadOnly( TypedArray.prototype, 'every', function every( predicate, thisArg ) {
+	setReadOnly( TypedArray.prototype, 'findIndex', function findIndex( predicate, thisArg ) {
 		var buf;
 		var i;
 
@@ -622,13 +591,14 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
 		if ( !isFunction( predicate ) ) {
 			throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', predicate ) );
 		}
+
 		buf = this._buffer;
-		for ( i = 0; i < this._length; i++ ) {
-			if ( !predicate.call( thisArg, buf[ GETTER ]( i * BYTES_PER_ELEMENT, this._isLE ), i, this ) ) {
-				return false;
+		for (i = 0; i < this._length; i++) {
+			if ( predicate.call(thisArg, buf[GETTER](i * BYTES_PER_ELEMENT, this._isLE), i, this ) ) {
+				return i;
 			}
 		}
-		return true;
+		return -1;
 	});
 
 	/**