docs: update README and fix option handling

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: na
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/blas/ext/index-of/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # indexOf
 
-> Return the first index of a specified search element along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
+> Return the first index of a specified search element along an [ndarray][@stdlib/ndarray/ctor] dimension.
 
 <section class="usage">
 
@@ -32,7 +32,7 @@ var indexOf = require( '@stdlib/blas/ext/index-of' );
 
 #### indexOf( x, searchElement\[, fromIndex]\[, options] )
 
-Returns the first index of a specified search element along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
+Returns the first index of a specified search element along an [ndarray][@stdlib/ndarray/ctor] dimension.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
@@ -51,18 +51,18 @@ var idx = out.get();
 
 The function has the following parameters:
 
--   **x**: input [ndarray][@stdlib/ndarray/ctor].
--   **searchElement**: element in an input [ndarray][@stdlib/ndarray/ctor] for which to find an index. May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] same as the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided a scalar value, the value is cast to the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. For example, given the input shape `[2, 3, 4]` and `options.dims=[0]`, the search element [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. Similarly, when performing the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor], the search element [ndarray][@stdlib/ndarray/ctor] must be a zero-dimensional [ndarray][@stdlib/ndarray/ctor].
--   **fromIndex**: index from which to begin searching (_optional_). May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having an `integer` or `generic` [data type][@stdlib/ndarray/dtypes]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. For example, given the input shape `[2, 3, 4]` and `options.dims=[0]`, an [ndarray][@stdlib/ndarray/ctor] containing the index from which to begin searching must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. Similarly, when performing the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor], an [ndarray][@stdlib/ndarray/ctor] containing the index from which to begin searching must be a zero-dimensional [ndarray][@stdlib/ndarray/ctor]. By default, the index from which to begin searching is `0`.
+-   **x**: input [ndarray][@stdlib/ndarray/ctor]. Must have at least one dimension.
+-   **searchElement**: search element. May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor]. If provided a scalar value, the value is cast to the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of the input [ndarray][@stdlib/ndarray/ctor]. For example, given the input shape `[2, 3, 4]` and `options.dim=0`, the search element [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`.
+-   **fromIndex**: index from which to begin searching (_optional_). May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having an integer index or "generic" [data type][@stdlib/ndarray/dtypes]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of the input [ndarray][@stdlib/ndarray/ctor]. For example, given the input shape `[2, 3, 4]` and `options.dim=0`, a provided [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. If provided a negative integer, the index at which to begin searching along a dimension is determined by counting backward from the last element (where `-1` refers to the last element). Default: `0`.
 -   **options**: function options (_optional_).
 
 The function accepts the following options:
 
--   **dtype**: output ndarray [data type][@stdlib/ndarray/dtypes]. Must be an integer or generic [data type][@stdlib/ndarray/dtypes].
--   **dims**: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
+-   **dtype**: output ndarray [data type][@stdlib/ndarray/dtypes]. Must be an integer index or generic [data type][@stdlib/ndarray/dtypes].
+-   **dim**: dimension over which to perform operation. If provided a negative integer, the dimension along which to perform the operation is determined by counting backward from the last dimension (where `-1` refers to the last dimension). Default: `-1`.
 -   **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned [ndarray][@stdlib/ndarray/ctor] as singleton dimensions. Default: `false`.
 
-If the function is unable to find a search element, the function returns `-1`.
+If the function is unable to find a search element along an [ndarray][@stdlib/ndarray/ctor], the corresponding element in the returned [ndarray][@stdlib/ndarray/ctor] is `-1`.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
@@ -79,7 +79,7 @@ var idx = out.get();
 // returns -1
 ```
 
-By default, the function uses `0` as the index from which to begin searching. To begin searching from a different index, provide the `fromIndex` argument.
+By default, the function begins searching from the first element along the reduction dimension. To begin searching from a different index, provide a `fromIndex` argument.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
@@ -96,7 +96,7 @@ var idx = out.get();
 // returns 4
 ```
 
-By default, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform the operation over specific dimensions, provide a `dims` option.
+By default, the function performs the operation over elements in the last dimension. To perform the operation over a different dimension, provide a `dim` option.
 
 ```javascript
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
@@ -105,30 +105,27 @@ var array = require( '@stdlib/ndarray/array' );
 var x = array( [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] );
 
 var out = indexOf( x, -3.0, {
-    'dims': [ 0 ]
+    'dim': 0
 });
 // returns <ndarray>
 
 var idx = ndarray2array( out );
 // returns [ 1, -1 ]
 ```
 
-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`.
+By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
 var ndarray2array = require( '@stdlib/ndarray/to-array' );
 
-// Create an input ndarray:
 var x = array( [ [ -1.0, 2.0 ], [ -3.0, 4.0 ] ] );
-// returns <ndarray>
 
 var opts = {
-    'dims': [ 0 ],
+    'dim': 0,
     'keepdims': true
 };
 
-// Find index:
 var out = indexOf( x, -3.0, opts );
 // returns <ndarray>
 
@@ -146,17 +143,17 @@ var array = require( '@stdlib/ndarray/array' );
 var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
 
 var idx = indexOf( x, 2.0, {
-    'dtype': 'int32'
+    'dtype': 'generic'
 });
 // returns <ndarray>
 
 var dt = dtype( idx );
-// returns 'int32'
+// returns 'generic'
 ```
 
 #### indexOf.assign( x, searchElement\[, fromIndex], out\[, options] )
 
-Returns the first index of a specified search element along one or more [ndarray][@stdlib/ndarray/ctor] dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].
+Returns the first index of a specified search element along an [ndarray][@stdlib/ndarray/ctor] dimension and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].
 
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
@@ -179,15 +176,15 @@ var bool = ( out === y );
 
 The method has the following parameters:
 
--   **x**: input [ndarray][@stdlib/ndarray/ctor].
--   **searchElement**: element in an input [ndarray][@stdlib/ndarray/ctor] for which to find an index. May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having a [data type][@stdlib/ndarray/dtypes] same as the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided a scalar value, the value is cast to the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. For example, given the input shape `[2, 3, 4]` and `options.dims=[0]`, the search element [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. Similarly, when performing the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor], an [ndarray][@stdlib/ndarray/ctor] initial value must be a zero-dimensional [ndarray][@stdlib/ndarray/ctor].
--   **fromIndex**: index from which to begin searching (_optional_). May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having an `integer` or `generic` [data type][@stdlib/ndarray/dtypes]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the complement of the shape defined by `options.dims`. For example, given the input shape `[2, 3, 4]` and `options.dims=[0]`, an [ndarray][@stdlib/ndarray/ctor] containing the index from which to begin searching must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. Similarly, when performing the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor], an [ndarray][@stdlib/ndarray/ctor] containing the index from which to begin searching must be a zero-dimensional [ndarray][@stdlib/ndarray/ctor]. By default, the index from which to begin searching is `0`.
--   **out**: output [ndarray][@stdlib/ndarray/ctor]. Must have an `integer` or `generic` [data type][@stdlib/ndarray/dtypes].
+-   **x**: input [ndarray][@stdlib/ndarray/ctor]. Must have at least one dimension.
+-   **searchElement**: search element. May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor]. If provided a scalar value, the value is cast to the data type of the input [ndarray][@stdlib/ndarray/ctor]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of the input [ndarray][@stdlib/ndarray/ctor]. For example, given the input shape `[2, 3, 4]` and `options.dim=0`, the search element [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`.
+-   **fromIndex**: index from which to begin searching (_optional_). May be either a scalar value or an [ndarray][@stdlib/ndarray/ctor] having an integer index or "generic" [data type][@stdlib/ndarray/dtypes]. If provided an [ndarray][@stdlib/ndarray/ctor], the value must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the non-reduced dimensions of the input [ndarray][@stdlib/ndarray/ctor]. For example, given the input shape `[2, 3, 4]` and `options.dim=0`, a provided [ndarray][@stdlib/ndarray/ctor] must have a shape which is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with the shape `[3, 4]`. If provided a negative integer, the index at which to begin searching along a dimension is determined by counting backward from the last element (where `-1` refers to the last element). Default: `0`.
+-   **out**: output [ndarray][@stdlib/ndarray/ctor].
 -   **options**: function options (_optional_).
 
 The method accepts the following options:
 
--   **dims**: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
+-   **dim**: dimension over which to perform operation. If provided a negative integer, the dimension along which to perform the operation is determined by counting backward from the last dimension (where `-1` refers to the last dimension). Default: `-1`.
 
 </section>
 
@@ -197,7 +194,8 @@ The method accepts the following options:
 
 ## Notes
 
--   Both functions iterate over [ndarray][@stdlib/ndarray/ctor] elements according to the memory layout of the input [ndarray][@stdlib/ndarray/ctor]. Accordingly, performance degradation is possible when operating over multiple dimensions of a large non-contiguous multi-dimensional input [ndarray][@stdlib/ndarray/ctor]. In such scenarios, one may want to copy an input [ndarray][@stdlib/ndarray/ctor] to contiguous memory before searching for an index.
+-   Setting the `keepdims` option to `true` can be useful when wanting to ensure that the output [ndarray][@stdlib/ndarray/ctor] is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with ndarrays having the same shape as the input [ndarray][@stdlib/ndarray/ctor].
+-   The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, the function must return an [ndarray][@stdlib/ndarray/ctor] having an integer index or "generic" [data type][@stdlib/ndarray/dtypes]. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any supported output [data type][@stdlib/ndarray/dtypes].
 
 </section>
 
@@ -224,9 +222,9 @@ var xbuf = discreteUniform( 10, 0, 20, {
 var x = new ndarray( 'float64', xbuf, [ 5, 2 ], [ 2, 1 ], 0, 'row-major' );
 console.log( ndarray2array( x ) );
 
-// Find index:
+// Perform operation:
 var idx = indexOf( x, 10.0, {
-    'dims': [ 0 ]
+    'dim': 0
 });
 
 // Print the results:

lib/node_modules/@stdlib/blas/ext/index-of/docs/repl.txt

@@ -30,13 +30,16 @@
         the value must have a shape which is broadcast compatible with the non-
         reduced dimensions of the input ndarray. For example, given the input
         shape `[2, 3, 4]` and `options.dim=0`, a provided ndarray must have a
-        shape which is broadcast-compatible with the shape `[3, 4]`. Default: 0.
+        shape which is broadcast-compatible with the shape `[3, 4]`. If provided
+        a negative integer, the index at which to begin searching along a
+        dimension is determined by counting backward from the last element
+        (where -1 refers to the last element). Default: 0.
 
     options: Object (optional)
         Function options.
 
     options.dtype: string (optional)
-        Output array data type. Must be an integer or "generic" data type.
+        Output array data type. Must be an integer index or "generic" data type.
 
     options.dim: integer (optional)
         Dimension over which to perform a reduction. If provided a negative
@@ -92,7 +95,10 @@
         the value must have a shape which is broadcast compatible with the non-
         reduced dimensions of the input ndarray. For example, given the input
         shape `[2, 3, 4]` and `options.dim=0`, a provided ndarray must have a
-        shape which is broadcast-compatible with the shape `[3, 4]`. Default: 0.
+        shape which is broadcast-compatible with the shape `[3, 4]`. If provided
+        a negative integer, the index at which to begin searching along a
+        dimension is determined by counting backward from the last element
+        (where -1 refers to the last element). Default: 0.
 
     out: ndarray
         Output array.

lib/node_modules/@stdlib/blas/ext/index-of/lib/main.js

@@ -171,6 +171,9 @@ function indexOf( x, searchElement, fromIndex ) {
 	if ( hasOwnProp( options, 'keepdims' ) ) {
 		opts.keepdims = options.keepdims;
 	}
+	if ( hasOwnProp( options, 'dtype' ) ) {
+		opts.dtype = options.dtype;
+	}
 	// Resolve the list of non-reduced dimensions:
 	sh = getShape( x );
 	if ( sh.length < 1 ) {