Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-09-29)
+## Unreleased (2024-10-03)
 
 <section class="packages">
 
@@ -718,6 +718,8 @@ A total of 8 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`ca2fbd0`](https://github.com/stdlib-js/stdlib/commit/ca2fbd0beec71a0f41307b19939b2c8dd27c76a9) - **chore:** minor clean-up _(by Philipp Burckhardt)_
+-   [`89e005a`](https://github.com/stdlib-js/stdlib/commit/89e005ad5004d32271fe7266e95eb96187c1946a) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`2c4e5d8`](https://github.com/stdlib-js/stdlib/commit/2c4e5d824e0c5dc8fd536bf79ff565cee100ce46) - **build:** disable additional lint rule in TS tests _(by Philipp Burckhardt)_
 -   [`aad48ea`](https://github.com/stdlib-js/stdlib/commit/aad48eab1f19217854f4ffbfaed2a8be664b0f47) - **chore:** resolve lint errors _(by Philipp Burckhardt)_
 -   [`5a50038`](https://github.com/stdlib-js/stdlib/commit/5a50038db6a457856adc51d5e6e3fd7161f45085) - **feat:** add `array/base/cuevery-by-right` [(#2802)](https://github.com/stdlib-js/stdlib/pull/2802) _(by HarshaNP, Philipp Burckhardt)_

CONTRIBUTORS

@@ -2,7 +2,7 @@
 #
 # Contributors listed in alphabetical order.
 
-Aayush Khanna <[email protected].com>
+Aayush Khanna <aayushiitbhu23@gmail.com>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
 AgPriyanshu18 <[email protected]>

base/cuany-by-right/docs/repl.txt

@@ -1,3 +1,4 @@
+
 {{alias}}( x, predicate[, thisArg] )
     Cumulatively tests whether at least one array element in a provided array
     passes a test implemented by a predicate function, while iterating from
@@ -27,9 +28,9 @@
 
     Examples
     --------
-    > function isPositive( v ) { return ( v > 0 ); };
+    > function predicate( v ) { return ( v > 0 ); };
     > var x = [ 1, 1, 0, 0, 0 ];
-    > var y = {{alias}}( x, isPositive )
+    > var y = {{alias}}( x, predicate )
     [ false, false, false, true, true ]
 
 
@@ -71,10 +72,10 @@
 
     Examples
     --------
-    > function isPositive( v ) { return ( v > 0 ); };
     > var x = [ 1, 1, 0, 0 ];
     > var out = [ false, null, false, null, false, null, false, null ];
-    > var arr = {{alias}}.assign( x, out, 2, 0, isPositive )
+    > function predicate( v ) { return ( v > 0 ); };
+    > var arr = {{alias}}.assign( x, out, 2, 0, predicate )
     [ false, null, ..., true, null ]
     > var bool = ( arr === out )
     true

base/cuany-by-right/docs/types/index.d.ts

@@ -100,7 +100,7 @@ interface CuanyByRight {
 	*
 	* @example
 	* function isPositive( v ) {
-	* 	return v > 0;
+	*     return v > 0;
 	* }
 	* var x = [ 1, 1, 0, 0, 0 ];
 	* var y = [ false, null, false, null, false, null, false, null, false, null ];
@@ -172,7 +172,7 @@ interface CuanyByRight {
 *
 * @example
 * function isPositive( v ) {
-* 	return v > 0;
+*     return v > 0;
 * }
 * var x = [ 1, 1, 0, 0, 0 ];
 *
@@ -181,7 +181,7 @@ interface CuanyByRight {
 *
 * @example
 * function isPositive( v ) {
-* 	return v > 0;
+*     return v > 0;
 * }
 * var x = [ 0, 1, 1, 0, 0 ];
 * var y = [ false, null, false, null, false, null, false, null, false, null ];

base/cuany-by-right/docs/types/test.ts

@@ -16,7 +16,6 @@
 * limitations under the License.
 */
 
-
 import cuanyByRight = require( './index' );
 
 /**
@@ -57,7 +56,24 @@ function isPositive( value: number ): boolean {
 	cuanyByRight( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType boolean[]
 }
 
-// The compiler throws an error if the function is provided a first argument which is not like a function..
+// The compiler throws an error if the function is provided a first argument which is not an array-like object...
+{
+	cuanyByRight( 1, isPositive ); // $ExpectError
+	cuanyByRight( true, isPositive ); // $ExpectError
+	cuanyByRight( false, isPositive ); // $ExpectError
+	cuanyByRight( null, isPositive ); // $ExpectError
+	cuanyByRight( void 0, isPositive ); // $ExpectError
+	cuanyByRight( {}, isPositive ); // $ExpectError
+
+	cuanyByRight( 1, isPositive, {} ); // $ExpectError
+	cuanyByRight( true, isPositive, {} ); // $ExpectError
+	cuanyByRight( false, isPositive, {} ); // $ExpectError
+	cuanyByRight( null, isPositive, {} ); // $ExpectError
+	cuanyByRight( void 0, isPositive, {} ); // $ExpectError
+	cuanyByRight( {}, isPositive, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not function...
 {
 	const x = [ 1, 2, 3, 4 ];
 
@@ -87,7 +103,7 @@ function isPositive( value: number ): boolean {
 	const y = [ false, null, false, null, false, null, false, null, false, null ];
 
 	cuanyByRight.assign( x, y, 2, 0, isPositive  ); // $ExpectType (boolean | null)[]
-	cuanyByRight.assign( x, y, 2, 0, isPositive, {}  ); // $ExpectType (boolean | null)[]
+	cuanyByRight.assign( x, y, 2, 0, isPositive, {} ); // $ExpectType (boolean | null)[]
 	cuanyByRight.assign( x, new Float64Array( 4 ), 1, 0, isPositive ); // $ExpectType Float64Array
 	cuanyByRight.assign( x, new Float32Array( 4 ), 1, 0, isPositive ); // $ExpectType Float32Array
 	cuanyByRight.assign( x, new Int32Array( 4 ), 1, 0, isPositive ); // $ExpectType Int32Array
@@ -148,7 +164,6 @@ function isPositive( value: number ): boolean {
 	cuanyByRight.assign( x, {}, 2, 0, isPositive, {} ); // $ExpectError
 }
 
-
 // The compiler throws an error if the `assign` method is provided a third argument which is not a number...
 {
 	const x = [ false, false, true, false, false ];
@@ -193,7 +208,7 @@ function isPositive( value: number ): boolean {
 	cuanyByRight.assign( x, y, 1, [], isPositive, {} ); // $ExpectError
 }
 
-// The compiler throws an error if the `assign` method is provided a fourth argument which is not like a function...
+// The compiler throws an error if the `assign` method is provided a fifth argument which is not like a function...
 {
 	const x = [ false, false, true, false, false ];
 	const y = [ false, null, false, null, false, null, false, null, false, null ];

base/cuany-by-right/lib/index.js

@@ -44,14 +44,11 @@
 *
 * var x = [ 0, 1, 0, 0, 0 ];
 *
-* var y1 = cuanyByRight( x, isPositive );
-* // returns [ false, false, false, true, true ]
-*
-* var y2 = [ false, null, false, null, false, null, false, null, false, null ];
-* var out = cuanyByRight.assign( x, y2, 2, 0, isPositive );
+* var y = [ false, null, false, null, false, null, false, null, false, null ];
+* var out = cuanyByRight.assign( x, y, 2, 0, isPositive );
 * // returns [ false, null, false, null, false, null, true, null, true, null ]
 *
-* var bool = ( out === y2 );
+* var bool = ( out === y );
 * // returns true
 */
 

base/cuany-by/README.md

@@ -127,6 +127,7 @@ function isPositive( value ) {
 var x = bernoulli( 10, 0.1 );
 console.log( x );
 
+// Cumulatively determine whether at least one element is positive:
 var out = cuanyBy( x, isPositive );
 console.log( out );
 ```

base/cuany-by/benchmark/benchmark.length.js

@@ -26,7 +26,7 @@ var isArray = require( '@stdlib/assert/is-array' );
 var filled = require( './../../../base/filled' );
 var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
 var pkg = require( './../../../base/cuany-by/package.json' ).name;
-var cuanyBy = require( './../../../base/cuany-by/lib' );
+var cuanyBy = require( './../lib' );
 
 
 // FUNCTIONS //
@@ -39,7 +39,7 @@ var cuanyBy = require( './../../../base/cuany-by/lib' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x = filled( 1.5, len );
+	var x = filled( 0, len );
 	return benchmark;
 
 	/**

base/cuany-by/docs/repl.txt

@@ -55,6 +55,9 @@
     predicate: Function
         Predicate function.
 
+    thisArg: any (optional)
+        Execution context.
+
     Returns
     -------
     y: ArrayLikeObject

base/cuany-by/docs/types/test.ts

@@ -56,7 +56,24 @@ function isPositive( value: number ): boolean {
 	cuanyBy( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType boolean[]
 }
 
-// The compiler throws an error if the function is provided a first argument which is not like a function..
+// The compiler throws an error if the function is provided a first argument which is not an array-like object...
+{
+	cuanyBy( 1, isPositive ); // $ExpectError
+	cuanyBy( true, isPositive ); // $ExpectError
+	cuanyBy( false, isPositive ); // $ExpectError
+	cuanyBy( null, isPositive ); // $ExpectError
+	cuanyBy( void 0, isPositive ); // $ExpectError
+	cuanyBy( {}, isPositive ); // $ExpectError
+
+	cuanyBy( 1, isPositive, {} ); // $ExpectError
+	cuanyBy( true, isPositive, {} ); // $ExpectError
+	cuanyBy( false, isPositive, {} ); // $ExpectError
+	cuanyBy( null, isPositive, {} ); // $ExpectError
+	cuanyBy( void 0, isPositive, {} ); // $ExpectError
+	cuanyBy( {}, isPositive, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not function...
 {
 	const x = [ 1, 2, 3, 4 ];
 
@@ -147,7 +164,6 @@ function isPositive( value: number ): boolean {
 	cuanyBy.assign( x, {}, 2, 0, isPositive, {} ); // $ExpectError
 }
 
-
 // The compiler throws an error if the `assign` method is provided a third argument which is not a number...
 {
 	const x = [ false, false, true, false, false ];
@@ -192,7 +208,7 @@ function isPositive( value: number ): boolean {
 	cuanyBy.assign( x, y, 1, [], isPositive, {} ); // $ExpectError
 }
 
-// The compiler throws an error if the `assign` method is provided a fourth argument which is not like a function...
+// The compiler throws an error if the `assign` method is provided a fifth argument which is not like a function...
 {
 	const x = [ false, false, true, false, false ];
 	const y = [ false, null, false, null, false, null, false, null, false, null ];