Skip to content

Commit e3078e5

Browse files
Kaif987Planeshifter
Kaif987
and
Planeshifter
authored
feat: add array/base/cuevery-by package
PR-URL: #2831 Closes: #2324 --------- Signed-off-by: Mohammad Kaif <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 2091d38 commit e3078e5

File tree

15 files changed

+1727
-0
lines changed

15 files changed

+1727
-0
lines changed

‎lib/node_modules/@stdlib/array/base/cuevery-by/README.md

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# cueveryBy
22+
23+
> Cumulatively test whether every array element in a provided array passes a test implemented by a predicate function.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var cueveryBy = require( '@stdlib/array/base/cuevery-by' );
31+
```
32+
33+
#### cueveryBy( x, predicate\[, thisArg ] )
34+
35+
Cumulatively tests whether every array element in a provided array passes a test implemented by a predicate function.
36+
37+
```javascript
38+
function fcn( value) {
39+
return ( value > 0 );
40+
}
41+
42+
var x = [ 1, 1, 0, 0, 0 ];
43+
44+
var y = cueveryBy( x, fcn );
45+
// returns [ true, true, false, false, false ]
46+
```
47+
48+
The invoked `predicate` function is provided three arguments:
49+
50+
- **value**: collection element.
51+
- **index**: collection index.
52+
- **collection**: input collection.
53+
54+
To set the function execution context, provide a `thisArg`.
55+
56+
```javascript
57+
function fcn( v ) {
58+
this.count += 1;
59+
return ( v > 0 );
60+
}
61+
62+
var x = [ 1, 1, 0, 0, 0 ];
63+
64+
var context = {
65+
'count': 0
66+
};
67+
68+
var bool = cueveryBy( x, fcn, context );
69+
// returns [ true, true, false, false, false ]
70+
71+
var count = context.count;
72+
// returns 3
73+
```
74+
75+
#### cueveryBy.assign( x, out, stride, offset, predicate\[, thisArg ] )
76+
77+
Cumulatively tests whether every array element in a provided array passes a test implemented by a predicate function and assigns the results to a provided output array.
78+
79+
```javascript
80+
function fcn( v ) {
81+
return ( v > 0 );
82+
}
83+
84+
var x = [ 1, 1, 0, 0, 0 ];
85+
var y = [ false, null, false, null, false, null, false, null, false, null ];
86+
87+
var out = cueveryBy.assign( x, y, 2, 0, fcn );
88+
// returns [ true, null, true, null, false, null, false, null, false, null ]
89+
90+
var bool = ( out === y );
91+
// returns true
92+
```
93+
94+
</section>
95+
96+
<!-- /.usage -->
97+
98+
<section class="notes">
99+
100+
</section>
101+
102+
<!-- /.notes -->
103+
104+
<section class="examples">
105+
106+
## Examples
107+
108+
<!-- eslint no-undef: "error" -->
109+
110+
```javascript
111+
var bernoulli = require( '@stdlib/random/array/bernoulli' );
112+
var cueveryBy = require( '@stdlib/array/base/cuevery-by' );
113+
114+
function fcn( value ) {
115+
return ( value > 0 );
116+
}
117+
118+
// Create an array of random values:
119+
var x = bernoulli( 10, 0.8 );
120+
console.log( x );
121+
122+
// Cumulatively tests whether every array element passes a test:
123+
var y = cueveryBy( x, fcn );
124+
console.log( y );
125+
```
126+
127+
</section>
128+
129+
<!-- /.examples -->
130+
131+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
132+
133+
<section class="related">
134+
135+
</section>
136+
137+
<!-- /.related -->
138+
139+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
140+
141+
<section class="links">
142+
143+
</section>
144+
145+
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/cuevery-by/benchmark/benchmark.assign.length.js

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
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 isArray = require( '@stdlib/assert/is-array' );
26+
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
27+
var filled = require( '@stdlib/array/base/filled' );
28+
var pkg = require( './../package.json' ).name;
29+
var cueveryBy = require( './../lib' );
30+
31+
32+
// FUNCTIONS //
33+
34+
/**
35+
* Creates a benchmark function.
36+
*
37+
* @private
38+
* @param {PositiveInteger} len - array length
39+
* @returns {Function} benchmark function
40+
*/
41+
function createBenchmark( len ) {
42+
var x = filled( 1.5, len );
43+
return benchmark;
44+
45+
/**
46+
* Benchmark function.
47+
*
48+
* @private
49+
* @param {Benchmark} b - benchmark instance
50+
*/
51+
function benchmark( b ) {
52+
var y;
53+
var v;
54+
var i;
55+
56+
y = filled( false, len );
57+
58+
b.tic();
59+
for ( i = 0; i < b.iterations; i++ ) {
60+
v = cueveryBy.assign( x, y, 1, 0, isPositiveInteger );
61+
if ( typeof v !== 'object' ) {
62+
b.fail( 'should return an array' );
63+
}
64+
}
65+
b.toc();
66+
if ( !isArray( v ) ) {
67+
b.fail( 'should return an array' );
68+
}
69+
b.pass( 'benchmark finished' );
70+
b.end();
71+
}
72+
}
73+
74+
75+
// MAIN //
76+
77+
/**
78+
* Main execution sequence.
79+
*
80+
* @private
81+
*/
82+
function main() {
83+
var len;
84+
var min;
85+
var max;
86+
var f;
87+
var i;
88+
89+
min = 1; // 10^min
90+
max = 6; // 10^max
91+
92+
for ( i = min; i <= max; i++ ) {
93+
len = pow( 10, i );
94+
f = createBenchmark( len );
95+
bench( pkg+':assign:len='+len, f );
96+
}
97+
}
98+
99+
main();

‎lib/node_modules/@stdlib/array/base/cuevery-by/benchmark/benchmark.js

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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 isArray = require( '@stdlib/assert/is-array' );
25+
var zeroTo = require( '@stdlib/array/base/zero-to' );
26+
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
27+
var pkg = require( './../package.json' ).name;
28+
var cueveryBy = require( './../lib' );
29+
30+
31+
// MAIN //
32+
33+
bench( pkg+'::copy:len=100', function benchmark( b ) {
34+
var x;
35+
var i;
36+
var v;
37+
38+
x = zeroTo( 100 );
39+
40+
b.tic();
41+
for ( i = 0; i < b.iterations; i++ ) {
42+
v = cueveryBy( x, isPositiveInteger );
43+
if ( typeof v !== 'object' ) {
44+
b.fail( 'should return an array' );
45+
}
46+
}
47+
b.toc();
48+
if ( !isArray( v ) ) {
49+
b.fail( 'should return an array' );
50+
}
51+
b.pass( 'benchmark finished' );
52+
b.end();
53+
});

‎lib/node_modules/@stdlib/array/base/cuevery-by/benchmark/benchmark.length.js

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
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 isArray = require( '@stdlib/assert/is-array' );
26+
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' );
27+
var filled = require( '@stdlib/array/base/filled' );
28+
var pkg = require( './../package.json' ).name;
29+
var cueveryBy = require( './../lib' );
30+
31+
32+
// FUNCTIONS //
33+
34+
/**
35+
* Creates a benchmark function.
36+
*
37+
* @private
38+
* @param {PositiveInteger} len - array length
39+
* @returns {Function} benchmark function
40+
*/
41+
function createBenchmark( len ) {
42+
var x = filled( 1.5, len );
43+
return benchmark;
44+
45+
/**
46+
* Benchmark function.
47+
*
48+
* @private
49+
* @param {Benchmark} b - benchmark instance
50+
*/
51+
function benchmark( b ) {
52+
var v;
53+
var i;
54+
55+
b.tic();
56+
for ( i = 0; i < b.iterations; i++ ) {
57+
v = cueveryBy( x, isPositiveInteger );
58+
if ( typeof v !== 'object' ) {
59+
b.fail( 'should return an array' );
60+
}
61+
}
62+
b.toc();
63+
if ( !isArray( v ) ) {
64+
b.fail( 'should return an array' );
65+
}
66+
b.pass( 'benchmark finished' );
67+
b.end();
68+
}
69+
}
70+
71+
72+
// MAIN //
73+
74+
/**
75+
* Main execution sequence.
76+
*
77+
* @private
78+
*/
79+
function main() {
80+
var len;
81+
var min;
82+
var max;
83+
var f;
84+
var i;
85+
86+
min = 1; // 10^min
87+
max = 6; // 10^max
88+
89+
for ( i = min; i <= max; i++ ) {
90+
len = pow( 10, i );
91+
f = createBenchmark( len );
92+
bench( pkg+':len='+len, f );
93+
}
94+
}
95+
96+
main();

0 commit comments

Comments
 (0)