Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions lib/node_modules/@stdlib/array/fixed-endian-factory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,69 @@ var count = context.count;
// returns 3
```

<a name="method-find"></a>

#### 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
```

<a name="method-for-each"></a>

#### TypedArrayFE.prototype.forEach( callbackFn\[, thisArg] )
Expand Down Expand Up @@ -542,6 +605,8 @@ var str = arr.toString();
// returns '1,2,3'
```



</section>

<!-- /.usage -->
Expand Down
Original file line number Diff line number Diff line change
@@ -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;
}
});
Original file line number Diff line number Diff line change
@@ -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();
29 changes: 29 additions & 0 deletions lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
setReadOnly(TypedArray.prototype, 'find', function find(predicate, thisArg) {
setReadOnly( TypedArray.prototype, 'find', function find( predicate, thisArg ) {

var value;
var i;
if (!isTypedArray(this)) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (!isTypedArray(this)) {
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;
Comment on lines +588 to +596
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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;
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;

please do same for all your changes

}
}
});

/**
* Invokes a function once for each array element.
*
Expand Down
Loading