Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-09-28)
+## Unreleased (2024-09-29)
 
 <section class="packages">
 
@@ -291,6 +291,40 @@ This release closes the following issue:
 
 <!-- /.package -->
 
+<section class="package" id="array-base-cusome-by-unreleased">
+
+#### [@stdlib/array/base/cusome-by](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cusome-by)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`9835dae`](https://github.com/stdlib-js/stdlib/commit/9835dae5a4dba0aae50d8582b97ad69d17fefe6d) - add `array/base/cusome-by` [(#2953)](https://github.com/stdlib-js/stdlib/pull/2953)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+##### Closed Issues
+
+This release closes the following issue:
+
+[#2326](https://github.com/stdlib-js/stdlib/issues/2326)
+
+</section>
+
+<!-- /.issues -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 <section class="package" id="array-base-cusome-by-right-unreleased">
 
 #### [@stdlib/array/base/cusome-by-right](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/cusome-by-right)
@@ -617,9 +651,9 @@ This release closes the following issue:
 
 ### Closed Issues
 
-This release closes the following issue:
+A total of 2 issues were closed in this release:
 
-[#2327](https://github.com/stdlib-js/stdlib/issues/2327)
+[#2326](https://github.com/stdlib-js/stdlib/issues/2326), [#2327](https://github.com/stdlib-js/stdlib/issues/2327)
 
 </section>
 
@@ -629,8 +663,9 @@ This release closes the following issue:
 
 ### Contributors
 
-A total of 7 people contributed to this release. Thank you to the following contributors:
+A total of 8 people contributed to this release. Thank you to the following contributors:
 
+-   Aditya Sapra
 -   Athan Reines
 -   Debashis Maharana
 -   HarshaNP
@@ -649,6 +684,7 @@ A total of 7 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`9835dae`](https://github.com/stdlib-js/stdlib/commit/9835dae5a4dba0aae50d8582b97ad69d17fefe6d) - **feat:** add `array/base/cusome-by` [(#2953)](https://github.com/stdlib-js/stdlib/pull/2953) _(by Aditya Sapra, Philipp Burckhardt)_
 -   [`abf0407`](https://github.com/stdlib-js/stdlib/commit/abf040787f6598438b0100a729a8331b7f80f62f) - **chore:** resolve lint errors in TS files _(by Philipp Burckhardt)_
 -   [`7f368f6`](https://github.com/stdlib-js/stdlib/commit/7f368f6c3f4cea444a304a62616cea36a5f143eb) - **fix:** remove unused imports from TS declaration file _(by Philipp Burckhardt)_
 -   [`975147f`](https://github.com/stdlib-js/stdlib/commit/975147f3125c786ec1672acb3d2564ca16eaa790) - **docs:** fix TSDoc lint errors _(by Philipp Burckhardt)_

base/cusome-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.
+
+-->
+
+# cusomeBy
+
+> Cumulatively test whether at least `n` array elements in a provided array pass a test implemented by a predicate function.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var cusomeBy = require( '@stdlib/array/base/cusome-by' );
+```
+
+#### cusomeBy( x, n, predicate\[, thisArg ] )
+
+Cumulatively tests whether at least `n` array elements in a provided array pass a test implemented by a predicate function.
+
+```javascript
+function fcn( value) {
+    return ( value > 0 );
+}
+
+var x = [ 0, 0, 0, 1, 1 ];
+
+var y = cusomeBy( x, 2, fcn );
+// returns [ false, false, false , false, true ]
+```
+
+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 = [ 0, 0, 0, 1, 1 ];
+
+var context = {
+    'count': 0
+};
+
+var bool = cusomeBy( x, 1, fcn, context );
+// returns [ false, false, false, true, true ]
+
+var count = context.count;
+// returns 4
+```
+
+#### cusomeBy.assign( x, n, out, stride, offset, predicate\[, thisArg ] )
+
+Cumulatively tests whether at least `n` array elements in a provided array pass 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 = [ 0, 0, 0, 1, 1 ];
+var y = [ false, null, false, null, false, null, false, null, false, null ];
+
+var out = cusomeBy.assign( x, 2, y, 2, 0, fcn );
+// returns [ false, null, false, null, false, null, false, null, true, 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 cusomeBy = require( '@stdlib/array/base/cusome-by' );
+
+function fcn( value ) {
+    return ( value > 0 );
+}
+
+// Create an array of random values:
+var x = bernoulli( 10, 0.8 );
+console.log( x );
+
+// Cumulatively test whether at least three array elements are positive:
+var y = cusomeBy( x, 3, 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 -->

base/cusome-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( './../../../base/filled' );
+var pkg = require( './../package.json' ).name;
+var cusomeBy = 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 = cusomeBy.assign( x, 2, 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();

base/cusome-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( './../../../base/zero-to' );
+var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var cusomeBy = 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 = cusomeBy( x, 50, 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();
+});