chore: clean-up documentation and fix tests

Ref: stdlib-js#1705
Ref: stdlib-js@23e158b
---
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: passed
  - 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: passed
  - task: lint_javascript_benchmarks
    status: passed
  - 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: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # mskfilterMap
 
-> Apply a mask to a provided input array and return a new array after applying a mapping function.
+> Apply a mask and a callback function to a provided input array.
 
 <section class="usage">
 
@@ -32,7 +32,7 @@ var mskfilterMap = require( '@stdlib/array/base/mskfilter-map' );
 
 #### mskfilterMap( x, mask, clbk\[, thisArg] )
 
-Applies a mask to a provided input array and returns a new array after applying a mapping function.
+Returns a new array after applying a mask and a callback function to a provided input array.
 
 ```javascript
 function clbk( value ) {
@@ -50,10 +50,10 @@ The function supports the following parameters:
 
 -   **x**: input array.
 -   **mask**: mask array.
--   **clbk**: function to apply.
--   **thisArg**: applied function execution context (_optional_).
+-   **clbk**: callback to apply.
+-   **thisArg**: callback execution context (_optional_).
 
-To set the applied function's execution context, provide a `thisArg`.
+To set the execution context of the callback function, provide a `thisArg`.
 
 <!-- eslint-disable no-invalid-this -->
 
@@ -81,7 +81,7 @@ The function **always** returns a new "generic" array.
 
 #### mskfilterMap.assign( x, mask, out, stride, offset, clbk\[, thisArg] )
 
-Applies a mask and mapping function to a provided input array and assigns results to elements in a provided output array.
+Applies a mask and a callback function to a provided input array and assigns results to elements in a provided output array.
 
 ```javascript
 function clbk( value ) {
@@ -106,8 +106,8 @@ The function supports the following parameters:
 -   **out**: output array.
 -   **stride**: output array stride.
 -   **offset**: output array offset.
--   **clbk**: function to apply.
--   **thisArg**: applied function execution context (_optional_).
+-   **clbk**: callback function.
+-   **thisArg**: callback execution context (_optional_).
 
 </section>
 

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/benchmark/benchmark.assign.length.js

@@ -27,7 +27,7 @@ var zeros = require( '@stdlib/array/zeros' );
 var ones = require( '@stdlib/array/ones' );
 var isArray = require( '@stdlib/assert/is-array' );
 var isnan = require( '@stdlib/assert/is-nan' ).isPrimitive;
-var identity = require( '@stdlib/math/base/special/identity' );
+var identity = require( '@stdlib/utils/identity-function' );
 var pkg = require( './../package.json' ).name;
 var mskfilterMap = require( './../lib' );
 

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/benchmark/benchmark.js

@@ -24,7 +24,7 @@ var bench = require( '@stdlib/bench' );
 var isArray = require( '@stdlib/assert/is-array' );
 var zeroTo = require( '@stdlib/array/base/zero-to' );
 var ones = require( '@stdlib/array/base/ones' );
-var identity = require( '@stdlib/math/base/special/identity' );
+var identity = require( '@stdlib/utils/identity-function' );
 var pkg = require( './../package.json' ).name;
 var mskfilterMap = require( './../lib' );
 

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/benchmark/benchmark.length.js

@@ -25,7 +25,7 @@ var pow = require( '@stdlib/math/base/special/pow' );
 var zeroTo = require( '@stdlib/array/base/zero-to' );
 var ones = require( '@stdlib/array/base/ones' );
 var isArray = require( '@stdlib/assert/is-array' );
-var identity = require( '@stdlib/math/base/special/identity' );
+var identity = require( '@stdlib/utils/identity-function' );
 var pkg = require( './../package.json' ).name;
 var mskfilterMap = require( './../lib' );
 

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/docs/repl.txt

@@ -1,7 +1,7 @@
 
-{{alias}}( x, mask, fcn[, thisArg] )
-    Applies a mask to a provided input array and returns a new array after
-    applying a mapping function.
+{{alias}}( x, mask, clbk[, thisArg] )
+    Returns a new array after applying a mask and a callback function to a
+    provided input array.
 
     If a mask array element is truthy, the corresponding element in `x` is
     included in the output array; otherwise, the corresponding element in `x`
@@ -15,11 +15,11 @@
     mask: ArrayLikeObject
         Mask array.
 
-    fcn: Function
+    clbk: Function
         Function to apply.
 
     thisArg: any (optional)
-        Function execution context.
+        Callback execution context.
 
     Returns
     -------
@@ -33,8 +33,8 @@
     [ 2, 4 ]
 
 
-{{alias}}.assign( x, mask, out, stride, offset, fcn[, thisArg] )
-    Applies a mask and mapping function to a provided input array and assigns
+{{alias}}.assign( x, mask, out, stride, offset, clbk[, thisArg] )
+    Applies a mask and a callback function to a provided input array and assigns
     results to elements in a provided output array.
 
     If a mask array element is truthy, the corresponding element in `x` is
@@ -58,11 +58,11 @@
     offset: integer
         Output array offset.
 
-    fcn: Function
+    clbk: Function
         Function to apply.
 
     thisArg: any (optional)
-        Function execution context.
+        Callback execution context.
 
     Returns
     -------

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/docs/types/index.d.ts

@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Array2D, Collection } from '@stdlib/types/array';
+import { Collection } from '@stdlib/types/array';
 
 /**
 * Callback invoked for each array element.
@@ -41,7 +41,7 @@ type Unary<T, U, V> = ( this: V, value: T ) => U;
 * Callback invoked for each array element.
 *
 * @param value - array element
-* @param indices - current array element indices
+* @param index - current array element index
 * @returns result
 */
 type Binary<T, U, V> = ( this: V, value: T, index: number ) => U;
@@ -50,17 +50,17 @@ type Binary<T, U, V> = ( this: V, value: T, index: number ) => U;
 * Callback invoked for each array element.
 *
 * @param value - array element
-* @param indices - current array element indices
+* @param index - current array element index
 * @param array - input array
 * @returns result
 */
-type Ternary<T, U, V> = ( this: V, value: T, index: number, array: Array2D<T> ) => U;
+type Ternary<T, U, V> = ( this: V, value: T, index: number, array: Collection<T> ) => U;
 
 /**
 * Callback invoked for each array element.
 *
 * @param value - array element
-* @param indices - current array element indices
+* @param index - current array element index
 * @param array - input array
 * @returns result
 */
@@ -71,12 +71,12 @@ type Callback<T, U, V> = Nullary<U, V> | Unary<T, U, V> | Binary<T, U, V> | Tern
 */
 interface Routine {
 	/**
-	* Applies a mask to a provided input array and returns a new array after applying a mapping function.
+	* Returns a new array after applying a mask and a callback function to a provided input array.
 	*
 	* @param x - input array
 	* @param mask - mask array
-	* @param clbk - callback to invoke
-	* @param thisArg - execution context
+	* @param clbk - callback function
+	* @param thisArg - callback execution context
 	* @returns output array
 	*
 	* @example
@@ -92,15 +92,15 @@ interface Routine {
 	<T = unknown, U = unknown, V = unknown>( x: Collection<T>, mask: Collection, clbk: Callback<T, U, V>, thisArg?: ThisParameterType<Callback<T, U, V>> ): Array<U>;
 
 	/**
-	* Applies a mask and mapping function to an input array and assigns results to elements in an output array.
+	* Applies a mask and a callback function to an input array and assigns results to elements in an output array.
 	*
 	* @param x - input array
 	* @param mask - mask array
 	* @param out - output array
 	* @param stride - output array stride
 	* @param offset - output array offset
-	* @param clbk - callback to invoke
-	* @param thisArg - execution context
+	* @param clbk - callback function
+	* @param thisArg - callback execution context
 	* @returns output array
 	*
 	* @example
@@ -123,12 +123,12 @@ interface Routine {
 }
 
 /**
-* Applies a mask to a provided input array and returns a new array after applying a mapping function.
+* Returns a new array after applying a mask and a callback function to a provided input array.
 *
 * @param x - input array
 * @param mask - mask array
-* @param clbk - callback to invoke
-* @param thisArg - execution context
+* @param clbk - callback function
+* @param thisArg - callback execution context
 * @returns output array
 *
 * @example

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/docs/types/test.ts

@@ -19,7 +19,7 @@
 import mskfilterMap = require( './index' );
 
 /**
-* Unary function.
+* Callback function.
 *
 * @param value - input value
 * @returns result
@@ -250,6 +250,7 @@ function clbk( value: number ): number {
 	const mask = [ 0.0, 0.0, 0.0, 0.0 ];
 
 	mskfilterMap.assign(); // $ExpectError
+	mskfilterMap.assign( x ); // $ExpectError
 	mskfilterMap.assign( x, mask ); // $ExpectError
 	mskfilterMap.assign( x, mask, [ 0, 0, 0, 0 ] ); // $ExpectError
 	mskfilterMap.assign( x, mask, [ 0, 0, 0, 0 ], 1 ); // $ExpectError

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/lib/assign.js

@@ -26,7 +26,7 @@ var arraylike2object = require( '@stdlib/array/base/arraylike2object' );
 // FUNCTIONS //
 
 /**
-* Applies a mask and mapping function to an indexed array and assigns results to elements in an indexed output array.
+* Applies a mask and a callback function to an indexed array and assigns results to elements in an indexed 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} clbk - function to apply
-* @param {*} [thisArg] - function execution context
+* @param {*} [thisArg] - callback execution context
 * @returns {Collection} output array
 *
 * @example
@@ -66,7 +66,7 @@ function indexed( x, mask, out, stride, offset, clbk, thisArg ) {
 }
 
 /**
-* Applies a mask and mapping function to an input accessor array and assigns results to elements in an output accessor array.
+* Applies a mask and a callback function to an input accessor array and assigns results to elements in an output accessor array.
 *
 * @private
 * @param {Object} x - input array object
@@ -75,7 +75,7 @@ function indexed( x, mask, out, stride, offset, clbk, thisArg ) {
 * @param {integer} stride - output array stride
 * @param {NonNegativeInteger} offset - output array offset
 * @param {Function} clbk - function to apply
-* @param {*} [thisArg] - function execution context
+* @param {*} [thisArg] - callback execution context
 * @returns {Collection} output array
 *
 * @example
@@ -130,15 +130,15 @@ function accessors( x, mask, out, stride, offset, clbk, thisArg ) {
 // MAIN //
 
 /**
-* Applies a mask and mapping function to a provided input array and assigns results to elements in a provided output array.
+* Applies a mask and a callback function to a provided input array and assigns results to elements in a provided output array.
 *
 * @param {Collection} x - input array
 * @param {Collection} mask - mask array
 * @param {Collection} out - output array
 * @param {integer} stride - output array stride
 * @param {NonNegativeInteger} offset - output array offset
 * @param {Function} clbk - function to apply
-* @param {*} [thisArg] - function execution context
+* @param {*} [thisArg] - callback execution context
 * @returns {Collection} output array
 *
 * @example

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Apply a mask to a provided input array and return a new array after applying a mapping function.
+* Apply a mask and a callback function to a provided input array.
 *
 * @module @stdlib/array/base/mskfilter-map
 *

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/lib/main.js

@@ -26,12 +26,12 @@ var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
 // MAIN //
 
 /**
-* Apply a mask to a provided input array and returns a new array after applying a mapping function.
+* Returns a new array after applying a mask and a callback function to a provided input array.
 *
 * @param {Collection} x - input array
 * @param {Collection} mask - mask array
-* @param {Function} clbk - callback to invoke
-* @param {*} [thisArg] - execution context
+* @param {Function} clbk - callback function
+* @param {*} [thisArg] - callback execution context
 * @returns {Array} output array
 *
 * @example

Diff for: lib/node_modules/@stdlib/array/base/mskfilter-map/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/array/base/mskfilter-map",
   "version": "0.0.0",
-  "description": "Apply a mask to a provided input array.",
+  "description": "Apply a mask and a callback function to a provided input array.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",