Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -695,6 +695,7 @@ A total of 40 issues were closed in this release:
 
 <details>
 
+-   [`90021da`](https://github.com/stdlib-js/stdlib/commit/90021dae5b5a3b4fbeb5e2366c71b5ddf2095555) - **chore:** clean-up _(by Athan Reines)_
 -   [`fd99657`](https://github.com/stdlib-js/stdlib/commit/fd99657f0da9706d3c1d7b03c5f9caf97069d3df) - **feat:** add `ndarray/prepend-singleton-dimensions` [(#9478)](https://github.com/stdlib-js/stdlib/pull/9478) _(by Muhammad Haris, Athan Reines)_
 -   [`f475c84`](https://github.com/stdlib-js/stdlib/commit/f475c843a4b1579eef6533e464e4c16766d7ecdd) - **feat:** add writable parameter to `ndarray/base/expand-dimensions` [(#9476)](https://github.com/stdlib-js/stdlib/pull/9476) _(by Muhammad Haris, Athan Reines)_
 -   [`da6ecc9`](https://github.com/stdlib-js/stdlib/commit/da6ecc96d7f503e03007eef616703fc7a71587b8) - **chore:** fix JavaScript lint errors [(#9572)](https://github.com/stdlib-js/stdlib/pull/9572) _(by Shreelaxmi Hegde, Athan Reines)_

find/README.md

@@ -59,10 +59,7 @@ var x = array( [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
 
 // Perform reduction:
 var out = find( x, isEven );
-// returns <ndarray>
-
-var v = out.get();
-// returns 2.0
+// returns <ndarray>[ 2.0 ]
 ```
 
 The function accepts the following arguments:
@@ -82,7 +79,6 @@ By default, the function performs reduction over all all elements in a provided
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function isEven( value ) {
     return value % 2.0 === 0.0;
@@ -98,17 +94,13 @@ var opts = {
 
 // Perform reduction:
 var out = find( x, opts, isEven );
-// returns <ndarray>
-
-var v = ndarray2array( out );
-// returns [ [ NaN, 2.0 ], [ NaN, 4.0 ] ]
+// returns <ndarray>[ [ NaN, 2.0 ], [ NaN, 6.0 ] ]
 ```
 
 By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a shape matching only the non-reduced dimensions of the input [ndarray][@stdlib/ndarray/ctor] (i.e., the reduced dimensions are dropped). To include the reduced dimensions as singleton dimensions in the output [ndarray][@stdlib/ndarray/ctor], set the `keepdims` option to `true`.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function isEven( value ) {
     return value % 2.0 === 0.0;
@@ -125,17 +117,13 @@ var opts = {
 
 // Perform reduction:
 var out = find( x, opts, isEven );
-// returns <ndarray>
-
-var v = ndarray2array( out );
-// returns [ [ [ NaN, 2 ], [ NaN, 4 ] ] ]
+// returns <ndarray>[ [ [ NaN, 2.0 ] ], [ [ NaN, 6.0 ] ] ]
 ```
 
 To specify a custom sentinel value to return when no element passes the test, set the `sentinel` option.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function isEven( value ) {
     return value % 2.0 === 0.0;
@@ -151,10 +139,7 @@ var opts = {
 
 // Perform reduction:
 var out = find( x, opts, isEven );
-// returns <ndarray>
-
-var v = out.get();
-// returns -999
+// returns <ndarray>[ -999 ]
 ```
 
 To set the `predicate` function execution context, provide a `thisArg`.
@@ -163,7 +148,6 @@ To set the `predicate` function execution context, provide a `thisArg`.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
 function isEven( value ) {
     this.count += 1;
@@ -180,10 +164,7 @@ var ctx = {
 
 // Perform reduction:
 var out = find( x, isEven, ctx );
-// returns <ndarray>
-
-var v = out.get();
-// returns 2.0
+// returns <ndarray>[ 2.0 ]
 
 var count = ctx.count;
 // returns 2
@@ -196,6 +177,7 @@ Finds the first elements which pass a test implemented by a predicate function a
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
 var empty = require( '@stdlib/ndarray/empty' );
+var getDType = require( '@stdlib/ndarray/dtype' );
 
 function isEven( value ) {
     return value % 2.0 === 0.0;
@@ -207,18 +189,15 @@ var x = array( [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
 
 // Create an output ndarray:
 var y = empty( [], {
-    'dtype': x.dtype
+    'dtype': getDType( x )
 });
 
 // Perform reduction:
 var out = find.assign( x, y, isEven );
-// returns <ndarray>
+// returns <ndarray>[ 2.0 ]
 
 var bool = ( out === y );
 // returns true
-
-var v = y.get();
-// returns 2.0
 ```
 
 The function accepts the following arguments:
@@ -237,7 +216,7 @@ The function accepts the following options:
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
 var empty = require( '@stdlib/ndarray/empty' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var getDType = require( '@stdlib/ndarray/dtype' );
 
 function isEven( value ) {
     return value % 2.0 === 0.0;
@@ -249,7 +228,7 @@ var x = array( [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
 
 // Create an output ndarray:
 var y = empty( [ 2, 2 ], {
-    'dtype': x.dtype
+    'dtype': getDType( x )
 });
 
 var opts = {
@@ -258,12 +237,10 @@ var opts = {
 
 // Perform reduction:
 var out = find.assign( x, y, opts, isEven );
+// returns <ndarray>[ [ NaN, 2.0 ], [ NaN, 6.0 ] ]
 
 var bool = ( out === y );
 // returns true
-
-var v = ndarray2array( y );
-// returns [ [ NaN, 2.0 ], [ NaN, 4.0 ] ]
 ```
 
 </section>

find/docs/repl.txt

@@ -1,6 +1,6 @@
 
 {{alias}}( x[, options], predicate[, thisArg] )
-    Return a new ndarray containing the first elements which pass a test
+    Returns a new ndarray containing the first elements which pass a test
     implemented by a predicate function along one or more ndarray dimensions.
 
     Parameters
@@ -54,7 +54,7 @@
 
 {{alias}}.assign( x, out[, options], predicate[, thisArg] )
     Finds the first elements which pass a test implemented by a predicate
-    function along one or more ndarray dimensions and assign results to a
+    function along one or more ndarray dimensions and assigns results to a
     provided output ndarray.
 
     Parameters

find/lib/assign.js

@@ -55,21 +55,24 @@ var getSentinel = require( './sentinel.js' );
 * @throws {TypeError} second argument must be an ndarray-like object
 * @throws {TypeError} options argument must be an object
 * @throws {TypeError} predicate argument must be a function
+* @throws {RangeError} dimension indices must not exceed input ndarray bounds
+* @throws {RangeError} number of dimension indices must not exceed the number of input ndarray dimensions
 * @throws {Error} must provide valid options
 * @returns {ndarray} output ndarray
 *
 * @example
 * var isEven = require( '@stdlib/assert/is-even' ).isPrimitive;
 * var array = require( '@stdlib/ndarray/array' );
 * var empty = require( '@stdlib/ndarray/empty' );
+* var getDType = require( '@stdlib/ndarray/dtype' );
 *
 * // Create an input ndarray:
 * var x = array( [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], [ [ 0.0, 6.0 ], [ 7.0, 8.0 ] ] ] );
 * // returns <ndarray>
 *
 * // Create an output ndarray:
 * var y = empty( [], {
-*     'dtype': x.dtype
+*     'dtype': getDType( x )
 * });
 *
 * // Perform reduction:

find/lib/main.js

@@ -101,10 +101,10 @@ function find( x, options, predicate, thisArg ) { // eslint-disable-line stdlib/
 	}
 	// Case: find( x, predicate )
 	if ( nargs < 3 ) {
-		if ( !isFunction( options ) ) {
-			throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', options ) );
-		}
 		cb = options;
+		if ( !isFunction( cb ) ) {
+			throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', cb ) );
+		}
 	}
 	// Case: find( x, options, predicate, thisArg )
 	else if ( nargs > 3 ) {