Skip to content

Commit 929a295

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
docs: update types
--- 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: na - 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: passed - task: lint_license_headers status: passed ---
1 parent 561ba67 commit 929a295

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ interface Routine {
3838
* @param A - input matrix
3939
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
4040
* @param x - input vector
41-
* @param strideX - `x` stride length
41+
* @param strideX - stride length for `x`
4242
* @returns `x`
4343
*
4444
* @example
4545
* var Float64Array = require( '@stdlib/array/float64' );
4646
*
47-
* var A = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] ); // => [ [ 1.0, 4.0, 0.0 ], [ 0.0, 2.0, 5.0 ], [ 0.0, 0.0, 3.0 ] ]
47+
* var A = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] ); // => [ [ 3.0, 1.0, 0.0 ], [ 0.0, 4.0, 2.0 ], [ 0.0, 0.0, 5.0 ] ]
4848
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
4949
*
5050
* dtbsv( 'row-major', 'upper', 'no-transpose', 'unit', 3, A, 2, x, 1 );
@@ -65,7 +65,7 @@ interface Routine {
6565
* @param strideA2 - stride of the first dimension of `A`
6666
* @param offsetA - starting index for `A`
6767
* @param x - input vector
68-
* @param strideX - `x` stride length
68+
* @param strideX - stride length for `x`
6969
* @param offsetX - starting index for `x`
7070
* @returns `x`
7171
*
@@ -75,7 +75,7 @@ interface Routine {
7575
* var A = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 ] );
7676
* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
7777
*
78-
* dtbsv.ndarray( 'upper', 'no-transpose', 'unit', 3, 1, A, 2, 1, 0, x, 1, 0 ); // => [ [ 1.0, 4.0, 0.0 ], [ 0.0, 2.0, 5.0 ], [ 0.0, 0.0, 3.0 ] ]
78+
* dtbsv.ndarray( 'upper', 'no-transpose', 'unit', 3, 1, A, 2, 1, 0, x, 1, 0 ); // => [ [ 3.0, 1.0, 0.0 ], [ 0.0, 4.0, 2.0 ], [ 0.0, 0.0, 5.0 ] ]
7979
* // x => <Float64Array>[ 8.0, -7.0, 3.0 ]
8080
*/
8181
ndarray( uplo: MatrixTriangle, trans: TransposeOperation, diag: DiagonalType, N: number, K: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number, x: Float64Array, strideX: number, offsetX: number ): Float64Array;
@@ -93,7 +93,7 @@ interface Routine {
9393
* @param A - input matrix
9494
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
9595
* @param x - input vector
96-
* @param strideX - `x` stride length
96+
* @param strideX - stride length for `x`
9797
* @returns `x`
9898
*
9999
* @example

lib/node_modules/@stdlib/blas/base/dtbsv/docs/types/test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ import dtbsv = require( './index' );
134134
dtbsv( 'row-major', 'upper', 'no-transpose', 'unit', 10, 10, ( x: number ): number => x, 10, x, 1 ); // $ExpectError
135135
}
136136

137-
// The compiler throws an error if the function is provided a eighth argument which is not a number...
137+
// The compiler throws an error if the function is provided an eighth argument which is not a number...
138138
{
139139
const x = new Float64Array( 10 );
140140
const A = new Float64Array( 20 );
@@ -310,7 +310,7 @@ import dtbsv = require( './index' );
310310
dtbsv.ndarray( 'upper', 'no-transpose', 'unit', 10, 10, A, ( x: number ): number => x, 1, 0, x, 1, 0 ); // $ExpectError
311311
}
312312

313-
// The compiler throws an error if the function is provided a eighth argument which is not a number...
313+
// The compiler throws an error if the function is provided an eighth argument which is not a number...
314314
{
315315
const x = new Float64Array( 10 );
316316
const A = new Float64Array( 20 );
@@ -355,7 +355,7 @@ import dtbsv = require( './index' );
355355
dtbsv.ndarray( 'upper', 'no-transpose', 'unit', 10, 10, A, 10, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError
356356
}
357357

358-
// The compiler throws an error if the function is provided a eleventh argument which is not a number...
358+
// The compiler throws an error if the function is provided an eleventh argument which is not a number...
359359
{
360360
const x = new Float64Array( 10 );
361361
const A = new Float64Array( 20 );

0 commit comments

Comments
 (0)