feat: add array/base/cuany-by

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

@@ -0,0 +1,154 @@
+<!--
+
+@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.
+
+-->
+
+# cuanyBy
+
+> Cumulatively test whether at least one element in a provided array passes a test implemented by a predicate function.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var cuanyBy = require( '@stdlib/array/base/cuany-by' );
+```
+
+#### cuanyBy( x, predicate\[, thisArg] )
+
+Cumulatively tests whether at least one element in a provided array passes a test implemented by a `predicate` function.
+
+```javascript
+function isPositive( value ) {
+    return ( value > 0 );
+}
+
+var x = [ 0, 0, 0, 1, 0 ];
+
+var y = cuanyBy( x, isPositive );
+// returns [ false, false, false, true, true ]
+```
+
+#### cuanyBy.assign( x, out, stride, offset, predicate\[, thisArg] )
+
+Cumulatively tests whether at least one element in a provided array passes a test implemented by a `predicate` function and assigns results to a provided output array.
+
+```javascript
+function isPositive( value ) {
+    return ( value > 0 );
+}
+
+var x = [ 0, 0, 0, 1, 0 ];
+var y = [ false, null, false, null, false, null, false, null, false, null ];
+
+var out = cuanyBy.assign( x, y, 2, 0, isPositive );
+// returns [ false, null, false, null, false, null, true, null, true, null ]
+
+var bool = ( out === y );
+// returns true
+```
+
+The function supports the following parameters:
+
+-   **x**: input array.
+-   **out**: output array.
+-   **stride**: output array stride.
+-   **offset**: output array offset.
+-   **predicate**: test function.
+
+The `predicate` function is provided three arguments:
+
+-   **value**: current array element.
+-   **index**: current array element index.
+-   **arr**: input array.
+
+To set the `predicate` function execution context, provide a `thisArg`.
+
+```javascript
+function isPositive( value ) {
+    this.count += 1;
+    return ( value > 0 );
+}
+
+var x = [ 0, 0, 0, 1, 0 ];
+
+var context = {
+    'count': 0
+};
+
+var out = cuanyBy( x, isPositive, context );
+// returns [ false, false, false, true, true ]
+
+var cnt = context.count;
+// returns 4
+
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+function isPositive( value ) {
+    return ( value > 0 );
+}
+
+var bernoulli = require( '@stdlib/random/array/bernoulli' );
+var cuanyBy = require( '@stdlib/array/base/cuany-by' );
+
+// Create an array of random values:
+var x = bernoulli( 10, 0.1 );
+console.log( x );
+
+var out = cuanyBy( x, isPositive);
+console.log( out );
+```
+
+</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/cuany-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 filled = require( '@stdlib/array/base/filled' );
+var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' );
+var pkg = require( './../package.json' ).name;
+var cuanyBy = 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 = cuanyBy.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/cuany-by/benchmark/benchmark.js

@@ -0,0 +1,52 @@
+/**
+* @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 isPositiveInteger = require( '@stdlib/assert/is-positive-integer' );
+var pkg = require( './../package.json' ).name;
+var cuanyBy = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var x;
+	var i;
+	var v;
+
+	x = [ false, false, true, false, false ];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = cuanyBy( 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();
+});