docs: update jsdoc

---
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: na
  - 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: Shabareesh Shetty

lib/node_modules/@stdlib/blas/base/dsyr2k/docs/types/index.d.ts

@@ -49,17 +49,16 @@ interface Routine {
 	*
 	* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
 	* var B = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
-	* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+	* var C = new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
 	*
 	* dsyr2k( 'row-major', 'upper', 'no-transpose', 3, 3, 1.0, A, 3, B, 3, 1.0, C, 3 );
-	* // C => <Float64Array>[ 29.0, 66.0, 103.0, 0.0, 158.0, 249.0, 0.0, 0.0, 394.0 ]
+	* // C => <Float64Array>[ 29.0, 66.0, 103.0, 2.0, 158.0, 249.0, 3.0, 5.0, 394.0 ]
 	*/
 	( order: Layout, uplo: MatrixTriangle, trans: TransposeOperation, N: number, K: number, alpha: number, A: Float64Array, LDA: number, B: Float64Array, LDB: number, beta: number, C: Float64Array, LDC: number ): Float64Array;
 
 	/**
 	* Performs one of the symmetric rank `2K` operations `C = α*A*B^T + C = α*B*A^T + β*C` or `C = α*A^T*B + α*B^T*A + β*C`, using alternative indexing semantics and where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` and `B` are `N` by `K` matrices in the first case and `K` by `N` matrices in the second case.
 	*
-	* @param order - storage layout
 	* @param uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
 	* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
 	* @param N - order of the matrix `C`
@@ -69,6 +68,10 @@ interface Routine {
 	* @param strideA1 - stride of the first dimension of `A`
 	* @param strideA2 - stride of the second dimension of `A`
 	* @param offsetA - starting index for `A`
+	* @param B - second matrix
+	* @param strideB1 - stride of the first dimension of `B`
+	* @param strideB2 - stride of the second dimension of `B`
+	* @param offsetB - starting index for `B`
 	* @param beta - scalar constant
 	* @param C - third matrix
 	* @param strideC1 - stride of the first dimension of `C`
@@ -81,10 +84,10 @@ interface Routine {
 	*
 	* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
 	* var B = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
-	* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+	* var C = new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
 	*
-	* dsyr2k( 'upper', 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, B, 3, 1, 0, 1.0, C, 3, 1, 0 );
-	* // C => <Float64Array>[ 29.0, 66.0, 103.0, 0.0, 158.0, 249.0, 0.0, 0.0, 394.0 ]
+	* dsyr2k.ndarray( 'upper', 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, B, 3, 1, 0, 1.0, C, 3, 1, 0 );
+	* // C => <Float64Array>[ 29.0, 66.0, 103.0, 2.0, 158.0, 249.0, 3.0, 5.0, 394.0 ]
 	*/
 	ndarray( uplo: MatrixTriangle, trans: TransposeOperation, N: number, K: number, alpha: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number, B: Float64Array, strideB1: number, strideB2: number, offsetB: number, beta: number, C: Float64Array, strideC1: number, strideC2: number, offsetC: number ): Float64Array;
 }
@@ -112,20 +115,20 @@ interface Routine {
 *
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
 * var B = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
-* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+* var C = new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
 *
 * dsyr2k( 'row-major', 'upper', 'no-transpose', 3, 3, 1.0, A, 3, B, 3, 1.0, C, 3 );
-* // C => <Float64Array>[ 29.0, 66.0, 103.0, 0.0, 158.0, 249.0, 0.0, 0.0, 394.0 ]
+* // C => <Float64Array>[ 29.0, 66.0, 103.0, 2.0, 158.0, 249.0, 3.0, 5.0, 394.0 ]
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 *
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
 * var B = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
-* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+* var C = new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
 *
 * dsyr2k.ndarray( 'upper', 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, B, 3, 1, 0, 1.0, C, 3, 1, 0 );
-* // C => <Float64Array>[ 29.0, 66.0, 103.0, 0.0, 158.0, 249.0, 0.0, 0.0, 394.0 ]
+* // C => <Float64Array>[ 29.0, 66.0, 103.0, 2.0, 158.0, 249.0, 3.0, 5.0, 394.0 ]
 */
 declare var dsyr2k: Routine;
 

lib/node_modules/@stdlib/blas/base/dsyr2k/lib/base.js

@@ -164,10 +164,10 @@ function scal( uplo, N, beta, X, strideX1, strideX2, offsetX ) { // TODO: consid
 // MAIN //
 
 /**
-* Performs one of the symmetric rank `2K` operations `C = α*A*B**T + C = α*B*A**T + β*C` or `C = α*A**T*B + α*B**T*A + β*C` where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` and `B` are `N` by `K` matrices in the first case and `K` by `N` matrices in the second case.
+* Performs one of the symmetric rank `2K` operations `C = α*A*B^T + C = α*B*A^T + β*C` or `C = α*A^T*B + α*B^T*A + β*C` where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` and `B` are `N` by `K` matrices in the first case and `K` by `N` matrices in the second case.
 *
 * @private
-* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
+* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` to be referenced
 * @param {string} trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
 * @param {NonNegativeInteger} N - order of the matrix `C`
 * @param {NonNegativeInteger} K - number of columns or number of rows of the matrices `A` and `B`
@@ -192,10 +192,10 @@ function scal( uplo, N, beta, X, strideX1, strideX2, offsetX ) { // TODO: consid
 *
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
 * var B = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
-* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+* var C = new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
 *
 * dsyr2k( 'upper', 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, B, 3, 1, 0, 1.0, C, 3, 1, 0 );
-* // C => <Float64Array>[ 29.0, 66.0, 103.0, 0.0, 158.0, 249.0, 0.0, 0.0, 394.0 ]
+* // C => <Float64Array>[ 29.0, 66.0, 103.0, 2.0, 158.0, 249.0, 3.0, 5.0, 394.0 ]
 */
 function dsyr2k( uplo, trans, N, K, alpha, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB, beta, C, strideC1, strideC2, offsetC ) {
 	var isrma;

lib/node_modules/@stdlib/blas/base/dsyr2k/lib/dsyr2k.js

@@ -35,7 +35,7 @@ var base = require( './base.js' );
 * Performs one of the symmetric rank `2K` operations `C = α*A*B**T + C = α*B*A**T + β*C` or `C = α*A**T*B + α*B**T*A + β*C` where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` and `B` are `N` by `K` matrices in the first case and `K` by `N` matrices in the second case.
 *
 * @param {string} order - storage layout
-* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
+* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` to be referenced
 * @param {string} trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
 * @param {NonNegativeInteger} N - order of the matrix `C`
 * @param {NonNegativeInteger} K - number of columns or number of rows of the matrices `A` and `B`
@@ -49,7 +49,7 @@ var base = require( './base.js' );
 * @param {PositiveInteger} LDC - stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`)
 * @throws {TypeError} first argument must be a valid order
 * @throws {TypeError} second argument must be a valid side
-* @throws {TypeError} third argument must specify whether the lower or upper triangular matrix is supplied.
+* @throws {TypeError} third argument must specify whether the lower or upper triangular matrix to be referenced.
 * @throws {RangeError} fourth argument must be a nonnegative integer
 * @throws {RangeError} fifth argument must be a nonnegative integer
 * @throws {RangeError} eighth argument must be greater than or equal to max(1,N) when `A` is not transposed and max(1,K) otherwise
@@ -61,10 +61,10 @@ var base = require( './base.js' );
 *
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
 * var B = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
-* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+* var C = new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
 *
 * dsyr2k( 'row-major', 'upper', 'no-transpose', 3, 3, 1.0, A, 3, B, 3, 1.0, C, 3 );
-* // C => <Float64Array>[ 29.0, 66.0, 103.0, 0.0, 158.0, 249.0, 0.0, 0.0, 394.0 ]
+* // C => <Float64Array>[ 29.0, 66.0, 103.0, 2.0, 158.0, 249.0, 3.0, 5.0, 394.0 ]
 */
 function dsyr2k( order, uplo, trans, N, K, alpha, A, LDA, B, LDB, beta, C, LDC ) { // eslint-disable-line max-params
 	var nrowsa;
@@ -80,7 +80,7 @@ function dsyr2k( order, uplo, trans, N, K, alpha, A, LDA, B, LDB, beta, C, LDC )
 		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
 	}
 	if ( !isMatrixTriangle( uplo ) ) {
-		throw new TypeError( format( 'invalid argument. Second argument must specify whether the lower or upper triangular matrix is supplied. Value: `%s`.', uplo ) );
+		throw new TypeError( format( 'invalid argument. Second argument must specify whether the lower or upper triangular matrix to be referenced. Value: `%s`.', uplo ) );
 	}
 	if ( !isMatrixTranspose( trans ) ) {
 		throw new TypeError( format( 'invalid argument. Third argument must be a valid transpose operation. Value: `%s`.', trans ) );

lib/node_modules/@stdlib/blas/base/dsyr2k/lib/index.js

@@ -29,21 +29,21 @@
 *
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
 * var B = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
-* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+* var C = new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
 *
 * dsyr2k( 'row-major', 'upper', 'no-transpose', 3, 3, 1.0, A, 3, B, 3, 1.0, C, 3 );
-* // C => <Float64Array>[ 29.0, 66.0, 103.0, 0.0, 158.0, 249.0, 0.0, 0.0, 394.0 ]
+* // C => <Float64Array>[ 29.0, 66.0, 103.0, 2.0, 158.0, 249.0, 3.0, 5.0, 394.0 ]
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 * var dsyr2k = require( '@stdlib/blas/base/dsyr2k' );
 *
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
 * var B = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
-* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+* var C = new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
 *
 * dsyr2k.ndarray( 'upper', 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, B, 3, 1, 0, 1.0, C, 3, 1, 0 );
-* // C => <Float64Array>[ 29.0, 66.0, 103.0, 0.0, 158.0, 249.0, 0.0, 0.0, 394.0 ]
+* // C => <Float64Array>[ 29.0, 66.0, 103.0, 2.0, 158.0, 249.0, 3.0, 5.0, 394.0 ]
 */
 
 // MODULES //

lib/node_modules/@stdlib/blas/base/dsyr2k/lib/ndarray.js

@@ -32,7 +32,7 @@ var base = require( './base.js' );
 * Performs one of the symmetric rank `2K` operations `C = α*A*B**T + C = α*B*A**T + β*C` or `C = α*A**T*B + α*B**T*A + β*C` where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` and `B` are `N` by `K` matrices in the first case and `K` by `N` matrices in the second case.
 *
 * @private
-* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
+* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` to be referenced
 * @param {string} trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
 * @param {NonNegativeInteger} N - order of the matrix `C`
 * @param {NonNegativeInteger} K - number of columns or number of rows of the matrices `A` and `B`
@@ -51,7 +51,7 @@ var base = require( './base.js' );
 * @param {integer} strideC2 - stride of the second dimension of `C`
 * @param {NonNegativeInteger} offsetC - starting index for `C`
 * @throws {TypeError} first argument must be a valid side
-* @throws {TypeError} second argument must specify whether the lower or upper triangular matrix is supplied.
+* @throws {TypeError} second argument must specify whether the lower or upper triangular matrix to be referenced.
 * @throws {RangeError} third argument must be a nonnegative integer
 * @throws {RangeError} fourth argument must be a nonnegative integer
 * @throws {RangeError} sixteenth argument must be non-zero
@@ -62,14 +62,14 @@ var base = require( './base.js' );
 *
 * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
 * var B = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
-* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
+* var C = new Float64Array( [ 1.0, 2.0, 3.0, 2.0, 4.0, 5.0, 3.0, 5.0, 6.0 ] );
 *
 * dsyr2k( 'upper', 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, B, 3, 1, 0, 1.0, C, 3, 1, 0 );
-* // C => <Float64Array>[ 29.0, 66.0, 103.0, 0.0, 158.0, 249.0, 0.0, 0.0, 394.0 ]
+* // C => <Float64Array>[ 29.0, 66.0, 103.0, 2.0, 158.0, 249.0, 3.0, 5.0, 394.0 ]
 */
 function dsyr2k( uplo, trans, N, K, alpha, A, strideA1, strideA2, offsetA, B, strideB1, strideB2, offsetB, beta, C, strideC1, strideC2, offsetC ) { // eslint-disable-line max-params, max-len
 	if ( !isMatrixTriangle( uplo ) ) {
-		throw new TypeError( format( 'invalid argument. First argument must specify whether the lower or upper triangular matrix is supplied. Value: `%s`.', uplo ) );
+		throw new TypeError( format( 'invalid argument. First argument must specify whether the lower or upper triangular matrix to be referenced. Value: `%s`.', uplo ) );
 	}
 	if ( !isMatrixTranspose( trans ) ) {
 		throw new TypeError( format( 'invalid argument. Second argument must be a valid transpose operation. Value: `%s`.', trans ) );