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]>

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

@@ -0,0 +1,145 @@
+<!--
+
+@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.
+
+-->
+
+# cueveryBy
+
+> Cumulatively test whether every array element in a provided array passes a test implemented by a predicate function.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var cueveryBy = require( '@stdlib/array/base/cuevery-by' );
+```
+
+#### cueveryBy( x, predicate\[, thisArg ] )
+
+Cumulatively tests whether every array element in a provided array passes a test implemented by a predicate function.
+
+```javascript
+function fcn( value) {
+ return ( value > 0 );
+}
+
+var x = [ 1, 1, 0, 0, 0 ];
+
+var y = cueveryBy( x, fcn );
+// returns [ true, true, false, false, false ]
+```
+
+The invoked `predicate` function is provided three arguments:
+
+- **value**: collection element.
+- **index**: collection index.
+- **collection**: input collection.
+
+To set the function execution context, provide a `thisArg`.
+
+```javascript
+function fcn( v ) {
+ this.count += 1;
+ return ( v > 0 );
+}
+
+var x = [ 1, 1, 0, 0, 0 ];
+
+var context = {
+ 'count': 0
+};
+
+var bool = cueveryBy( x, fcn, context );
+// returns [ true, true, false, false, false ]
+
+var count = context.count;
+// returns 3
+```
+
+#### cueveryBy.assign( x, out, stride, offset, predicate\[, thisArg ] )
+
+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.
+
+```javascript
+function fcn( v ) {
+ return ( v > 0 );
+}
+
+var x = [ 1, 1, 0, 0, 0 ];
+var y = [ false, null, false, null, false, null, false, null, false, null ];
+
+var out = cueveryBy.assign( x, y, 2, 0, fcn );
+// returns [ true, null, true, null, false, null, false, null, false, null ]
+
+var bool = ( out === y );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
+var cueveryBy = require( '@stdlib/array/base/cuevery-by' );
+
+function fcn( value ) {
+ return ( value > 0 );
+}
+
+// Create an array of random values:
+var x = bernoulli( 10, 0.8 );
+console.log( x );
+
+// Cumulatively tests whether every array element passes a test:
+var y = cueveryBy( x, fcn );
+console.log( y );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,99 @@
+/**
+* @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 isArray = require( '@stdlib/assert/is-array' );
+var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
+var filled = require( '@stdlib/array/base/filled' );
+var pkg = require( './../package.json' ).name;
+var cueveryBy = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+ var x = filled( 1.5, len );
+ return benchmark;
+
+ /**
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark( b ) {
+ var y;
+ var v;
+ var i;
+
+ y = filled( false, len );
+
+ b.tic();
+ for ( i = 0; i < b.iterations; i++ ) {
+ v = cueveryBy.assign( x, y, 1, 0, isPositiveInteger );
+ if ( typeof v !== 'object' ) {
+ b.fail( 'should return an array' );
+ }
+ }
+ b.toc();
+ if ( !isArray( v ) ) {
+ b.fail( 'should return an array' );
+ }
+ 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+':assign:len='+len, f );
+ }
+}
+
+main();

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

@@ -0,0 +1,53 @@
+/**
+* @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 isArray = require( '@stdlib/assert/is-array' );
+var zeroTo = require( '@stdlib/array/base/zero-to' );
+var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var cueveryBy = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+'::copy:len=100', function benchmark( b ) {
+ var x;
+ var i;
+ var v;
+
+ x = zeroTo( 100 );
+
+ b.tic();
+ for ( i = 0; i < b.iterations; i++ ) {
+ v = cueveryBy( x, isPositiveInteger );
+ if ( typeof v !== 'object' ) {
+ b.fail( 'should return an array' );
+ }
+ }
+ b.toc();
+ if ( !isArray( v ) ) {
+ b.fail( 'should return an array' );
+ }
+ b.pass( 'benchmark finished' );
+ b.end();
+});

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

@@ -0,0 +1,96 @@
+/**
+* @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 isArray = require( '@stdlib/assert/is-array' );
+var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' );
+var filled = require( '@stdlib/array/base/filled' );
+var pkg = require( './../package.json' ).name;
+var cueveryBy = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+ var x = filled( 1.5, len );
+ return benchmark;
+
+ /**
+ * Benchmark function.
+ *
+ * @private
+ * @param {Benchmark} b - benchmark instance
+ */
+ function benchmark( b ) {
+ var v;
+ var i;
+
+ b.tic();
+ for ( i = 0; i < b.iterations; i++ ) {
+ v = cueveryBy( x, isPositiveInteger );
+ if ( typeof v !== 'object' ) {
+ b.fail( 'should return an array' );
+ }
+ }
+ b.toc();
+ if ( !isArray( v ) ) {
+ b.fail( 'should return an array' );
+ }
+ 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+':len='+len, f );
+ }
+}
+
+main();