chore: minor clean-up

Author: Planeshifter

lib/node_modules/@stdlib/array/base/cunone-by-right/docs/types/index.d.ts

@@ -158,7 +158,7 @@ interface CunoneByRight {
 	* var x = [ 0, 0, 0, 1, 0 ];
 	* var y = [ false, null, false, null, false, null, false, null, false, null ];
 	*
-	* var arr = cunoneBy.cunoneByRight( x, y, 2, 0, isPositive );,
+	* var arr = cunoneBy.assign( x, y, 2, 0, isPositive );,
 	* // returns [ true, null, false, null, false, null, false, null, false, null ]
 	*/
 	assign<T = unknown, U = unknown, V = unknown>( x: Collection<T> | AccessorArrayLike<T>, out: Collection<U> | AccessorArrayLike<U>, stride: number, offset: number, predicate: Predicate<T, V>, thisArg?: ThisParameterType<Predicate<T, V>> ): Collection<U | boolean> | AccessorArrayLike<U | boolean>;

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

@@ -74,7 +74,7 @@ var count = context.count;
 
 #### cusomeByRight.assign( x, n, out, stride, offset, predicate\[, thisArg ] )
 
-Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left and assign the results to the elements in the output array.
+Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a `predicate` function, while iterating from right-to-left, and assigns the results to the elements in the output array.
 
 ```javascript
 function fcn( v ) {

lib/node_modules/@stdlib/array/base/cusome-by-right/docs/repl.txt

@@ -38,9 +38,9 @@
 
 
 {{alias}}.assign( x, n, out, stride, offset, predicate[, thisArg] )
-    Cumulatively test whether at least `n` elements in a provided array pass a
-    test implemented by a predicate function, while iterating from right-to-left
-    and assign the results to the provided output array.
+    Cumulatively tests whether at least `n` elements in a provided array pass a
+    test implemented by a predicate function, while iterating from
+    right-to-left, and assigns the results to the provided output array.
 
     The predicate function is provided three arguments:
 

lib/node_modules/@stdlib/array/base/cusome-by-right/docs/types/index.d.ts

@@ -71,7 +71,7 @@ type Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
 */
 interface CusomeByRight {
 	/**
-	* Cumulatively test whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left.
+	* Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left.
 	*
 	* @param x - input array
 	* @param n - number of elements
@@ -91,7 +91,7 @@ interface CusomeByRight {
 	<T = unknown, U = unknown>( x: Collection<T> | AccessorArrayLike<T>, n: number, predicate: Predicate<T, U>, thisArg?: ThisParameterType<Predicate<T, U>> ): Array<boolean>;
 
 	/**
-	* Cumulatively test whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left and assigns the results to the provided output array.
+	* Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left, and assigns the results to the provided output array.
 	*
 	* @param x - input array
 	* @param n - number of elements
@@ -115,7 +115,7 @@ interface CusomeByRight {
 	assign<T = unknown, U = unknown, V = unknown>( x: Collection<T> | AccessorArrayLike<T>, n: number, out: Array<U>, stride: number, offset: number, predicate: Predicate<T, V>, thisArg?: ThisParameterType<Predicate<T, V>> ): Array<U | boolean>;
 
 	/**
-	* Cumulatively test whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left and assigns the results to the provided output array.
+	* Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left, and assigns the results to the provided output array.
 	*
 	* @param x - input array
 	* @param n - number of elements
@@ -127,19 +127,24 @@ interface CusomeByRight {
 	* @returns output array
 	*
 	* @example
-	* function fcn( v ) {
-	*     return v > 0;
+	* var BooleanArray = require( '@stdlib/array/bool' );
+	*
+	* function isPositive( v ) {
+	*     return ( v > 0 );
 	* }
-	* var x = [ 1, 1, 0, 0, 0 ];
-	* var y = [ false, null, false, null, false, null, false, null, false, null ];
+	* var x = [ 0, 0, 0, 1, 0 ];
+	* var y = new BooleanArray( [ false, false, false, false, false, false, false, false, false, false ] );
 	*
-	* var arr = cusomeByRight.assign( x, 2, y, 2, 0, fcn );,
-	* // returns [ false, null, false, null, false, null, false, null, true, null ];
+	* var arr = cusomeByRight.assign( x, 2, y, 2, 0, isPositive );
+	* // returns <BooleanArray>
+	*
+	* var v = arr.get( 4 );
+	* // returns false
 	*/
 	assign<T, U extends TypedArray | BooleanArray, V = unknown>( x: Collection<T> | AccessorArrayLike<T>, n: number, out: U, stride: number, offset: number, predicate: Predicate<T, V>, thisArg?: ThisParameterType<Predicate<T, V>> ): U;
 
 	/**
-	* Cumulatively tests whether no array element in a provided array passes a test implemented by a predicate function, while iterating from right-to-left, and assigns the results to the provided output array.
+	* Cumulatively tests whether at least `n` elements in a provided array passes a test implemented by a predicate function, while iterating from right-to-left, and assigns the results to the provided output array.
 	*
 	* @param x - input array
 	* @param n - number of elements
@@ -151,14 +156,14 @@ interface CusomeByRight {
 	* @returns output array
 	*
 	* @example
-	* function isPositive( v ) {
-	*     return ( v > 0 );
+	* function fcn( v ) {
+	*     return v > 0;
 	* }
-	* var x = [ 0, 0, 0, 1, 0 ];
+	* var x = [ 1, 1, 0, 0, 0 ];
 	* var y = [ false, null, false, null, false, null, false, null, false, null ];
 	*
-	* var arr = cunoneBy.cunoneByRight( x, y, 2, 0, isPositive );,
-	* // returns [ true, null, false, null, false, null, false, null, false, null ]
+	* var arr = cusomeByRight.assign( x, 2, y, 2, 0, fcn );,
+	* // returns [ false, null, false, null, false, null, false, null, true, null ];
 	*/
 	assign<T = unknown, U = unknown, V = unknown>( x: Collection<T> | AccessorArrayLike<T>, n: number, out: Collection<U> | AccessorArrayLike<U>, stride: number, offset: number, predicate: Predicate<T, V>, thisArg?: ThisParameterType<Predicate<T, V>> ): Collection<U | boolean> | AccessorArrayLike<U | boolean>;
 }

lib/node_modules/@stdlib/array/base/cusome-by-right/docs/types/test.ts

@@ -169,7 +169,7 @@ const isPositive = ( v: number ): boolean => {
 	cusomeByRight.assign( x, 1, y, 1, [], isPositive ); // $ExpectError
 }
 
-// The compiler throws an error if the `assign` method is provided a fifth argument which is not a function...
+// The compiler throws an error if the `assign` method is provided a sixth argument which is not a function...
 {
 	const x = [ 1, 1, 0, 0, 0 ];
 	const y = [ false, null, false, null, false, null, false, null, false, null ];

lib/node_modules/@stdlib/array/base/cusome-by-right/lib/assign.js

@@ -26,7 +26,7 @@ var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
 // FUNCTIONS //
 
 /**
-* Cumulatively test whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left and assign the results to elements in the provided output array.
+* Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left, and assign the results to elements in the provided output array.
 *
 * @private
 * @param {Collection} x - input array
@@ -35,7 +35,7 @@ var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
 * @param {integer} stride - output array stride
 * @param {NonNegativeInteger} offset - output array offset
 * @param {Function} predicate - test function
-* @param {*} [thisArg] - execution context
+* @param {*} thisArg - execution context
 * @returns {Collection} output array
 *
 * @example
@@ -72,7 +72,7 @@ function indexed( x, n, out, stride, offset, predicate, thisArg ) {
 }
 
 /**
-* Cumulatively test whether at least `n` elements in a provided accessor array pass a test implemented by a predicate function, while iterating from right-to-left and assign the results to elements in the accessor output array.
+* Cumulatively tests whether at least `n` elements in a provided accessor array pass a test implemented by a predicate function, while iterating from right-to-left, and assigns the results to elements in the accessor output array.
 *
 * @private
 * @param {Object} x - input array object
@@ -81,7 +81,7 @@ function indexed( x, n, out, stride, offset, predicate, thisArg ) {
 * @param {integer} stride - output array stride
 * @param {NonNegativeInteger} offset - output array offset
 * @param {Function} predicate - test function
-* @param {*} [thisArg] - execution context
+* @param {*} thisArg - execution context
 * @returns {Collection} output array
 *
 * @example
@@ -137,7 +137,7 @@ function accessors( x, n, out, stride, offset, predicate, thisArg ) {
 // MAIN //
 
 /**
-* Cumulatively test whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left and assign the results to elements in the output array.
+* Cumulatively tests whether at least `n` elements in a provided array pass a test implemented by a predicate function, while iterating from right-to-left, and assigns the results to elements in the output array.
 *
 * @param {Collection} x - input array
 * @param {PositiveInteger} n - number of elements

lib/node_modules/@stdlib/array/base/cusome-by-right/test/test.assign.js

@@ -26,6 +26,13 @@ var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
 var cusomeByRight = require( './../lib/assign.js' );
 
 
+// FUNCTIONS //
+
+function isPositive( v ) {
+	return v > 0;
+}
+
+
 // TESTS //
 
 tape( 'main export is a function', function test( t ) {
@@ -40,14 +47,10 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	var x;
 	var y;
 
-	function fcn( v ) {
-		return v > 0;
-	}
-
 	x = [ 1, 1, 0, 0, 1 ];
 	y = [ false, true, false, true, false ];
 
-	actual = cusomeByRight( x, 2, y, 1, 0, fcn );
+	actual = cusomeByRight( x, 2, y, 1, 0, isPositive );
 	expected = [ false, false, false, true, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -56,7 +59,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	x = [ 1, 1, 0, 0 ];
 	y = [ false, null, false, null, false, null, false, null ];
 
-	actual = cusomeByRight( x, 2, y, 2, 0, fcn );
+	actual = cusomeByRight( x, 2, y, 2, 0, isPositive );
 	expected = [ false, null, false, null, false, null, true, null ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -65,7 +68,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	x = [ 0, 0, 1, 0, 1 ];
 	y = [ false, false, false, true, true, true ];
 
-	actual = cusomeByRight( x, 2, y, 1, 1, fcn );
+	actual = cusomeByRight( x, 2, y, 1, 1, isPositive );
 	expected = [ false, false, false, true, true, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -74,7 +77,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	x = [];
 	y = [ false, false, false, false, false ];
 
-	actual = cusomeByRight( x, 1, y, 1, 0, fcn );
+	actual = cusomeByRight( x, 1, y, 1, 0, isPositive );
 	expected = [ false, false, false, false, false ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -83,7 +86,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	x = [ 1 ];
 	y = [ false, false ];
 
-	actual = cusomeByRight( x, 1, y, 1, 1, fcn );
+	actual = cusomeByRight( x, 1, y, 1, 1, isPositive );
 	expected = [ false, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -98,14 +101,10 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	var x;
 	var y;
 
-	function fcn( v ) {
-		return v > 0;
-	}
-
 	x = new Float64Array( [ 1.0, 0.0, 1.0, 0.0, 1.0 ] );
 	y = [ false, true, false, true, false ];
 
-	actual = cusomeByRight( x, 2, y, 1, 0, fcn );
+	actual = cusomeByRight( x, 2, y, 1, 0, isPositive );
 	expected = [ false, false, true, true, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -114,7 +113,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	x = new Float64Array( [ 1.0, 1.0, 0.0, 0.0 ] );
 	y = [ false, null, false, null, false, null, false, null ];
 
-	actual = cusomeByRight( x, 2, y, 2, 0, fcn );
+	actual = cusomeByRight( x, 2, y, 2, 0, isPositive );
 	expected = [ false, null, false, null, false, null, true, null ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -123,7 +122,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	x = new Float64Array( [ 0.0, 1.0, 1.0, 0.0, 0.0 ] );
 	y = [ true, false, false, true, true, true ];
 
-	actual = cusomeByRight( x, 2, y, 1, 1, fcn );
+	actual = cusomeByRight( x, 2, y, 1, 1, isPositive );
 	expected = [ true, false, false, false, true, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -132,7 +131,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	x = new Float64Array( [] );
 	y = [ false, false, false, false, false ];
 
-	actual = cusomeByRight( x, 1, y, 1, 0, fcn );
+	actual = cusomeByRight( x, 1, y, 1, 0, isPositive );
 	expected = [ false, false, false, false, false ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -141,7 +140,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	x = new Float64Array( [ 1.0 ] );
 	y = [ false, false ];
 
-	actual = cusomeByRight( x, 1, y, 1, 1, fcn );
+	actual = cusomeByRight( x, 1, y, 1, 1, isPositive );
 	expected = [ false, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -157,14 +156,11 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	var x;
 	var y;
 
-	function fcn( v ) {
-		return v > 0;
-	}
 	x = toAccessorArray( [ 1, 0, 0, 0, 1 ] );
 	ybuf = [ false, true, false, true, false ];
 	y = toAccessorArray( ybuf );
 
-	actual = cusomeByRight( x, 2, y, 1, 0, fcn );
+	actual = cusomeByRight( x, 2, y, 1, 0, isPositive );
 	expected = [ false, false, false, false, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -174,7 +170,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	ybuf = [ false, null, false, null, false, null, false, null ];
 	y = toAccessorArray( ybuf );
 
-	actual = cusomeByRight( x, 2, y, 2, 0, fcn );
+	actual = cusomeByRight( x, 2, y, 2, 0, isPositive );
 	expected = [ false, null, false, null, true, null, true, null ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -184,7 +180,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	ybuf = [ true, false, false, false, false, false ];
 	y = toAccessorArray( ybuf );
 
-	actual = cusomeByRight( x, 2, y, 1, 1, fcn );
+	actual = cusomeByRight( x, 2, y, 1, 1, isPositive );
 	expected = [ true, false, false, false, true, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -194,7 +190,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	ybuf = [ false, false, false, false, false ];
 	y = toAccessorArray( ybuf );
 
-	actual = cusomeByRight( x, 1, y, 1, 0, fcn );
+	actual = cusomeByRight( x, 1, y, 1, 0, isPositive );
 	expected = [ true, true, true, true, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -204,7 +200,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	ybuf = [ false, false, false, false, false ];
 	y = toAccessorArray( ybuf );
 
-	actual = cusomeByRight( x, 1, y, 1, 0, fcn );
+	actual = cusomeByRight( x, 1, y, 1, 0, isPositive );
 	expected = [ false, false, false, false, false ];
 
 	t.strictEqual( actual, y, 'returns expected value' );
@@ -214,7 +210,7 @@ tape( 'the function cumulatively tests whether at least n elements in a provided
 	ybuf = [ false, false ];
 	y = toAccessorArray( ybuf );
 
-	actual = cusomeByRight( x, 0, y, 1, 1, fcn );
+	actual = cusomeByRight( x, 0, y, 1, 1, isPositive );
 	expected = [ false, true ];
 
 	t.strictEqual( actual, y, 'returns expected value' );