Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -128,6 +128,8 @@
 
 ### Bug Fixes
 
+-   [`d3426a4`](https://github.com/stdlib-js/stdlib/commit/d3426a41ee92d8024bf7fc03d200aa98fb62a6f0) - use correct dimensions for array
+-   [`aa59ef8`](https://github.com/stdlib-js/stdlib/commit/aa59ef8461be08dc612cf4826bb020915d362239) - pass in correct number of arguments
 -   [`179f005`](https://github.com/stdlib-js/stdlib/commit/179f005163d265ff38f7571465c2514f8ccb22cf) - use correct variable name
 -   [`4252199`](https://github.com/stdlib-js/stdlib/commit/42521999bf5751baf748fb1e9528c9c4b31a9116) - ensure byte offset is a multiple of data type byte length
 -   [`c54d1e0`](https://github.com/stdlib-js/stdlib/commit/c54d1e095143ad68529927fe76e8ddc435592a19) - revert iterator type change
@@ -214,6 +216,13 @@ A total of 32 issues were closed in this release:
 
 <details>
 
+-   [`b128b6a`](https://github.com/stdlib-js/stdlib/commit/b128b6a25775d9b319c83a9dbb521d8d9c45b8c2) - **chore:** fix ExpectType by supplying correct number of generic parameters _(by Philipp Burckhardt)_
+-   [`4ec1d6d`](https://github.com/stdlib-js/stdlib/commit/4ec1d6d67d746b2231ae18bfaaeb2ee5a9f40697) - **docs:** minor clean-up _(by Philipp Burckhardt)_
+-   [`d3426a4`](https://github.com/stdlib-js/stdlib/commit/d3426a41ee92d8024bf7fc03d200aa98fb62a6f0) - **fix:** use correct dimensions for array _(by Philipp Burckhardt)_
+-   [`27d6b62`](https://github.com/stdlib-js/stdlib/commit/27d6b6263dca9fe45e1977103f142226d09a08be) - **docs:** minor clean-up _(by Philipp Burckhardt)_
+-   [`2773163`](https://github.com/stdlib-js/stdlib/commit/2773163cd9baa364dcfe3c070afcc00bf4e98c27) - **chore:** update initial value and clean-up _(by Philipp Burckhardt)_
+-   [`aa59ef8`](https://github.com/stdlib-js/stdlib/commit/aa59ef8461be08dc612cf4826bb020915d362239) - **fix:** pass in correct number of arguments _(by Philipp Burckhardt)_
+-   [`28a6474`](https://github.com/stdlib-js/stdlib/commit/28a64749d12c05ecd840af6f5a4e14a343c6efc0) - **docs:** fix example code _(by Philipp Burckhardt)_
 -   [`f925c9c`](https://github.com/stdlib-js/stdlib/commit/f925c9cacd01012cc8a8f74eb3f45cbe69a4bbb0) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`21bfa5b`](https://github.com/stdlib-js/stdlib/commit/21bfa5b1ebed46573ed2b501de7dae2b927c4513) - **chore:** minor clean-up _(by Philipp Burckhardt)_
 -   [`fd7b7eb`](https://github.com/stdlib-js/stdlib/commit/fd7b7eb341227a6627d70044979b5edfebd5f692) - **refactor:** use assert utility _(by Athan Reines)_

base/broadcasted-quaternary3d/README.md

@@ -116,7 +116,7 @@ var w = filled3dBy( shapes[ 3 ], discreteUniform( -100, 100 ) );
 console.log( w );
 
 var out = zeros3d( shapes[ 4 ] );
-console.log( z );
+console.log( out );
 
 bquaternary3d( [ x, y, z, w, out ], shapes, add );
 console.log( out );

base/broadcasted-quaternary4d/README.md

@@ -64,7 +64,7 @@ bquaternary4d( [ x, y, z, w, out ], shapes, add );
 
 The function accepts the following arguments:
 
--   **arrays**: array-like object containing two input nested arrays and one output nested array.
+-   **arrays**: array-like object containing four input nested arrays and one output nested array.
 -   **shapes**: array shapes.
 -   **fcn**: quaternary function to apply.
 
@@ -116,7 +116,7 @@ var w = filled4dBy( shapes[ 3 ], discreteUniform( -100, 100 ) );
 console.log( w );
 
 var out = zeros4d( shapes[ 4 ] );
-console.log( z );
+console.log( out );
 
 bquaternary4d( [ x, y, z, w, out ], shapes, add );
 console.log( out );

base/broadcasted-quaternary5d/README.md

@@ -116,7 +116,7 @@ var w = filled5dBy( shapes[ 3 ], discreteUniform( -100, 100 ) );
 console.log( w );
 
 var out = zeros5d( shapes[ 4 ] );
-console.log( z );
+console.log( out );
 
 bquaternary5d( [ x, y, z, w, out ], shapes, add );
 console.log( out );

base/count-ifs/docs/types/index.d.ts

@@ -144,7 +144,7 @@ declare function countIfs<T = unknown, U extends InputArray<T> = InputArray<T>>(
 * var x1 = [ -1, -2, 4, 5, -8 ];
 * var x2 = [ 0, 4, 3, 2, 12 ];
 *
-* var n = countIfs( x0, predicate0, x1, predicate1 );
+* var n = countIfs( x0, predicate0, x1, predicate1, x2, predicate2 );
 * // returns 2
 */
 declare function countIfs<T = unknown, U extends InputArray<T> = InputArray<T>>( x0: U, predicate0: Predicate<T, U>, x1: U, predicate1: Predicate<T, U>, x2: U, predicate2: Predicate<T, U> ): number;
@@ -230,7 +230,7 @@ declare function countIfs<T = unknown, U extends InputArray<T> = InputArray<T>>(
 * var x1 = [ -1, -2, 4, 5, -8 ];
 * var x2 = [ 0, 4, 3, 2, 12 ];
 * var x3 = [ 2, 9, 3, 6, 5 ];
-* var x4 = [ false, true, false, true, true ]
+* var x4 = [ false, true, false, true, true ];
 *
 * var n = countIfs( x0, predicate0, x1, predicate1, x3, predicate3, x4, predicate4 );
 * // returns 2

base/count-same-value-zero/lib/main.js

@@ -196,11 +196,11 @@ function boolean( x, value ) {
 * // returns 2
 */
 function countSameValueZero( x, value ) {
-	if ( isAccessorArray( x, value ) ) {
-		if ( isComplexTypedArray( x, value ) ) {
+	if ( isAccessorArray( x ) ) {
+		if ( isComplexTypedArray( x ) ) {
 			return complex( x, value );
 		}
-		if ( isBooleanArray( x, value ) ) {
+		if ( isBooleanArray( x ) ) {
 			return boolean( x, value );
 		}
 		return accessors( x, value );

base/count-same-value/lib/main.js

@@ -196,11 +196,11 @@ function boolean( x, value ) {
 * // returns 3
 */
 function countSameValue( x, value ) {
-	if ( isAccessorArray( x, value ) ) {
-		if ( isComplexTypedArray( x, value ) ) {
+	if ( isAccessorArray( x ) ) {
+		if ( isComplexTypedArray( x ) ) {
 			return complex( x, value );
 		}
-		if ( isBooleanArray( x, value ) ) {
+		if ( isBooleanArray( x ) ) {
 			return boolean( x, value );
 		}
 		return accessors( x, value );

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

@@ -67,7 +67,7 @@ type Ternary<T, U> = ( this: U, value: T, index: number, arr: Collection<T> | Ac
 type Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
 
 /**
-* Interface describing `cunanyBy`.
+* Interface describing `cuanyBy`.
 */
 interface CuAnyBy {
 	/**
@@ -86,7 +86,7 @@ interface CuAnyBy {
 	* var x = [ 0, 0, 0, 1, 0 ];
 	*
 	* var y = cuanyBy( x, isPositive );
-	*  // returns [ false, false, false, true, true ];
+	* // returns [ false, false, false, true, true ];
 	*/
 	<T = unknown, U = unknown>( x: Collection<T> | AccessorArrayLike<T>, predicate: Predicate<T, U>, thisArg?: ThisParameterType<Predicate<T, U>> ): Array<boolean>;
 

base/cuany/docs/types/index.d.ts

@@ -36,7 +36,7 @@ interface CuAny {
 	* var x = [ false, false , true, false , false ];
 	*
 	* var y = cuany( x );
-	*  // returns [ false, false, true, true, true ];
+	* // returns [ false, false, true, true, true ];
 	*/
 	( x: Collection | AccessorArrayLike<any> ): Array<boolean>;
 
@@ -53,7 +53,7 @@ interface CuAny {
 	* var x = [ false, false, true, false, false ];
 	* var y = [ false, null, false, null, false, null, false, null, false, null ];
 	*
-	* var arr = cuany.assign( x, y, 2, 0 );,
+	* var arr = cuany.assign( x, y, 2, 0 );
 	* // returns [ false, null, false, null, true, null, true, null, true, null ];
 	*/
 	assign<T, U extends Collection<T> | AccessorArrayLike<T>>( x: Collection | AccessorArrayLike<any>, y: U, stride: number, offset: number ): U;

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

@@ -188,7 +188,7 @@ interface CueveryByRight {
 * var x = [ 1, 0, 0, 1, 1 ];
 * var y = [ false, null, false, null, false, null, false, null, false, null ];
 *
-* var arr = cueveryByRight.assign( x, 2, y, 2, 0, isPositive );
+* var arr = cueveryByRight.assign( x, y, 2, 0, isPositive );
 * // returns [ true, null, true, null, false, null, false, null, false, null ]
 */
 declare var cueveryByRight: CueveryByRight;

base/cuevery-by-right/lib/main.js

@@ -45,7 +45,7 @@ var assign = require( './assign.js' );
 * // returns [ true, true, true, false, false ]
 */
 function cueveryByRight( x, predicate, thisArg ) {
-	var out = filled( false, x.length );
+	var out = filled( true, x.length );
 	return assign( x, out, 1, 0, predicate, thisArg );
 }
 

base/cuevery-by/docs/types/index.d.ts

@@ -85,7 +85,7 @@ interface CuEveryBy {
 	* var x = [ 1, 1, 1, 0, 0 ];
 	*
 	* var y = cueveryBy( x, isPositive );
-	*  // returns [ true, true, true, false, false ];
+	* // returns [ true, true, true, false, false ];
 	*/
 	<T = unknown, U = unknown>( x: Collection<T> | AccessorArrayLike<T>, predicate: Predicate<T, U>, thisArg?: ThisParameterType<Predicate<T, U>> ): Array<boolean>;
 

base/cuevery-by/lib/main.js

@@ -36,7 +36,7 @@ var assign = require( './assign.js' );
 *
 * @example
 * function isPositive( value ) {
-* 	return ( value > 0 );
+*     return ( value > 0 );
 * }
 *
 * var x = [ 1, 1, 1, 0, 1 ];
@@ -45,7 +45,7 @@ var assign = require( './assign.js' );
 * // returns [ true, true, true, false, false ]
 */
 function cueveryBy( x, predicate, thisArg ) {
-	var out = filled( false, x.length );
+	var out = filled( true, x.length );
 	return assign( x, out, 1, 0, predicate, thisArg );
 }
 

base/cuevery/docs/types/index.d.ts

@@ -36,7 +36,7 @@ interface CuEvery {
 	* var x = [ true, true, true, false, true ];
 	*
 	* var y = cuevery( x );
-	*  // returns [ true, true, true, false, false ];
+	* // returns [ true, true, true, false, false ];
 	*/
 	( x: Collection | AccessorArrayLike<any> ): Array<boolean>;
 

base/cuevery/lib/main.js

@@ -27,7 +27,7 @@ var assign = require( './assign.js' );
 // MAIN //
 
 /**
-* Cumulatively tests whether at every element in a provided array is truthy.
+* Cumulatively tests whether every element in a provided array is truthy.
 *
 * @param {Collection} x - input array
 * @returns {Array} output array

base/cunone-by-right/lib/main.js

@@ -45,7 +45,7 @@ var assign = require( './assign.js' );
 * // returns [ true, true, true, false, false ]
 */
 function cunoneByRight( x, predicate, thisArg ) {
-	var out = filled( false, x.length );
+	var out = filled( true, x.length );
 	return assign( x, out, 1, 0, predicate, thisArg );
 }
 

base/cunone-by/lib/main.js

@@ -31,7 +31,7 @@ var assign = require( './assign.js' );
 *
 * @param {Collection} x - input array
 * @param {Function} predicate - predicate function
-* @param {*} [thisArg] - predicate function
+* @param {*} [thisArg] - execution context
 * @returns {Array} output array
 *
 * @example
@@ -45,7 +45,7 @@ var assign = require( './assign.js' );
 * // returns [ true, true, true, false, false ]
 */
 function cunoneBy( x, predicate, thisArg ) {
-	var out = filled( false, x.length );
+	var out = filled( true, x.length );
 	return assign( x, out, 1, 0, predicate, thisArg );
 }
 

base/cunone/examples/index.js

@@ -1,7 +1,7 @@
 /**
 * @license Apache-2.0
 *
-* Copyright (c) 2024  The Stdlib Authors.
+* 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.

base/cunone/lib/main.js

@@ -27,7 +27,7 @@ var assign = require( './assign.js' );
 // MAIN //
 
 /**
-* Cumulatively tests whether at every element in a provided array is falsy.
+* Cumulatively tests whether every element in a provided array is falsy.
 *
 * @param {Collection} x - input array
 * @returns {Array} output array

base/cusome/lib/main.js

@@ -40,7 +40,7 @@ var assign = require( './assign.js' );
 * // returns [ false, false, false, false, true ]
 */
 function cusome( x, n ) {
-	var y = filled( true, x.length );
+	var y = filled( false, x.length );
 	return assign( x, n, y, 1, 0 );
 }
 

base/filled4d-by/README.md

@@ -72,7 +72,7 @@ var ctx = {
 };
 
 var out = filled4dBy( [ 1, 1, 2, 3 ], clbk, ctx );
-// returns [ [ [ [ 1.0, 1.0, 1.0 ], [ 1.0, 1.0, 1.0 ] ] ] ];
+// returns [ [ [ [ 1.0, 1.0, 1.0 ], [ 1.0, 1.0, 1.0 ] ] ] ]
 
 var cnt = ctx.count;
 // returns 6

base/filled4d-by/docs/types/index.d.ts

@@ -48,7 +48,7 @@ type Callback<T, V> = Nullary<T, V> | Unary<T, V>;
 /**
 * Four-dimensional nested array.
 */
-type Array4D<T> = Array<Array<Array<T>>>;
+type Array4D<T> = Array<Array<Array<Array<T>>>>;
 
 /**
 * Returns a filled four-dimensional nested array according to a provided callback function.

base/filled4d/docs/types/index.d.ts

@@ -25,7 +25,7 @@ import { Shape4D } from '@stdlib/types/ndarray';
 /**
 * Four-dimensional nested array.
 */
-type Array4D<T> = Array<Array<Array<T>>>;
+type Array4D<T> = Array<Array<Array<Array<T>>>>;
 
 /**
 * Returns a filled four-dimensional nested array.

base/fillednd-by/README.md

@@ -72,7 +72,7 @@ var ctx = {
 };
 
 var out = filledndBy( [ 1, 1, 1, 2, 3 ], clbk, ctx );
-// returns [ [ [ [ [ 1.0, 1.0, 1.0 ], [ 1.0, 1.0, 1.0 ] ] ] ] ];
+// returns [ [ [ [ [ 1.0, 1.0, 1.0 ], [ 1.0, 1.0, 1.0 ] ] ] ] ]
 
 var cnt = ctx.count;
 // returns 6

base/fillednd/lib/main.js

@@ -60,7 +60,7 @@ function recurse( value, ndims, shape, dim, out ) {
 // MAIN //
 
 /**
-* Returns a filled two-dimensional nested array.
+* Returns a filled n-dimensional nested array.
 *
 * @param {*} value - fill value
 * @param {NonNegativeIntegerArray} shape - array shape

base/filter/docs/types/index.d.ts

@@ -296,6 +296,8 @@ declare function filter<T = unknown, U = unknown>( x: Complex64Array, predicate:
 * @returns output array
 *
 * @example
+* var isPositiveNumber = require( '@stdlib/assert/is-positive-number' ).isPrimitive;
+*
 * var x = [ 1, -2, -3, 4 ];
 *
 * var out = filter( x, isPositiveNumber );
@@ -312,6 +314,7 @@ declare function filter<T = unknown, U = unknown>( x: Array<T>, predicate: Predi
 * @returns output array
 *
 * @example
+* var isPositiveNumber = require( '@stdlib/assert/is-positive-number' ).isPrimitive;
 * var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
 *
 * var x = toAccessorArray( [ 1, -2, -3, 4 ] );
@@ -330,6 +333,8 @@ declare function filter<T = unknown, U = unknown>( x: AccessorArrayLike<T>, pred
 * @returns output array
 *
 * @example
+* var isPositiveNumber = require( '@stdlib/assert/is-positive-number' ).isPrimitive;
+*
 * var x = [ 1, -2, -3, 4 ];
 *
 * var out = filter( x, isPositiveNumber );

base/flatten2d-by/docs/types/index.d.ts

@@ -134,7 +134,7 @@ interface Flatten2dBy {
 	*
 	* var x = [ [ 1, 2 ], [ 3, 4 ] ];
 	*
-	* var out = flatten2dBy( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale );
+	* var out = flatten2dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale );
 	* // returns <Float64Array>[ 2, 4, 6, 8 ]
 	*
 	* @example
@@ -146,7 +146,7 @@ interface Flatten2dBy {
 	*
 	* var x = [ [ 1, 2 ], [ 3, 4 ] ];
 	*
-	* var out = flatten2dBy( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale );
+	* var out = flatten2dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale );
 	* // returns <Float64Array>[ 2, 6, 4, 8 ]
 	*/
 	assign<T = unknown, U = unknown, V = unknown, W = unknown>( x: Array2D<T>, shape: Shape2D, colexicographic: boolean, out: Collection<V>, stride: number, offset: number, clbk: Callback<T, U, W>, thisArg?: ThisParameterType<Callback<T, U, W>> ): Collection<U | V>;

base/fliplr4d/lib/index.js

@@ -24,7 +24,7 @@
 * @module @stdlib/array/base/fliplr4d
 *
 * @example
-* var fliplr = require( '@stdlib/array/base/fliplr4d' );
+* var fliplr4d = require( '@stdlib/array/base/fliplr4d' );
 *
 * var x = [ [ [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] ] ];
 *

base/fliplr5d/lib/index.js

@@ -24,7 +24,7 @@
 * @module @stdlib/array/base/fliplr5d
 *
 * @example
-* var fliplr = require( '@stdlib/array/base/fliplr5d' );
+* var fliplr5d = require( '@stdlib/array/base/fliplr5d' );
 *
 * var x = [ [ [ [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] ] ] ];
 *

base/flipud2d/lib/index.js

@@ -24,7 +24,7 @@
 * @module @stdlib/array/base/flipud2d
 *
 * @example
-* var flipud = require( '@stdlib/array/base/flipud2d' );
+* var flipud2d = require( '@stdlib/array/base/flipud2d' );
 *
 * var x = [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ];
 *

base/flipud3d/lib/index.js

@@ -24,7 +24,7 @@
 * @module @stdlib/array/base/flipud3d
 *
 * @example
-* var flipud = require( '@stdlib/array/base/flipud3d' );
+* var flipud3d = require( '@stdlib/array/base/flipud3d' );
 *
 * var x = [ [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] ];
 *

base/flipud4d/lib/index.js

@@ -24,7 +24,7 @@
 * @module @stdlib/array/base/flipud4d
 *
 * @example
-* var flipud = require( '@stdlib/array/base/flipud4d' );
+* var flipud4d = require( '@stdlib/array/base/flipud4d' );
 *
 * var x = [ [ [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] ] ];
 *