chore: minor clean-up

Planeshifter · Planeshifter · commit 08f9c1af6dee · 2024-09-27T20:43:21.000-04:00
diff --git a/lib/node_modules/@stdlib/blas/base/cscal/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/cscal/docs/types/test.ts
@@ -36,7 +36,7 @@ import cscal = require( './index' );
 	const cx = new Complex64Array( 10 );
 	const ca = new Complex64( 2.0, 2.0 );
 
-	cscal( '10', ca, cx, 1 ); // $EcxpectError
+	cscal( '10', ca, cx, 1 ); // $ExpectError
 	cscal( true, ca, cx, 1 ); // $ExpectError
 	cscal( false, ca, cx, 1 ); // $ExpectError
 	cscal( null, ca, cx, 1 ); // $ExpectError
diff --git a/lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts
@@ -1114,7 +1114,7 @@ interface Namespace {
 	* @returns result
 	*
 	* @example
-	* var Complex64 = require( '@stdlib/complex/float3/ctor' );
+	* var Complex64 = require( '@stdlib/complex/float32/ctor' );
 	*
 	* var v = ns.scabs1( new Complex64( 5.0, -3.0 ) );
 	* // returns 8.0
diff --git a/lib/node_modules/@stdlib/blas/base/drotg/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/drotg/docs/types/index.d.ts
@@ -19,7 +19,7 @@
 // TypeScript Version: 4.1
 
 /**
-* Inteface describing `drotg`.
+* Interface describing `drotg`.
 */
 interface Routine {
 	/**
diff --git a/lib/node_modules/@stdlib/blas/base/dtrmv/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/dtrmv/docs/types/index.d.ts
@@ -46,7 +46,7 @@ interface Routine {
 	* var A = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] );
 	* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
 	*
-	* dtrmv( row-major', 'upper', 'no-transpose', 'non-unit', 3, A, 3, x, 1 );
+	* dtrmv( 'row-major', 'upper', 'no-transpose', 'non-unit', 3, A, 3, x, 1 );
 	* // x => <Float64Array>[ 14.0, 8.0, 3.0 ]
 	*/
 	( order: Layout, uplo: MatrixTriangle, trans: TransposeOperation, diag: DiagonalType, N: number, A: Float64Array, LDA: number, x: Float64Array, strideX: number ): Float64Array;
@@ -60,7 +60,7 @@ interface Routine {
 	* @param N - number of elements along each dimension in the matrix `A`
 	* @param A - input matrix
 	* @param strideA1 - stride of the first dimension of `A`
-	* @param strideA2 - stride of the first dimension of `A`
+	* @param strideA2 - stride of the second dimension of `A`
 	* @param offsetA - starting index for `A`
 	* @param x - input vector
 	* @param strideX - `x` stride length
diff --git a/lib/node_modules/@stdlib/blas/base/scabs1/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/scabs1/docs/types/index.d.ts
@@ -29,7 +29,7 @@ import { Complex64 } from '@stdlib/types/complex';
 * @returns result
 *
 * @example
-* var Complex64 = require( '@stdlib/complex/float3/ctor' );
+* var Complex64 = require( '@stdlib/complex/float32/ctor' );
 *
 * var v = scabs1( new Complex64( 5.0, -3.0 ) );
 * // returns 8.0
diff --git a/lib/node_modules/@stdlib/blas/base/sgemv/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/sgemv/docs/types/index.d.ts
@@ -112,7 +112,7 @@ interface Routine {
 * var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 * var y = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 *
-* sgemv( 'row-major', 'no-transpose', 3, 3, 1.0, A, 3, x1, -1, 1.0, y1, -1 );
+* sgemv( 'row-major', 'no-transpose', 3, 3, 1.0, A, 3, x, -1, 1.0, y, -1 );
 * // y => <Float32Array>[ 25.0, 16.0, 7.0 ]
 *
 * @example
@@ -122,7 +122,7 @@ interface Routine {
 * var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 * var y = new Float32Array( [ 1.0, 1.0, 1.0 ] );
 *
-* sgemv.ndarray( 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, x1, -1, 2, 1.0, y1, -1, 2 );
+* sgemv.ndarray( 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, x, -1, 2, 1.0, y, -1, 2 );
 * // y => <Float32Array>[ 25.0, 16.0, 7.0 ]
 */
 declare var sgemv: Routine;
diff --git a/lib/node_modules/@stdlib/blas/base/strmv/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/strmv/docs/types/index.d.ts
@@ -46,7 +46,7 @@ interface Routine {
 	* var A = new Float32Array( [ 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 ] );
 	* var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
 	*
-	* strmv( row-major', 'upper', 'no-transpose', 'non-unit', 3, A, 3, x, 1 );
+	* strmv( 'row-major', 'upper', 'no-transpose', 'non-unit', 3, A, 3, x, 1 );
 	* // x => <Float32Array>[ 14.0, 8.0, 3.0 ]
 	*/
 	( order: Layout, uplo: MatrixTriangle, trans: TransposeOperation, diag: DiagonalType, N: number, A: Float32Array, LDA: number, x: Float32Array, strideX: number ): Float32Array;
@@ -60,7 +60,7 @@ interface Routine {
 	* @param N - number of elements along each dimension in the matrix `A`
 	* @param A - input matrix
 	* @param strideA1 - stride of the first dimension of `A`
-	* @param strideA2 - stride of the first dimension of `A`
+	* @param strideA2 - stride of the second dimension of `A`
 	* @param offsetA - starting index for `A`
 	* @param x - input vector
 	* @param strideX - `x` stride length
diff --git a/lib/node_modules/@stdlib/blas/base/zdrot/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/zdrot/docs/types/test.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-import Complex128Array = require( '@stdlib/array/complex64' );
+import Complex128Array = require( '@stdlib/array/complex128' );
 import zdrot = require( './index' );
 
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/dasumpw/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dasumpw/docs/types/index.d.ts
@@ -36,7 +36,7 @@ interface Routine {
 	* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 	*
 	* var v = dasumpw( x.length, x, 1 );
-	* // returns 1.0
+	* // returns 5.0
 	*/
 	( N: number, x: Float64Array, strideX: number ): number;
 
@@ -55,7 +55,7 @@ interface Routine {
 	* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 	*
 	* var v = dasumpw.ndarray( x.length, x, 1, 0 );
-	* // returns 1.0
+	* // returns 5.0
 	*/
 	ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number;
 }
@@ -74,15 +74,15 @@ interface Routine {
 * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 *
 * var v = dasumpw( x.length, x, 1 );
-* // returns 1.0
+* // returns 5.0
 *
 * @example
 * var Float64Array = require( '@stdlib/array/float64' );
 *
 * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
 *
 * var v = dasumpw.ndarray( x.length, x, 1, 0 );
-* // returns 1.0
+* // returns 5.0
 */
 declare var dasumpw: Routine;
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/gasumpw/docs/types/index.d.ts
@@ -38,7 +38,7 @@ interface Routine {
 	* var x = [ 1.0, -2.0, 2.0 ];
 	*
 	* var v = gasumpw( x.length, x, 1 );
-	* // returns 1.0
+	* // returns 5.0
 	*/
 	( N: number, x: NumericArray, stride: number ): number;
 
@@ -55,7 +55,7 @@ interface Routine {
 	* var x = [ 1.0, -2.0, 2.0 ];
 	*
 	* var v = gasumpw.ndarray( x.length, x, 1, 0 );
-	* // returns 1.0
+	* // returns 5.0
 	*/
 	ndarray( N: number, x: NumericArray, stride: number, offset: number ): number;
 }
@@ -72,13 +72,13 @@ interface Routine {
 * var x = [ 1.0, -2.0, 2.0 ];
 *
 * var v = gasumpw( x.length, x, 1 );
-* // returns 1.0
+* // returns 5.0
 *
 * @example
 * var x = [ 1.0, -2.0, 2.0 ];
 *
 * var v = gasumpw.ndarray( x.length, x, 1, 0 );
-* // returns 1.0
+* // returns 5.0
 */
 declare var gasumpw: Routine;
 
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sasumpw/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/sasumpw/docs/types/index.d.ts
@@ -36,7 +36,7 @@ interface Routine {
 	* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
 	*
 	* var v = sasumpw( x.length, x, 1 );
-	* // returns 1.0
+	* // returns 5.0
 	*/
 	( N: number, x: Float32Array, stride: number ): number;
 
@@ -55,7 +55,7 @@ interface Routine {
 	* var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
 	*
 	* var v = sasumpw.ndarray( x.length, x, 1, 0 );
-	* // returns 1.0
+	* // returns 5.0
 	*/
 	ndarray( N: number, x: Float32Array, stride: number, offset: number ): number;
 }
@@ -74,15 +74,15 @@ interface Routine {
 * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
 *
 * var v = sasumpw( x.length, x, 1 );
-* // returns 1.0
+* // returns 5.0
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
 *
 * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
 *
 * var v = sasumpw.ndarray( x.length, x, 1, 0 );
-* // returns 1.0
+* // returns 5.0
 */
 declare var sasumpw: Routine;
 
diff --git a/lib/node_modules/@stdlib/iter/cunone-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/cunone-by/docs/types/index.d.ts
@@ -94,4 +94,4 @@ declare function iterCuNoneBy<T, U>( iterator: Iterator<T>, predicate: Predicate
 
 // EXPORTS //
 
-export = iterCuNoneBy ;
+export = iterCuNoneBy;
diff --git a/lib/node_modules/@stdlib/iter/datespace/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/datespace/docs/types/index.d.ts
@@ -65,7 +65,7 @@ interface Options {
 * // returns <Date>
 *
 * v = iter.next().value;
-* // returns 2
+* // returns <Date>
 *
 * // ...
 */
diff --git a/lib/node_modules/@stdlib/iter/pipeline-thunk/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/pipeline-thunk/docs/types/index.d.ts
@@ -39,7 +39,7 @@ type IteratorFunction = ( iterator: Iterator, ...args: Array<any> ) => any;
 *
 * @param iter - input iterator
 * @throws must provide an iterator
-* @returns iterator function result`
+* @returns iterator function result
 */
 type IteratorThunk = ( iter: Iterator ) => any;
 
diff --git a/lib/node_modules/@stdlib/iter/unique-by-hash/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/unique-by-hash/docs/types/index.d.ts
@@ -65,7 +65,8 @@ type HashFunction = ( value?: any ) => any;
 * v = iter.next().value;
 * // returns 4
 *
-* var bool = iter.ne
+* var bool = iter.next().done;
+* // returns true
 */
 declare function iterUniqueByHash( iterator: Iterator, hashFcn: HashFunction, thisArg?: any ): Iterator;
 
diff --git a/lib/node_modules/@stdlib/lapack/base/dpttrf/docs/types/test.ts b/lib/node_modules/@stdlib/lapack/base/dpttrf/docs/types/test.ts
@@ -22,7 +22,7 @@ import dpttrf = require( './index' );
 
 // TESTS //
 
-// The function returns a Float64Array...
+// The function returns a number...
 {
 	const D = new Float64Array( 3 );
 	const E = new Float64Array( 2 );
diff --git a/lib/node_modules/@stdlib/lapack/base/spttrf/docs/types/test.ts b/lib/node_modules/@stdlib/lapack/base/spttrf/docs/types/test.ts
@@ -22,7 +22,7 @@ import spttrf = require( './index' );
 
 // TESTS //
 
-// The function returns a Float32Array...
+// The function returns a number...
 {
 	const D = new Float32Array( 3 );
 	const E = new Float32Array( 2 );
diff --git a/lib/node_modules/@stdlib/math/base/special/sincospi/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/sincospi/docs/types/index.d.ts
@@ -23,7 +23,7 @@
 import { Collection } from '@stdlib/types/array';
 
 /**
- * Inteface describing `sincospi`.
+ * Interface describing `sincospi`.
  */
 interface SinCosPi {
 	/**
diff --git a/lib/node_modules/@stdlib/nlp/lda/docs/types/index.d.ts b/lib/node_modules/@stdlib/nlp/lda/docs/types/index.d.ts
@@ -76,7 +76,7 @@ interface Model {
 * @param documents - document corpus
 * @param K - number of topics
 * @param options - options object
-* @param options.alpha - Dirichlet hyper-parameter of topic vector theta:
+* @param options.alpha - Dirichlet hyper-parameter of topic vector theta
 * @param options.beta - Dirichlet hyper-parameter for word vector phi
 * @throws second argument must be a positive integer
 * @throws must provide valid options
diff --git a/lib/node_modules/@stdlib/nlp/lda/docs/types/test.ts b/lib/node_modules/@stdlib/nlp/lda/docs/types/test.ts
@@ -24,20 +24,20 @@ import lda = require( './index' );
 // The function returns a model object...
 {
 	const arr = [ 'beep', 'boop' ];
-	lda( arr, 2 ); // #ExpectType Model
+	lda( arr, 2 ); // $ExpectType Model
 }
 
 // The returned model object has a `fit` method to fit a model...
 {
 	const arr = [ 'beep', 'boop' ];
-	const model = lda( arr, 2 ); // #ExpectType Model
+	const model = lda( arr, 2 ); // $ExpectType Model
 	model.fit( 1000, 100, 10 );
 }
 
 // The `fit` method of the returned model does not compile if not called with three number arguments...
 {
 	const arr = [ 'beep', 'boop' ];
-	const model = lda( arr, 2 ); // #ExpectType Model
+	const model = lda( arr, 2 ); // $ExpectType Model
 	model.fit( false, 100, 10 ); // $ExpectError
 	model.fit( true, 100, 10 ); // $ExpectError
 	model.fit( 'abc', 100, 10 ); // $ExpectError
@@ -66,16 +66,16 @@ import lda = require( './index' );
 // The returned model object has a `getTerms` method to retrieve an array of terms...
 {
 	const arr = [ 'beep', 'boop' ];
-	const model = lda( arr, 2 ); // #ExpectType Model
+	const model = lda( arr, 2 ); // $ExpectType Model
 	model.fit( 1000, 100, 10 );
-	model.getTerms( 2, 10 ); // #ExpectType Term[]
-	model.getTerms( 2 ); // #ExpectType Term[]
+	model.getTerms( 2, 10 ); // $ExpectType Term[]
+	model.getTerms( 2 ); // $ExpectType Term[]
 }
 
 // The `getTerms` method of the returned model does not compile if not called with number arguments...
 {
 	const arr = [ 'beep', 'boop' ];
-	const model = lda( arr, 2 ); // #ExpectType Model
+	const model = lda( arr, 2 ); // $ExpectType Model
 	model.getTerms( false, 10 ); // $ExpectError
 	model.getTerms( true, 10 ); // $ExpectError
 	model.getTerms( 'abc', 10 ); // $ExpectError

Original file line number	Diff line number	Diff line change
`@@ -1114,7 +1114,7 @@ interface Namespace {`
`1114`	`1114`	`* @returns result`
`1115`	`1115`	`*`
`1116`	`1116`	`* @example`
`1117`		`- * var Complex64 = require( '@stdlib/complex/float3/ctor' );`
	`1117`	`+ * var Complex64 = require( '@stdlib/complex/float32/ctor' );`
`1118`	`1118`	`*`
`1119`	`1119`	`* var v = ns.scabs1( new Complex64( 5.0, -3.0 ) );`
`1120`	`1120`	`* // returns 8.0`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ import { Complex64 } from '@stdlib/types/complex';`
`29`	`29`	`* @returns result`
`30`	`30`	`*`
`31`	`31`	`* @example`
`32`		`-* var Complex64 = require( '@stdlib/complex/float3/ctor' );`
	`32`	`+* var Complex64 = require( '@stdlib/complex/float32/ctor' );`
`33`	`33`	`*`
`34`	`34`	`* var v = scabs1( new Complex64( 5.0, -3.0 ) );`
`35`	`35`	`* // returns 8.0`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ interface Routine {`
`112`	`112`	`* var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );`
`113`	`113`	`* var y = new Float32Array( [ 1.0, 1.0, 1.0 ] );`
`114`	`114`	`*`
`115`		`-* sgemv( 'row-major', 'no-transpose', 3, 3, 1.0, A, 3, x1, -1, 1.0, y1, -1 );`
	`115`	`+* sgemv( 'row-major', 'no-transpose', 3, 3, 1.0, A, 3, x, -1, 1.0, y, -1 );`
`116`	`116`	`* // y => <Float32Array>[ 25.0, 16.0, 7.0 ]`
`117`	`117`	`*`
`118`	`118`	`* @example`
`@@ -122,7 +122,7 @@ interface Routine {`
`122`	`122`	`* var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );`
`123`	`123`	`* var y = new Float32Array( [ 1.0, 1.0, 1.0 ] );`
`124`	`124`	`*`
`125`		`-* sgemv.ndarray( 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, x1, -1, 2, 1.0, y1, -1, 2 );`
	`125`	`+* sgemv.ndarray( 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, x, -1, 2, 1.0, y, -1, 2 );`
`126`	`126`	`* // y => <Float32Array>[ 25.0, 16.0, 7.0 ]`
`127`	`127`	`*/`
`128`	`128`	`declare var sgemv: Routine;`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ interface Routine {`
`36`	`36`	`* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );`
`37`	`37`	`*`
`38`	`38`	`* var v = dasumpw( x.length, x, 1 );`
`39`		`- * // returns 1.0`
	`39`	`+ * // returns 5.0`
`40`	`40`	`*/`
`41`	`41`	`( N: number, x: Float64Array, strideX: number ): number;`
`42`	`42`
`@@ -55,7 +55,7 @@ interface Routine {`
`55`	`55`	`* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );`
`56`	`56`	`*`
`57`	`57`	`* var v = dasumpw.ndarray( x.length, x, 1, 0 );`
`58`		`- * // returns 1.0`
	`58`	`+ * // returns 5.0`
`59`	`59`	`*/`
`60`	`60`	`ndarray( N: number, x: Float64Array, strideX: number, offsetX: number ): number;`
`61`	`61`	`}`
`@@ -74,15 +74,15 @@ interface Routine {`
`74`	`74`	`* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );`
`75`	`75`	`*`
`76`	`76`	`* var v = dasumpw( x.length, x, 1 );`
`77`		`-* // returns 1.0`
	`77`	`+* // returns 5.0`
`78`	`78`	`*`
`79`	`79`	`* @example`
`80`	`80`	`* var Float64Array = require( '@stdlib/array/float64' );`
`81`	`81`	`*`
`82`	`82`	`* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );`
`83`	`83`	`*`
`84`	`84`	`* var v = dasumpw.ndarray( x.length, x, 1, 0 );`
`85`		`-* // returns 1.0`
	`85`	`+* // returns 5.0`
`86`	`86`	`*/`
`87`	`87`	`declare var dasumpw: Routine;`
`88`	`88`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ interface Routine {`
`38`	`38`	`* var x = [ 1.0, -2.0, 2.0 ];`
`39`	`39`	`*`
`40`	`40`	`* var v = gasumpw( x.length, x, 1 );`
`41`		`- * // returns 1.0`
	`41`	`+ * // returns 5.0`
`42`	`42`	`*/`
`43`	`43`	`( N: number, x: NumericArray, stride: number ): number;`
`44`	`44`
`@@ -55,7 +55,7 @@ interface Routine {`
`55`	`55`	`* var x = [ 1.0, -2.0, 2.0 ];`
`56`	`56`	`*`
`57`	`57`	`* var v = gasumpw.ndarray( x.length, x, 1, 0 );`
`58`		`- * // returns 1.0`
	`58`	`+ * // returns 5.0`
`59`	`59`	`*/`
`60`	`60`	`ndarray( N: number, x: NumericArray, stride: number, offset: number ): number;`
`61`	`61`	`}`
`@@ -72,13 +72,13 @@ interface Routine {`
`72`	`72`	`* var x = [ 1.0, -2.0, 2.0 ];`
`73`	`73`	`*`
`74`	`74`	`* var v = gasumpw( x.length, x, 1 );`
`75`		`-* // returns 1.0`
	`75`	`+* // returns 5.0`
`76`	`76`	`*`
`77`	`77`	`* @example`
`78`	`78`	`* var x = [ 1.0, -2.0, 2.0 ];`
`79`	`79`	`*`
`80`	`80`	`* var v = gasumpw.ndarray( x.length, x, 1, 0 );`
`81`		`-* // returns 1.0`
	`81`	`+* // returns 5.0`
`82`	`82`	`*/`
`83`	`83`	`declare var gasumpw: Routine;`
`84`	`84`