chore: cleaning up

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

Author: aayush0325

lib/node_modules/@stdlib/lapack/base/dlange/README.md

@@ -30,7 +30,7 @@ The supported norms are:
 
 -   **Max Absolute Value** (`norm` = `'max'`): returns the largest absolute element in `A`.
 
-<!-- <equation class="equation" label="eq:lu_decomposition" align="center" raw="\|A\|_{\max} = \max_{i,j} |a_{i,j}|" alt="Maximum absolute value of a matrix."> -->
+<!-- <equation class="equation" label="eq:max_absolute_value" align="center" raw="\|A\|_{\max} = \max_{i,j} |a_{i,j}|" alt="Maximum absolute value of a matrix."> -->
 
 ```math
 \|A\|_{\max} = \max_{i,j} |a_{i,j}|
@@ -40,7 +40,7 @@ The supported norms are:
 
 -   **One Norm** (`norm` = `'one'`): returns the maximum absolute column sum in `A`.
 
-<!-- <equation class="equation" label="eq:lu_decomposition" align="center" raw="\|A\|_1 = \max_j \sum_{i=1}^M |a_{i,j}|" alt="Definition of one norm of a matrix."> -->
+<!-- <equation class="equation" label="eq:one_norm" align="center" raw="\|A\|_1 = \max_j \sum_{i=1}^M |a_{i,j}|" alt="Definition of one norm of a matrix."> -->
 
 ```math
 \|A\|_1 = \max_j \sum_{i=1}^M |a_{i,j}|
@@ -50,7 +50,7 @@ The supported norms are:
 
 -   **Infinity Norm** (`norm` = `'infinity'`): returns the maximum absolute row sum in `A`.
 
-<!-- <equation class="equation" label="eq:lu_decomposition" align="center" raw="\|A\|_{\infty} = \max_i \sum_{j=1}^N |a_{i,j}|" alt="Definition of infinity norm of a matrix."> -->
+<!-- <equation class="equation" label="eq:infinity_norm" align="center" raw="\|A\|_{\infty} = \max_i \sum_{j=1}^N |a_{i,j}|" alt="Definition of infinity norm of a matrix."> -->
 
 ```math
 \|A\|_{\infty} = \max_i \sum_{j=1}^N |a_{i,j}|
@@ -60,7 +60,7 @@ The supported norms are:
 
 -   **Frobenius Norm** (`norm` = `'frobenius'`): returns the square root of the sum of the squares of all elements in `A`.
 
-<!-- <equation class="equation" label="eq:lu_decomposition" align="center" raw="\|A\|_F = \left(\sum_{i=1}^M \sum_{j=1}^N |a_{i,j}|^2 \right)^{1/2}" alt="Definition of frobenius norm of a matrix."> -->
+<!-- <equation class="equation" label="eq:frobenius_norm" align="center" raw="\|A\|_F = \left(\sum_{i=1}^M \sum_{j=1}^N |a_{i,j}|^2 \right)^{1/2}" alt="Definition of frobenius norm of a matrix."> -->
 
 ```math
 \|A\|_F = \left(\sum_{i=1}^M \sum_{j=1}^N |a_{i,j}|^2 \right)^{1/2}
@@ -107,14 +107,12 @@ var out = dlange( 'row-major', 'frobenius', 3, 4, A, 4, work );
 The function has the following parameters:
 
 -   **order**: storage layout.
--   **norm**: specifies the type of norm to be calculated, should be one of the following: `max`, `one`, `frobenius` or `infinity`.
+-   **norm**: specifies the type of norm to be calculated, should be one of the following: `max`, `one`, `frobenius`, or `infinity`.
 -   **M**: number of rows in `A`.
 -   **N**: number of columns in `A`.
 -   **A**: input [`Float64Array`][mdn-float64array].
 -   **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
--   **work**: [`Float64Array`][mdn-float64array] used as a temporary workspace.
-
-`work` should have `N` indexed elements if calculating the one norm in a row-major layout and `M` indexed elements if calculating the infinity norm in column-major layout, in all other cases it is fine to pass a dummy [`Float64Array`][mdn-float64array].
+-   **work**: [`Float64Array`][mdn-float64array] used as a temporary workspace. When `A` is `row-major` and `norm` is `one`, `work` should have at least `N` indexed elements. When `A` is `column-major` and `norm` is `infinity`, `work` should have at least `M` indexed elements. In all other cases, `work` is not used and can have any number of elements, including zero.
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
 
@@ -170,19 +168,17 @@ var out = dlange.ndarray( 'frobenius', 3, 4, A, 4, 1, 0, work, 1, 0 );
 
 The function has the following additional parameters:
 
--   **norm**: specifies the type of norm to be calculated, should be one of the following: `max`, `one`, `frobenius` or `infinity`.
+-   **norm**: specifies the type of norm to be calculated, should be one of the following: `max`, `one`, `frobenius`, or `infinity`.
 -   **M**: number of rows in `A`.
 -   **N**: number of columns in `A`.
 -   **A**: input [`Float64Array`][mdn-float64array].
 -   **strideA1**: stride of the first dimension of `A`.
 -   **strideA2**: stride of the second dimension of `A`.
 -   **offsetA**: starting index for `A`.
--   **work**: [`Float64Array`][mdn-float64array] used as a temporary workspace
+-   **work**: [`Float64Array`][mdn-float64array] used as a temporary workspace. When `A` is `row-major` and `norm` is `one`, `work` should have at least `N` indexed elements. When `A` is `column-major` and `norm` is `infinity`, `work` should have at least `M` indexed elements. In all other cases, `work` is not used and can have any number of elements, including zero.
 -   **strideWork**: stride length of `work`.
 -   **offsetWork**: starting index of `work`.
 
-`work` should have `N` indexed elements if calculating the one norm in a row-major layout and `M` indexed elements if calculating the infinity norm in column-major layout, in all other cases it is fine to pass a dummy [`Float64Array`][mdn-float64array].
-
 While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,
 
 <!-- eslint-disable max-len -->

lib/node_modules/@stdlib/lapack/base/dlange/docs/types/index.d.ts

@@ -57,7 +57,7 @@ interface Routine {
 	* @param A - input array
 	* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
 	* @param work - temporary workspace array
-	* @returns required norm value
+	* @returns result
 	*
 	* @example
 	* var Float64Array = require( '@stdlib/array/float64' );
@@ -90,7 +90,7 @@ interface Routine {
 	* @param work - temporary workspace array
 	* @param strideWork - stride length of `work`
 	* @param offsetWork - starting index of `work`
-	* @returns required norm value
+	* @returns result
 	*
 	* @example
 	* var Float64Array = require( '@stdlib/array/float64' );
@@ -121,7 +121,7 @@ interface Routine {
 * @param A - input array
 * @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
 * @param work - temporary workspace array
-* @returns required norm value
+* @returns result
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/lapack/base/dlange/lib/base.js

@@ -31,6 +31,11 @@ var sqrt = require( '@stdlib/math/base/special/sqrt' );
 var abs = require( '@stdlib/math/base/special/abs' );
 
 
+// VARIABLES //
+
+var workspace = new Float64Array( 2 );
+
+
 // FUNCTIONS //
 
 /**
@@ -46,7 +51,7 @@ var abs = require( '@stdlib/math/base/special/abs' );
 * @param {Float64Array} work - work array, should have `N` indexed elements if row-major layout is used
 * @param {integer} strideWork - stride length of `work`
 * @param {NonNegativeInteger} offsetWork - starting index of `work`
-* @returns {number} required norm value
+* @returns {number} result
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
@@ -121,7 +126,7 @@ function oneNorm( M, N, A, strideA1, strideA2, offsetA, work, strideWork, offset
 * @param {integer} strideA1 - stride of the first dimension of `A`
 * @param {integer} strideA2 - stride of the second dimension of `A`
 * @param {NonNegativeInteger} offsetA - starting index of `A`
-* @returns {number} required norm value
+* @returns {number} result
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
@@ -183,7 +188,7 @@ function maxAbs( M, N, A, strideA1, strideA2, offsetA ) {
 * @param {Float64Array} work - work array, should have `M` indexed elements if column-major layout is used
 * @param {integer} strideWork - stride length of `work`
 * @param {NonNegativeInteger} offsetWork - starting index of `work`
-* @returns {number} required norm value
+* @returns {number} result
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
@@ -257,26 +262,26 @@ function infinityNorm( M, N, A, strideA1, strideA2, offsetA, work, strideWork, o
 * @param {integer} strideA1 - stride of the first dimension of `A`
 * @param {integer} strideA2 - stride of the second dimension of `A`
 * @param {NonNegativeInteger} offsetA - starting index of `A`
-* @returns {number} required norm value
+* @returns {number} result
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 *
 * var A = new Float64Array( [ 1.0, 4.0, 7.0, 10.0, 2.0, 5.0, 8.0, 11.0, 3.0, 6.0, 9.0, 12.0 ] );
 *
-* var out = frobeniusNorm( 3, 4, A, 4, 1, 0 );
+* var result = frobeniusNorm( 3, 4, A, 4, 1, 0 );
 * // returns ~25.5
 */
 function frobeniusNorm( M, N, A, strideA1, strideA2, offsetA ) {
-	var out;
 	var da0;
 	var da1;
 	var S1;
 	var S2;
 	var ia;
 	var i;
 
-	out = new Float64Array( [ 0.0, 1.0 ] );
+	workspace[ 0 ] = 0.0;
+	workspace[ 1 ] = 1.0;
 
 	if ( isRowMajor( [ strideA1, strideA2 ] ) ) {
 		S1 = M;
@@ -292,11 +297,11 @@ function frobeniusNorm( M, N, A, strideA1, strideA2, offsetA ) {
 
 	ia = offsetA;
 	for ( i = 0; i < S1; i++ ) {
-		dlassq( S2, A, da0, ia, out[ 0 ], out[ 1 ], out, 1, 0 );
+		dlassq( S2, A, da0, ia, workspace[ 0 ], workspace[ 1 ], workspace, 1, 0 ); // eslint-disable-line max-len
 		ia += da1;
 	}
 
-	return out[ 0 ] * sqrt( out[ 1 ] );
+	return workspace[ 0 ] * sqrt( workspace[ 1 ] );
 }
 
 
@@ -323,7 +328,7 @@ function frobeniusNorm( M, N, A, strideA1, strideA2, offsetA ) {
 * @param {Float64Array} work - temporary workspace array
 * @param {integer} strideWork - stride length of `work`
 * @param {NonNegativeInteger} offsetWork - starting index of `work`
-* @returns {number} required norm value
+* @returns {number} result
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
@@ -338,19 +343,15 @@ function dlange( norm, M, N, A, strideA1, strideA2, offsetA, work, strideWork, o
 	if ( min( M, N ) === 0 ) {
 		return 0.0;
 	}
-
 	if ( norm === 'max' ) {
 		return maxAbs( M, N, A, strideA1, strideA2, offsetA );
 	}
-
 	if ( norm === 'one' ) {
 		return oneNorm( M, N, A, strideA1, strideA2, offsetA, work, strideWork, offsetWork ); // eslint-disable-line max-len
 	}
-
 	if ( norm === 'infinity' ) {
 		return infinityNorm( M, N, A, strideA1, strideA2, offsetA, work, strideWork, offsetWork ); // eslint-disable-line max-len
 	}
-
 	if ( norm === 'frobenius' ) {
 		return frobeniusNorm( M, N, A, strideA1, strideA2, offsetA );
 	}

lib/node_modules/@stdlib/lapack/base/dlange/lib/dlange.js

@@ -25,7 +25,7 @@ var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
 var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
 var max = require( '@stdlib/math/base/special/max' );
 var format = require( '@stdlib/string/format' );
-var isOperation = require( './isoperation.js' );
+var isOperation = require( './is_operation.js' );
 var NORMS = require( './norms.json' ).norms;
 var base = require( './base.js' );
 
@@ -53,7 +53,7 @@ var base = require( './base.js' );
 * @throws {TypeError} first argument must be a valid order
 * @throws {TypeError} second argument must be a valid operation
 * @throws {RangeError} sixth argument must be greater than or equal to max(1,N)
-* @returns {number} required norm value
+* @returns {number} result
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );

lib/node_modules/@stdlib/lapack/base/dlange/lib/isoperation.js renamed to lib/node_modules/@stdlib/lapack/base/dlange/lib/is_operation.js

@@ -21,10 +21,6 @@
 // MODULES //
 
 var contains = require( '@stdlib/array/base/assert/contains' ).factory;
-
-
-// VARIABLES //
-
 var NORMS = require( './norms.json' ).norms;
 
 
@@ -33,6 +29,7 @@ var NORMS = require( './norms.json' ).norms;
 /**
 * Tests whether an input value is a supported operation.
 *
+* @private
 * @name isOperation
 * @type {Function}
 * @param {*} v - value to test

lib/node_modules/@stdlib/lapack/base/dlange/lib/ndarray.js

@@ -21,7 +21,7 @@
 // MODULES //
 
 var format = require( '@stdlib/string/format' );
-var isOperation = require( './isoperation.js' );
+var isOperation = require( './is_operation.js' );
 var NORMS = require( './norms.json' ).norms;
 var base = require( './base.js' );
 
@@ -49,7 +49,7 @@ var base = require( './base.js' );
 * @param {integer} strideWork - stride length of `work`
 * @param {NonNegativeInteger} offsetWork - starting index of `work`
 * @throws {TypeError} first argument must be a valid operation
-* @returns {number} required norm value
+* @returns {number} result
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );