Skip to content

Commit 9cea5f5

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
docs: update types and repl
--- 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: passed - 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 03295f9 commit 9cea5f5

File tree

3 files changed

+25
-25
lines changed

3 files changed

+25
-25
lines changed

lib/node_modules/@stdlib/blas/base/dtbmv/docs/repl.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
{{alias}}( ord, uplo, trans, diag, N, K, A, lda, x, sx )
2+
{{alias}}( order, uplo, trans, diag, N, K, A, lda, x, sx )
33
Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x` where
44
`x` is an `N` element vector and `A` is an `N` by `N` unit, or non-unit,
55
upper or lower triangular band matrix, with ( `K` + 1 ) diagonals.
@@ -11,7 +11,7 @@
1111

1212
Parameters
1313
----------
14-
ord: string
14+
order: string
1515
Row-major (C-style) or column-major (Fortran-style) order. Must be
1616
either 'row-major' or 'column-major'.
1717

@@ -42,7 +42,7 @@
4242
Input vector.
4343

4444
sx: integer
45-
Index increment for `x`.
45+
Stride length for `x`.
4646

4747
Returns
4848
-------
@@ -104,7 +104,7 @@
104104
Input vector.
105105

106106
sx: integer
107-
Index increment for `x`.
107+
Stride length for `x`.
108108

109109
ox: integer
110110
Starting index for `x`.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ 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
@@ -65,7 +65,7 @@ interface Routine {
6565
* @param strideA2 - stride of the second 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
*
@@ -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/dtbmv/docs/types/test.ts

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,14 @@ import dtbmv = require( './index' );
7979
const x = new Float64Array( 10 );
8080
const A = new Float64Array( 20 );
8181

82-
dtbmv( 'row-major', 'upper', 'no-transpose', 10, 10, A, 10, x, 1 ); // $ExpectError
83-
dtbmv( 'row-major', 'upper', 'no-transpose', true, 10, A, 10, x, 1 ); // $ExpectError
84-
dtbmv( 'row-major', 'upper', 'no-transpose', false, 10, A, 10, x, 1 ); // $ExpectError
85-
dtbmv( 'row-major', 'upper', 'no-transpose', null, 10, A, 10, x, 1 ); // $ExpectError
86-
dtbmv( 'row-major', 'upper', 'no-transpose', undefined, 10, A, 10, x, 1 ); // $ExpectError
87-
dtbmv( 'row-major', 'upper', 'no-transpose', [], 10, A, 10, x, 1 ); // $ExpectError
88-
dtbmv( 'row-major', 'upper', 'no-transpose', {}, 10, A, 10, x, 1 ); // $ExpectError
89-
dtbmv( 'row-major', 'upper', 'no-transpose', ( x: number ): number => x, 10, A, 10, x, 1 ); // $ExpectError
82+
dtbmv( 'row-major', 'upper', 'no-transpose', 10, 10, 10, A, 10, x, 1 ); // $ExpectError
83+
dtbmv( 'row-major', 'upper', 'no-transpose', true, 10, 10, A, 10, x, 1 ); // $ExpectError
84+
dtbmv( 'row-major', 'upper', 'no-transpose', false, 10, 10, A, 10, x, 1 ); // $ExpectError
85+
dtbmv( 'row-major', 'upper', 'no-transpose', null, 10, 10, A, 10, x, 1 ); // $ExpectError
86+
dtbmv( 'row-major', 'upper', 'no-transpose', undefined, 10, 10, A, 10, x, 1 ); // $ExpectError
87+
dtbmv( 'row-major', 'upper', 'no-transpose', [], 10, 10, A, 10, x, 1 ); // $ExpectError
88+
dtbmv( 'row-major', 'upper', 'no-transpose', {}, 10, 10, A, 10, x, 1 ); // $ExpectError
89+
dtbmv( 'row-major', 'upper', 'no-transpose', ( x: number ): number => x, 10, 10, A, 10, x, 1 ); // $ExpectError
9090
}
9191

9292
// The compiler throws an error if the function is provided a fifth argument which is not a number...
@@ -134,7 +134,7 @@ import dtbmv = require( './index' );
134134
dtbmv( '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 );
@@ -149,7 +149,7 @@ import dtbmv = require( './index' );
149149
dtbmv( 'row-major', 'upper', 'no-transpose', 'unit', 10, 10, A, ( x: number ): number => x, x, 1 ); // $ExpectError
150150
}
151151

152-
// The compiler throws an error if the function is provided an ninth argument which is not a Float64Array...
152+
// The compiler throws an error if the function is provided a ninth argument which is not a Float64Array...
153153
{
154154
const A = new Float64Array( 20 );
155155

@@ -240,14 +240,14 @@ import dtbmv = require( './index' );
240240
const x = new Float64Array( 10 );
241241
const A = new Float64Array( 20 );
242242

243-
dtbmv.ndarray( 'upper', 'no-transpose', 10, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
244-
dtbmv.ndarray( 'upper', 'no-transpose', true, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
245-
dtbmv.ndarray( 'upper', 'no-transpose', false, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
246-
dtbmv.ndarray( 'upper', 'no-transpose', null, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
247-
dtbmv.ndarray( 'upper', 'no-transpose', undefined, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
248-
dtbmv.ndarray( 'upper', 'no-transpose', [], 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
249-
dtbmv.ndarray( 'upper', 'no-transpose', {}, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
250-
dtbmv.ndarray( 'upper', 'no-transpose', ( x: number ): number => x, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
243+
dtbmv.ndarray( 'upper', 'no-transpose', 10, 10, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
244+
dtbmv.ndarray( 'upper', 'no-transpose', true, 10, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
245+
dtbmv.ndarray( 'upper', 'no-transpose', false, 10, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
246+
dtbmv.ndarray( 'upper', 'no-transpose', null, 10, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
247+
dtbmv.ndarray( 'upper', 'no-transpose', undefined, 10, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
248+
dtbmv.ndarray( 'upper', 'no-transpose', [], 10, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
249+
dtbmv.ndarray( 'upper', 'no-transpose', {}, 10, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
250+
dtbmv.ndarray( 'upper', 'no-transpose', ( x: number ): number => x, 10, 10, A, 10, 1, 0, x, 1, 0 ); // $ExpectError
251251
}
252252

253253
// The compiler throws an error if the function is provided a fourth argument which is not a number...

0 commit comments

Comments
 (0)