refactor: rename clbk to predicate to use more descriptive term

---
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: 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: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/ndarray/base/every-by/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # everyBy
 
-> Test whether every element in an ndarray is truthy according to a callback function.
+> Test whether all elements in an ndarray pass a test implemented by a predicate function.
 
 <section class="intro">
 
@@ -36,9 +36,9 @@ limitations under the License.
 var everyBy = require( '@stdlib/ndarray/base/every-by' );
 ```
 
-#### everyBy( arrays, clbk\[, thisArg] )
+#### everyBy( arrays, predicate\[, thisArg] )
 
-Tests whether every element in an ndarray is truthy according to a callback function.
+Tests whether all elements in an ndarray pass a test implemented by a predicate function.
 
 <!-- eslint-disable max-len -->
 
@@ -79,8 +79,8 @@ var out = everyBy( [ x ], clbk );
 The function accepts the following arguments:
 
 -   **arrays**: array-like object containing an input ndarray.
--   **clbk**: callback function.
--   **thisArg**: callback execution context (_optional_).
+-   **predicate**: predicate function.
+-   **thisArg**: predicate function execution context (_optional_).
 
 The provided ndarray should be an `object` with the following properties:
 
@@ -91,13 +91,13 @@ The provided ndarray should be an `object` with the following properties:
 -   **offset**: index offset.
 -   **order**: specifies whether an ndarray is row-major (C-style) or column major (Fortran-style).
 
-The callback function is provided the following arguments:
+The predicate function is provided the following arguments:
 
 -   **value**: current array element.
 -   **indices**: current array element indices.
 -   **arr**: the input ndarray.
 
-To set the callback function execution context, provide a `thisArg`.
+To set the predicate function execution context, provide a `thisArg`.
 
 <!-- eslint-disable no-invalid-this, max-len -->
 
@@ -152,6 +152,7 @@ var count = ctx.count;
 ## Notes
 
 -   For very high-dimensional ndarrays which are non-contiguous, one should consider copying the underlying data to contiguous memory before performing the operation in order to achieve better performance.
+-   If provided an empty ndarray, the function returns `true`.
 
 </section>
 

lib/node_modules/@stdlib/ndarray/base/every-by/docs/repl.txt

@@ -1,7 +1,7 @@
 
-{{alias}}( arrays, clbk[, thisArg] )
-    Tests whether every element in an ndarray is truthy according to a callback
-    function.
+{{alias}}( arrays, predicate[, thisArg] )
+    Tests whether all elements in an ndarray pass a test implemented by a
+    predicate function.
 
     A provided "ndarray" should be an `object` with the following properties:
 
@@ -13,28 +13,30 @@
     - order: specifies whether an ndarray is row-major (C-style) or column-major
     (Fortran-style).
 
-    The callback function is provided the following arguments:
+    The predicate function is provided the following arguments:
 
     - value: current array element.
     - indices: current array element indices.
     - arr: the input ndarray.
 
+    If provided an empty ndarray, the function returns `true`.
+
     Parameters
     ----------
     arrays: ArrayLikeObject<ndarray>
         Array-like object containing an input ndarray.
 
-    clbk: Function
-        Callback function.
+    predicate: Function
+        Predicate function.
 
     thisArg: any (optional)
-        Callback execution context.
+        Predicate function execution context.
 
     Returns
     -------
     out: boolean
-        Boolean indicating whether every element in an ndarray is truthy
-        according to a callback function.
+        Boolean indicating whether all elements in an ndarray pass a test
+        implemented by a predicate function.
 
     Examples
     --------

lib/node_modules/@stdlib/ndarray/base/every-by/docs/types/index.d.ts

@@ -24,55 +24,61 @@ import { ArrayLike } from '@stdlib/types/array';
 import { typedndarray } from '@stdlib/types/ndarray';
 
 /**
-* Callback invoked for each ndarray element.
+* Returns a boolean indicating whether an element passes a test.
+*
+* @returns boolean indicating whether an ndarray element passes a test
 */
-type Nullary<U> = ( this: U ) => void;
+type Nullary<U> = ( this: U ) => boolean;
 
 /**
-* Callback invoked for each ndarray element.
+* Returns a boolean indicating whether an element passes a test.
 *
 * @param value - current array element
+* @returns boolean indicating whether an ndarray element passes a test
 */
-type Unary<T, U> = ( this: U, value: T ) => void;
+type Unary<T, U> = ( this: U, value: T ) => boolean;
 
 /**
-* Callback invoked for each ndarray element.
+* Returns a boolean indicating whether an element passes a test.
 *
 * @param value - current array element
 * @param indices - current array element indices
+* @returns boolean indicating whether an ndarray element passes a test
 */
-type Binary<T, U> = ( this: U, value: T, indices: Array<number> ) => void;
+type Binary<T, U> = ( this: U, value: T, indices: Array<number> ) => boolean;
 
 /**
-* Callback invoked for each ndarray element.
+* Returns a boolean indicating whether an element passes a test.
 *
 * @param value - current array element
 * @param indices - current array element indices
 * @param arr - input array
+* @returns boolean indicating whether an ndarray element passes a test
 */
-type Ternary<T, U> = ( this: U, value: T, indices: Array<number>, arr: typedndarray<T> ) => void;
+type Ternary<T, U> = ( this: U, value: T, indices: Array<number>, arr: typedndarray<T> ) => boolean;
 
 /**
-* Callback invoked for each ndarray element.
+* Returns a boolean indicating whether an element passes a test.
 *
 * @param value - current array element
 * @param indices - current array element indices
 * @param arr - input array
+* @returns boolean indicating whether an ndarray element passes a test
 */
-type Callback<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
+type Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
 
 /**
-* Tests whether every element in an ndarray is truthy according to a callback function.
+* Tests whether all elements in an ndarray pass a test implemented by a predicate function.
 *
-* @param arrays - array-like object containing an output ndarray
-* @param clbk - callback function
-* @param thisArg - callback execution context
-* @returns result
+* @param arrays - array-like object containing an input ndarray
+* @param predicate - predicate function
+* @param thisArg - predicate function execution context
+* @returns boolean indicating whether all elements pass a test
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 *
-* function clbk( value ) {
+* function predicate( value ) {
 *    return value > 0.0;
 * }
 *
@@ -88,14 +94,14 @@ type Callback<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
 * // Define the index offset:
 * var ox = 1;
 *
-* // Create the output ndarray:
+* // Create the input ndarray:
 * var x = ndarray( 'float64', xbuf, shape, sx, ox, 'row-major' );
 *
-* // Apply the callback function:
-* var out = everyBy( [ x ], clbk );
+* // Test elements:
+* var out = everyBy( [ x ], predicate );
 * // returns true
 */
-declare function everyBy<T = unknown, U = unknown>( arrays: ArrayLike<typedndarray<T>>, clbk: Callback<T, U>, thisArg?: ThisParameterType<Callback<T, U>> ): Boolean;
+declare function everyBy<T = unknown, U = unknown>( arrays: ArrayLike<typedndarray<T>>, predicate: Predicate<T, U>, thisArg?: ThisParameterType<Predicate<T, U>> ): boolean;
 
 
 // EXPORTS //

lib/node_modules/@stdlib/ndarray/base/every-by/docs/types/test.ts

@@ -18,56 +18,29 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { ndarray } from '@stdlib/types/ndarray';
+import zeros = require( '@stdlib/ndarray/zeros' );
 import everyBy = require( './index' );
 
 /**
-* Mock function to create an ndarray-like object.
-*
-* @returns ndarray-like object
-*/
-function array(): ndarray {
-	const obj: ndarray = {
-		'byteLength': 80,
-		'BYTES_PER_ELEMENT': 8,
-		'data': new Float64Array( 10 ),
-		'dtype': 'float64',
-		'flags': {
-			'ROW_MAJOR_CONTIGUOUS': true,
-			'COLUMN_MAJOR_CONTIGUOUS': false
-		},
-		'length': 10,
-		'ndims': 1,
-		'offset': 0,
-		'order': 'row-major',
-		'shape': [ 10 ],
-		'strides': [ 1 ],
-		'get': (): number => 0,
-		'set': (): ndarray => obj
-	};
-	return obj;
-}
-
-/**
-* Callback function.
+* Predicate function.
 *
 * @param v - ndarray element
 * @returns result
 */
-function clbk( v: any ): Boolean {
+function clbk( v: any ): boolean {
 	return v > 0.0;
 }
 
 
 // TESTS //
 
-// The function returns a `Boolean`...
+// The function returns a boolean...
 {
-	const x = array();
+	const x = zeros( [ 2, 2 ] );
 	const arrays = [ x ];
 
-	everyBy( arrays, clbk ); // $ExpectType Boolean
-	everyBy( arrays, clbk, {} ); // $ExpectType Boolean
+	everyBy( arrays, clbk ); // $ExpectType boolean
+	everyBy( arrays, clbk, {} ); // $ExpectType boolean
 }
 
 // The compiler throws an error if the function is provided a first argument which is not an array-like object containing ndarray-like objects...
@@ -93,7 +66,7 @@ function clbk( v: any ): Boolean {
 
 // The compiler throws an error if the function is provided a second argument which is not a callback function...
 {
-	const x = array();
+	const x = zeros( [ 2, 2 ] );
 	const arrays = [ x ];
 
 	everyBy( arrays, '10' ); // $ExpectError
@@ -117,7 +90,7 @@ function clbk( v: any ): Boolean {
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
 {
-	const x = array();
+	const x = zeros( [ 2, 2 ] );
 	const arrays = [ x ];
 
 	everyBy(); // $ExpectError

lib/node_modules/@stdlib/ndarray/base/every-by/lib/0d.js

@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element in an ndarray is truthy according to a callback function.
+* Tests whether all elements in an ndarray pass a test implemented by a predicate function.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
@@ -32,14 +32,14 @@
 * @param {IntegerArray} x.strides - stride lengths
 * @param {NonNegativeInteger} x.offset - index offset
 * @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
-* @param {Function} clbk - callback function
-* @param {*} thisArg - callback execution context
-* @returns {boolean} result
+* @param {Function} predicate - predicate function
+* @param {*} thisArg - predicate function execution context
+* @returns {boolean} boolean indicating whether all elements pass a test
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 *
-* function clbk( value ) {
+* function predicate( value ) {
 *    return value > 0.0;
 * }
 *
@@ -67,11 +67,11 @@
 * };
 *
 * // Test elements:
-* var out = every0d( x, clbk );
+* var out = every0d( x, predicate );
 * // returns true
 */
-function every0d( x, clbk, thisArg ) {
-	if ( clbk.call( thisArg, x.data[ x.offset ], [], x.ref ) ) {
+function every0d( x, predicate, thisArg ) {
+	if ( predicate.call( thisArg, x.data[ x.offset ], [], x.ref ) ) {
 		return true;
 	}
 	return false;

lib/node_modules/@stdlib/ndarray/base/every-by/lib/0d_accessors.js

@@ -21,7 +21,7 @@
 // MAIN //
 
 /**
-* Tests whether every element in an ndarray is truthy according to a callback function.
+* Tests whether all elements in an ndarray pass a test implemented by a predicate function.
 *
 * @private
 * @param {Object} x - object containing ndarray meta data
@@ -33,15 +33,15 @@
 * @param {NonNegativeInteger} x.offset - index offset
 * @param {string} x.order - specifies whether `x` is row-major (C-style) or column-major (Fortran-style)
 * @param {Array<Function>} x.accessors - data buffer accessors
-* @param {Function} clbk - callback function
-* @param {*} thisArg - callback execution context
-* @returns {boolean} result
+* @param {Function} predicate - predicate function
+* @param {*} thisArg - predicate function execution context
+* @returns {boolean} boolean indicating whether all elements pass a test
 *
 * @example
 * var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
 * var accessors = require( '@stdlib/array/base/accessors' );
 *
-* function clbk( value ) {
+* function predicate( value ) {
 *    return value > 0.0;
 * }
 *
@@ -70,11 +70,11 @@
 * };
 *
 * // Test elements:
-* var out = every0d( x, clbk );
+* var out = every0d( x, predicate );
 * // returns true
 */
-function every0d( x, clbk, thisArg ) {
-	if ( clbk.call( thisArg, x.accessors[ 0 ]( x.data, x.offset ), [], x.ref ) ) { // eslint-disable-line max-len
+function every0d( x, predicate, thisArg ) {
+	if ( predicate.call( thisArg, x.accessors[ 0 ]( x.data, x.offset ), [], x.ref ) ) { // eslint-disable-line max-len
 		return true;
 	}
 	return false;