fixup! feat: add some method to array/fixed-endian-factory #3241

Author: Kshitij-Dale

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

@@ -357,26 +357,6 @@ var bool = arr.every( isNegative );
 // returns true
 ```
 
-
-<a name="method-some"></a>
-
-#### TypedArrayFE.prototype.some( predicate\[, thisArg] )
-
-Tests whether any element in an array pass a test implemented by a predicate function.
-
-```javascript
-function isPositive( 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.some( isPositive );
-// returns true
-```
-
 The invoked function is provided three arguments:
 
 -   **value**: current array element.
@@ -547,6 +527,52 @@ A few notes:
 -   If a target array cannot accommodate all values (i.e., the length of source array plus `i` exceeds the target array length), the method throws an error.
 -   If provided a typed array which shares an [`ArrayBuffer`][@stdlib/array/buffer] with the target array, the method will intelligently copy the source range to the destination range.
 
+<a name="method-some"></a>
+
+#### TypedArrayFE.prototype.some( predicate\[, thisArg] )
+
+Tests whether at least one element in an array passes a test implemented by a predicate function.
+
+```javascript
+function isPositive( 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.some( isPositive );
+// 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.some( isPositive, context );
+// returns false
+
+var count = context.count;
+// returns 3
+```
+
 <a name="method-to-string"></a>
 
 #### TypedArrayFE.prototype.toString()

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

@@ -38,7 +38,7 @@ bench( pkg+':some', function benchmark( b ) {
 	var arr;
 	var i;
 
-	arr = new Float64ArrayFE( 'little-endian', [ 1.0, -2.0, 2.0, 1.0 ] );
+	arr = new Float64ArrayFE( 'little-endian', [ -1.0, -2.0, -2.0, 1.0 ] );
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {

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

@@ -45,7 +45,7 @@ var Float64ArrayFE = factory( 'float64' );
 * @returns {boolean} boolean indicating whether a value passes a test
 */
 function predicate( value ) {
-	return value >= 1;
+	return value < 0;
 }
 
 /**
@@ -106,7 +106,7 @@ function main() {
 	for ( i = min; i <= max; i++ ) {
 		len = pow( 10, i );
 		f = createBenchmark( len );
-		bench( pkg+':every:len='+len, f );
+		bench( pkg+':some:len='+len, f );
 	}
 }
 

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

@@ -569,37 +569,6 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
 		return true;
 	});
 
-	/**
-	* Tests whether at least one element in the typed array passes the test implemented by the provided function.
-	*
-	* @name some
-	* @memberof TypedArray.prototype
-	* @type {Function}
-	* @param {Function} fcn - predicate function
-	* @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 any elements pass a test
-	*/
-	setReadOnly( TypedArray.prototype, 'some', function some( fcn, 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( 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++ ) {
-			if ( fcn.call( thisArg, buf[ GETTER ]( i * BYTES_PER_ELEMENT, this._isLE ), i, this ) ) {
-				return true;
-			}
-		}
-		return false;
-	});
-
 	/**
 	* Invokes a function once for each array element.
 	*
@@ -760,6 +729,37 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
 		buf[ SETTER ]( idx*BYTES_PER_ELEMENT, value, this._isLE );
 	});
 
+	/**
+	* Tests whether at least one element in the typed array passes a test implemented by a predicate function.
+	*
+	* @name some
+	* @memberof TypedArray.prototype
+	* @type {Function}
+	* @param {Function} predicate - predicate function
+	* @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 at least one element passes a test
+	*/
+	setReadOnly( TypedArray.prototype, 'some', function some( 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 true;
+			}
+		}
+		return false;
+	});
+
 	/**
 	* Serializes an array as a string.
 	*

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

@@ -40,7 +40,7 @@ tape( 'the function returns a function', function test( t ) {
 	t.end();
 });
 
-tape( 'attached to the prototype of the returned function is an `some` method', function test( t ) {
+tape( 'attached to the prototype of the returned function is a `some` method', function test( t ) {
 	var ctor = factory( 'float64' );
 	t.strictEqual( hasOwnProp( ctor.prototype, 'some' ), true, 'returns expected value' );
 	t.strictEqual( isFunction( ctor.prototype.some ), true, 'returns expected value' );
@@ -132,7 +132,7 @@ tape( 'the method returns `false` if operating on an empty array', function test
 	}
 });
 
-tape( 'the method returns `true` if any element pass a test', function test( t ) {
+tape( 'the method returns `true` if at least one element passes a test', function test( t ) {
 	var bool;
 	var ctor;
 	var arr;
@@ -166,6 +166,31 @@ tape( 'the method returns `false` if all elements fail a test', function test( t
 	}
 });
 
+tape( 'the method stops executing upon encountering the first element which passes a test', function test( t ) {
+	var bool;
+	var ctor;
+	var arr;
+	var ctx;
+
+	ctx = {
+		'count': 0
+	};
+
+	ctor = factory( 'float64' );
+	arr = new ctor( 'little-endian', [ -1.0, -2.0, -3.0, 4.0, -5.0 ] );
+	bool = arr.some( predicate, ctx );
+
+	t.strictEqual( bool, true, 'returns expected value' );
+	t.strictEqual( ctx.count, 4, 'returns expected value' );
+
+	t.end();
+
+	function predicate( v ) {
+		this.count += 1; // eslint-disable-line no-invalid-this
+		return v > 0;
+	}
+});
+
 tape( 'the method supports providing an execution context', function test( t ) {
 	var bool;
 	var ctor;