diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md b/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md index 985e4560ca9b..bb7c6d81caa6 100644 --- a/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md +++ b/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md @@ -386,6 +386,69 @@ var count = context.count; // returns 3 ``` + + +#### TypedArrayFE.prototype.find( predicate\[, thisArg] ) + +Returns the first element in the array that satisfies the provided testing function (predicate). Otherwise, returns `undefined` if no element satisfies the condition. + +```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 value = arr.find( isNegative ); +// returns -1.0 (the first negative value) +``` + +The `predicate` 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 isEven( v, i ) { + this.count += 1; + return v % 2 === 0; +} + +var Float64ArrayFE = fixedEndianFactory( 'float64' ); + +var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0, 4.0 ] ); + +var context = { + 'count': 0 +}; + +var value = arr.find( isEven, context ); +// returns 2.0 + +var count = context.count; +// returns 2 +``` + +If no element in the array satisfies the predicate, the method returns undefined. + +```javascript +function isGreaterThan( v ) { + return v > 10; +} + +var Float64ArrayFE = fixedEndianFactory( 'float64' ); + +var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0 ] ); + +var value = arr.find( isGreaterThan ); +// returns undefined +``` + #### TypedArrayFE.prototype.forEach( callbackFn\[, thisArg] ) @@ -542,6 +605,8 @@ var str = arr.toString(); // returns '1,2,3' ``` + + diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.find.js b/lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.find.js new file mode 100644 index 000000000000..45afd6328327 --- /dev/null +++ b/lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.find.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 isnan = require( '@stdlib/assert/is-nan' ); +var pkg = require( './../package.json' ).name; +var factory = require( './../lib' ); + + +// VARIABLES // + +var Float64ArrayFE = factory( 'float64' ); + + +// MAIN // + +bench( pkg+':find', function benchmark( b ) { + var value; + var arr; + var i; + + arr = new Float64ArrayFE( 'little-endian', [ 1.0, -2.0, 3.0, -4.0, 5.0 ] ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + value = arr.find( predicate ); + if ( isnan( value ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( value ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + + function predicate( v ) { + return v > 0; + } +}); diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.find.length.js b/lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.find.length.js new file mode 100644 index 000000000000..a4324cbf6db3 --- /dev/null +++ b/lib/node_modules/@stdlib/array/fixed-endian-factory/benchmark/benchmark.find.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 isnan = require( '@stdlib/assert/is-nan' ); +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 value; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + value = arr.find( predicate ); + if ( isnan( value ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( value ) ) { + b.fail( 'should not return NaN' ); + } + 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+':find:len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js b/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js index d15a80bf7da2..5df38c0df4fe 100644 --- a/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js +++ b/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js @@ -569,6 +569,35 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli return true; }); + /** + * Finds the first element in the array that satisfies the provided testing function. + * + * @private + * @name find + * @memberof TypedArray.prototype + * @type {Function} + * @param {Function} predicate - Function to test each element of the array. + * @param {*} [thisArg] - predicate function execution context + * @throws {TypeError} `this` must be a typed array instance + * @returns {*} The value of the first element in the array that satisfies the testing function. Otherwise, undefined. + */ + setReadOnly(TypedArray.prototype, 'find', function find(predicate, thisArg) { + var value; + var i; + if (!isTypedArray(this)) { + throw new TypeError('invalid invocation. `this` is not a typed array instance.'); + } + if (typeof predicate !== 'function') { + throw new TypeError(format( 'invalid argument. First argument must be a function. Value: `%s`.', predicate ) ); + } + for (i = 0; i < this._length; i++) { + value = this._buffer[GETTER](i * BYTES_PER_ELEMENT, this._isLE); + if (predicate.call(thisArg, value, i, this)) { + return value; + } + } + }); + /** * Invokes a function once for each array element. * diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/test/test.find.js b/lib/node_modules/@stdlib/array/fixed-endian-factory/test/test.find.js new file mode 100644 index 000000000000..17f52107127c --- /dev/null +++ b/lib/node_modules/@stdlib/array/fixed-endian-factory/test/test.find.js @@ -0,0 +1,190 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2023 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 tape = require( 'tape' ); +var hasOwnProp = require( '@stdlib/assert/has-own-property' ); +var isFunction = require( '@stdlib/assert/is-function' ); +var factory = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof factory, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns a function', function test( t ) { + var ctor = factory( 'float64' ); + t.strictEqual( isFunction( ctor ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'attached to the prototype of the returned function is an `every` method', function test( t ) { + var ctor = factory( 'float64' ); + t.strictEqual( hasOwnProp( ctor.prototype, 'find' ), true, 'returns expected value' ); + t.strictEqual( isFunction( ctor.prototype.find ), true, 'returns expected value' ); + t.end(); +}); + +tape( 'the method throws an error if invoked with a `this` context which is not a typed array instance', function test( t ) { + var values; + var ctor; + var arr; + var i; + + ctor = factory( 'float64' ); + arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + + values = [ + '5', + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + function noop() {} + ]; + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + return arr.find.call( value, predicate ); + }; + } + function predicate( v ) { + return v < 0; + } +}); + +tape( 'the method throws an error if provided a first argument which is not a function', function test( t ) { + var values; + var ctor; + var arr; + var i; + + ctor = factory( 'float64' ); + arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0 ] ); + + values = [ + '5', + 3.14, + NaN, + true, + false, + null, + void 0, + {}, + [] + ]; + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + return arr.find( value ); + }; + } +}); + +tape( 'the method returns `undefined` if operating on an empty array', function test( t ) { + var result; + var ctor; + var arr; + + ctor = factory( 'float64' ); + arr = new ctor( 'little-endian' ); + result = arr.find( predicate ); + + t.strictEqual( result, undefined, 'returns expected value' ); + t.end(); + + function predicate() { + t.fail( 'should not be invoked' ); + } +}); + +tape( 'the method returns the first element that satisfies the predicate', function test( t ) { + var result; + var ctor; + var arr; + + ctor = factory( 'float64' ); + arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + result = arr.find( predicate ); + + t.strictEqual( result, 1.0, 'returns expected value' ); + t.end(); + + function predicate( v ) { + return v > 0; + } +}); + +tape( 'the method returns `undefined` if no elements satisfy the predicate', function test( t ) { + var result; + var ctor; + var arr; + + ctor = factory( 'float64' ); + arr = new ctor( 'little-endian', [ -1.0, -2.0, -3.0, -4.0, -5.0 ] ); + result = arr.find( predicate ); + + t.strictEqual( result, undefined, 'returns expected value' ); + t.end(); + + function predicate( v ) { + return v > 0; + } +}); + +tape( 'the method supports providing an execution context', function test( t ) { + var result; + var ctor; + var arr; + var ctx; + + ctor = factory( 'float64' ); + arr = new ctor( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + ctx = { + 'count': 0 + }; + result = arr.find( predicate, ctx ); + + t.strictEqual( result, 1.0, 'returns expected value' ); + t.strictEqual( ctx.count, 1.0, 'returns expected value' ); + t.end(); + + function predicate( v ) { + this.count += 1; // eslint-disable-line no-invalid-this + return v > 0; + } +});