Skip to content

Commit e3a2173

Browse files
aayush0325kgryte
andauthored
feat: add every method to array/fixed-endian-factory
PR-URL: #3200 Closes: #3138 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: Athan Reines <[email protected]>
1 parent eed9bc2 commit e3a2173

File tree

5 files changed

+443
-0
lines changed

5 files changed

+443
-0
lines changed

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,54 @@ v = arr.at( -100 );
338338
// returns undefined
339339
```
340340

341+
<a name="method-every"></a>
342+
343+
#### TypedArrayFE.prototype.every( predicate\[, thisArg] )
344+
345+
Tests whether all the elements in an array pass a test implemented by a predicate function.
346+
347+
```javascript
348+
function isNegative( v ) {
349+
return v < 0;
350+
}
351+
352+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
353+
354+
var arr = new Float64ArrayFE( 'little-endian', [ -1.0, -2.0, -3.0, -4.0 ] );
355+
356+
var bool = arr.every( isNegative );
357+
// returns true
358+
```
359+
360+
The invoked function is provided three arguments:
361+
362+
- **value**: current array element.
363+
- **index**: current array element index.
364+
- **arr**: the array on which this method was called.
365+
366+
To set the function execution context, provide a `thisArg`.
367+
368+
```javascript
369+
function isPositive( v, i ) {
370+
this.count += 1;
371+
return v > 0;
372+
}
373+
374+
var Float64ArrayFE = fixedEndianFactory( 'float64' );
375+
376+
var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, -3.0 ] );
377+
378+
var context = {
379+
'count': 0
380+
};
381+
382+
var bool = arr.every( isPositive, context );
383+
// returns false
384+
385+
var count = context.count;
386+
// returns 3
387+
```
388+
341389
<a name="method-for-each"></a>
342390

343391
#### TypedArrayFE.prototype.forEach( callbackFn\[, thisArg] )
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isBoolean = require( '@stdlib/assert/is-boolean' );
25+
var pkg = require( './../package.json' ).name;
26+
var factory = require( './../lib' );
27+
28+
29+
// VARIABLES //
30+
31+
var Float64ArrayFE = factory( 'float64' );
32+
33+
34+
// MAIN //
35+
36+
bench( pkg+':every', function benchmark( b ) {
37+
var bool;
38+
var arr;
39+
var i;
40+
41+
arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 2.0, 1.0 ] );
42+
43+
b.tic();
44+
for ( i = 0; i < b.iterations; i++ ) {
45+
bool = arr.every( predicate );
46+
if ( typeof bool !== 'boolean' ) {
47+
b.fail( 'should return a boolean' );
48+
}
49+
}
50+
b.toc();
51+
if ( !isBoolean( bool ) ) {
52+
b.fail( 'should return a boolean' );
53+
}
54+
b.pass( 'benchmark finished' );
55+
b.end();
56+
57+
function predicate( v ) {
58+
return v > 0;
59+
}
60+
});
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var pow = require( '@stdlib/math/base/special/pow' );
25+
var zeroTo = require( '@stdlib/array/zero-to' );
26+
var isBoolean = require( '@stdlib/assert/is-boolean' );
27+
var pkg = require( './../package.json' ).name;
28+
var factory = require( './../lib' );
29+
30+
31+
// VARIABLES //
32+
33+
var Float64ArrayFE = factory( 'float64' );
34+
35+
36+
// FUNCTIONS //
37+
38+
/**
39+
* Predicate function.
40+
*
41+
* @private
42+
* @param {boolean} value - array element
43+
* @param {NonNegativeInteger} idx - array element index
44+
* @param {TypedArray} arr - array instance
45+
* @returns {boolean} boolean indicating whether a value passes a test
46+
*/
47+
function predicate( value ) {
48+
return value >= 0;
49+
}
50+
51+
/**
52+
* Creates a benchmark function.
53+
*
54+
* @private
55+
* @param {PositiveInteger} len - array length
56+
* @returns {Function} benchmark function
57+
*/
58+
function createBenchmark( len ) {
59+
var arr = new Float64ArrayFE( 'little-endian', zeroTo( len ) );
60+
return benchmark;
61+
62+
/**
63+
* Benchmark function.
64+
*
65+
* @private
66+
* @param {Benchmark} b - benchmark instance
67+
*/
68+
function benchmark( b ) {
69+
var bool;
70+
var i;
71+
72+
b.tic();
73+
for ( i = 0; i < b.iterations; i++ ) {
74+
bool = arr.every( predicate );
75+
if ( typeof bool !== 'boolean' ) {
76+
b.fail( 'should return a boolean' );
77+
}
78+
}
79+
b.toc();
80+
if ( !isBoolean( bool ) ) {
81+
b.fail( 'should return a boolean' );
82+
}
83+
b.pass( 'benchmark finished' );
84+
b.end();
85+
}
86+
}
87+
88+
89+
// MAIN //
90+
91+
/**
92+
* Main execution sequence.
93+
*
94+
* @private
95+
*/
96+
function main() {
97+
var len;
98+
var min;
99+
var max;
100+
var f;
101+
var i;
102+
103+
min = 1; // 10^min
104+
max = 6; // 10^max
105+
106+
for ( i = min; i <= max; i++ ) {
107+
len = pow( 10, i );
108+
f = createBenchmark( len );
109+
bench( pkg+':every:len='+len, f );
110+
}
111+
}
112+
113+
main();

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -538,6 +538,37 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
538538
*/
539539
setReadOnly( TypedArray.prototype, 'BYTES_PER_ELEMENT', TypedArray.BYTES_PER_ELEMENT );
540540

541+
/**
542+
* Tests whether all elements in an array pass a test implemented by a predicate function.
543+
*
544+
* @name every
545+
* @memberof TypedArray.prototype
546+
* @type {Function}
547+
* @param {Function} predicate - predicate function
548+
* @param {*} [thisArg] - function invocation context
549+
* @throws {TypeError} `this` must be a typed array instance
550+
* @throws {TypeError} first argument must be a function
551+
* @returns {boolean} boolean indicating whether all elements pass a test
552+
*/
553+
setReadOnly( TypedArray.prototype, 'every', function every( predicate, thisArg ) {
554+
var buf;
555+
var i;
556+
557+
if ( !isTypedArray( this ) ) {
558+
throw new TypeError( format( 'invalid invocation. `this` is not %s %s.', CHAR2ARTICLE[ dtype[0] ], CTOR_NAME ) );
559+
}
560+
if ( !isFunction( predicate ) ) {
561+
throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', predicate ) );
562+
}
563+
buf = this._buffer;
564+
for ( i = 0; i < this._length; i++ ) {
565+
if ( !predicate.call( thisArg, buf[ GETTER ]( i * BYTES_PER_ELEMENT, this._isLE ), i, this ) ) {
566+
return false;
567+
}
568+
}
569+
return true;
570+
});
571+
541572
/**
542573
* Invokes a function once for each array element.
543574
*

0 commit comments

Comments
 (0)