Merge branch 'stdlib-js:develop' into dcusumpw-refactor

lib/node_modules/@stdlib/array/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

lib/node_modules/@stdlib/array/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 ];

lib/node_modules/@stdlib/array/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 ];

lib/node_modules/@stdlib/array/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
 */
 

lib/node_modules/@stdlib/array/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 );
 ```

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

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

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

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

lib/node_modules/@stdlib/array/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 ];

lib/node_modules/@stdlib/array/base/cuany-by/examples/index.js

@@ -19,13 +19,16 @@
 'use strict';
 
 var bernoulli = require( '@stdlib/random/array/bernoulli' );
-var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' );
 var cuanyBy = require( './../lib' );
 
+function isPositive( value ) {
+ return ( value > 0 );
+}
+
 // Create an array of random values:
 var x = bernoulli( 10, 0.1 );
 console.log( x );
 
-// Cumulatively determine whether values are truthy:
-var out = cuanyBy( x, isPositiveInteger );
+// Cumulatively determine whether at least one element is positive:
+var out = cuanyBy( x, isPositive );
 console.log( out );

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

@@ -78,13 +78,13 @@ function indexed( x, y, stride, offset, predicate, thisArg ) {
 * @returns {Collection} output array
 *
 * @example
+* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
+* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
+*
 * function isPositive( v ) {
 * return v > 0;
 * }
 *
-* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
-* var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
-*
 * var x = toAccessorArray( [ false, false, false, true, false ] );
 * var y = toAccessorArray( [ false, null, false, null, false, null, false, null, false, null ] );
 *
@@ -136,7 +136,7 @@ function accessors( x, y, stride, offset, predicate, thisArg ) {
 // MAIN //
 
 /**
-* Cumulatively tests whether at least one element in a provided array passes a test implemented by a predicate function and assigns results to provided output array.
+* 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.
 *
 * @param {Collection} x - input array
 * @param {Collection} y - output array