feat: add findIndex method to array/fixed-endian-factory
#3239
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stdlib-bot
reviewed
Nov 24, 2024
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
changed the title
findIndex method to array/fixed-endian-factory
kgryte
added
Feature
kgryte
reviewed
Nov 25, 2024
| @@ -338,6 +338,62 @@ v = arr.at( -100 ); | |||
| // returns undefined | |||
| ``` | |||
|
|
|||
| <a name="method-find-index"></a> | |||
|
|
|||
| #### TypedArrayFE.prototype.findIndex( callbackFn\[, thisArg] ) | |||
There was a problem hiding this comment.
Suggested change
| #### TypedArrayFE.prototype.findIndex( callbackFn\[, thisArg] ) | |
| #### TypedArrayFE.prototype.findIndex( predicate\[, thisArg] ) |
Renaming to ensure consistent documentation across array types.
kgryte
reviewed
Nov 25, 2024
Comment on lines
345
to
346
| Returns the index of the first element in a typed array that satisfies the provided testing function. | ||
| If no element satisfies function, return -1. |
There was a problem hiding this comment.
Suggested change
| Returns the index of the first element in a typed array that satisfies the provided testing function. | |
| If no element satisfies function, return -1. | |
| Returns the index of the first element in a typed array for which a predicate function returns a truthy value. |
To ensure consistent docs across array types.
kgryte
reviewed
Nov 25, 2024
Comment on lines
349
to
361
| function greaterthantwo( v ) { | ||
| return ( v > 2.0 ); | ||
| } | ||
|
|
||
| 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 ); | ||
|
|
||
| var idx = arr.findIndex( greaterthantwo ); |
There was a problem hiding this comment.
Suggested change
| function greaterthantwo( v ) { | |
| return ( v > 2.0 ); | |
| } | |
| 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 ); | |
| var idx = arr.findIndex( greaterthantwo ); | |
| function predicate( v ) { | |
| return ( v > 2.0 ); | |
| } | |
| 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 ); | |
| var idx = arr.findIndex( predicate ); |
kgryte
reviewed
Nov 25, 2024
| // returns 1 | ||
| ``` | ||
|
|
||
| The invoked function is provided three arguments: |
There was a problem hiding this comment.
Suggested change
| The invoked function is provided three arguments: | |
| The `predicate` function is provided three arguments: |
kgryte
reviewed
Nov 25, 2024
Comment on lines
374
to
391
| function fcn( v, i ) { | ||
| this.count += 1; | ||
| return (v === 2.0); | ||
| } | ||
|
|
||
| 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.findIndex( fcn, context ); |
There was a problem hiding this comment.
Suggested change
| function fcn( v, i ) { | |
| this.count += 1; | |
| return (v === 2.0); | |
| } | |
| 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.findIndex( fcn, context ); | |
| function predicate( v, i ) { | |
| this.count += 1; | |
| return ( v === 2.0 ); | |
| } | |
| 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.findIndex( predicate, context ); |
kgryte
reviewed
Nov 25, 2024
Comment on lines
41
to
57
| function predicate( v ) { | ||
| return ( v === 3.0 ); | ||
| } | ||
|
|
||
| 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(); |
There was a problem hiding this comment.
Suggested change
| function predicate( v ) { | |
| return ( v === 3.0 ); | |
| } | |
| 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(); | |
| 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 ); | |
| } |
We typically place function declarations at the end of their scope.
kgryte
reviewed
Nov 25, 2024
| * @returns {Function} benchmark function | ||
| */ | ||
| function createBenchmark( len ) { | ||
| var arr = new Float64ArrayFE( 'little-endian', zeroTo(len)); |
There was a problem hiding this comment.
Suggested change
| var arr = new Float64ArrayFE( 'little-endian', zeroTo(len)); | |
| var arr = new Float64ArrayFE( 'little-endian', zeroTo( len ) ); |
kgryte
reviewed
Nov 25, 2024
|
|
||
| b.tic(); | ||
| for ( i = 0; i < b.iterations; i++ ) { | ||
| idx=arr.findIndex( callback ); |
There was a problem hiding this comment.
Suggested change
| idx=arr.findIndex( callback ); | |
| idx = arr.findIndex( callback ); |
kgryte
reviewed
Nov 25, 2024
| for ( i = min; i <= max; i++ ) { | ||
| len = pow( 10, i ); | ||
| f = createBenchmark( len ); | ||
| bench( pkg+':forEach:len='+len, f ); |
There was a problem hiding this comment.
Suggested change
| bench( pkg+':forEach:len='+len, f ); | |
| bench( pkg+':findIndex:len='+len, f ); |
kgryte
reviewed
Nov 25, 2024
| * @name findIndex | ||
| * @memberof TypedArray.prototype | ||
| * @type {Function} | ||
| * @param {Function} callbackFn - function to invoke |
There was a problem hiding this comment.
Suggested change
| * @param {Function} callbackFn - function to invoke | |
| * @param {Function} predicate - predicate function |
I suggest renaming here and below.
kgryte
reviewed
Nov 25, 2024
| @@ -538,6 +538,39 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli | |||
| */ | |||
| setReadOnly( TypedArray.prototype, 'BYTES_PER_ELEMENT', TypedArray.BYTES_PER_ELEMENT ); | |||
|
|
|||
| /** | |||
| * Invokes a function once for each array element. | |||
There was a problem hiding this comment.
Suggested change
| * Invokes a function once for each array element. | |
| * Returns the index of the first element in an array for which a predicate function returns a truthy value. |
kgryte
reviewed
Nov 25, 2024
| * @param {*} [thisArg] - function invocation context | ||
| * @throws {TypeError} `this` must be a typed array instance | ||
| * @throws {TypeError} first argument must be a function | ||
| */ |
There was a problem hiding this comment.
Missing @returns documentation. See array/bool.
kgryte
reviewed
Nov 25, 2024
Comment on lines
565
to
567
| for (i = 0; i < this._length; i++) { | ||
| result = fcn.call(thisArg, buf[GETTER](i * BYTES_PER_ELEMENT, this._isLE), i, this); | ||
| if (result) { |
There was a problem hiding this comment.
Suggested change
| for (i = 0; i < this._length; i++) { | |
| result = fcn.call(thisArg, buf[GETTER](i * BYTES_PER_ELEMENT, this._isLE), i, this); | |
| if (result) { | |
| for ( i = 0; i < this._length; i++ ) { | |
| if ( fcn.call( thisArg, buf[ GETTER ] ( i * BYTES_PER_ELEMENT, this._isLE ), i, this ) ) { |
Use consistent spacing.
kgryte
reviewed
Nov 25, 2024
| * @throws {TypeError} first argument must be a function | ||
| */ | ||
| setReadOnly( TypedArray.prototype, 'findIndex', function findIndex( fcn, thisArg ) { | ||
| var result; |
kgryte
reviewed
Nov 25, 2024
| return i; | ||
| } | ||
| } | ||
| return -1; // Not found |
There was a problem hiding this comment.
Suggested change
| return -1; // Not found | |
| return -1; |
kgryte
reviewed
Nov 25, 2024
| t.end(); | ||
| }); | ||
|
|
||
| tape( 'attached to the prototype of the returned function is a `forEach` method', function test( t ) { |
There was a problem hiding this comment.
Suggested change
| tape( 'attached to the prototype of the returned function is a `forEach` method', function test( t ) { | |
| tape( 'attached to the prototype of the returned function is a `findIndex` method', function test( t ) { |
kgryte
requested changes
Nov 25, 2024
There was a problem hiding this comment.
Thanks for working on this, @pranav-1720. Left an initial round of comments.
|
@pranav-1720 Would you also mind resolving the merge conflict? Thanks! |
kgryte
added
Needs Changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #3142.
Description
This pull request:
Related Issues
This pull request:
Questions
No.
Other
No.
Checklist
@stdlib-js/reviewers