Skip to content

Commit a62eb37

Browse files
committed
chore: clean up in docs
--- 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: passed - 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 30b7d83 commit a62eb37

4 files changed

Lines changed: 15 additions & 17 deletions

File tree

lib/node_modules/@stdlib/blas/base/ctrsv/benchmark/benchmark.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,12 @@ function createBenchmark( N ) {
7474
b.tic();
7575
for ( i = 0; i < b.iterations; i++ ) {
7676
z = ctrsv( 'row-major', 'upper', 'transpose', 'non-unit', N, A, N, x, 1 );
77-
if ( isnanf( z[ i % ( z.length ) ] ) ) {
77+
if ( isnanf( z[ i%z.length ] ) ) {
7878
b.fail( 'should not return NaN' );
7979
}
8080
}
8181
b.toc();
82-
if ( isnanf( z[ i % ( z.length ) ] ) ) {
82+
if ( isnanf( z[ i%z.length ] ) ) {
8383
b.fail( 'should not return NaN' );
8484
}
8585
b.pass( 'benchmark finished' );

lib/node_modules/@stdlib/blas/base/ctrsv/benchmark/benchmark.ndarray.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,12 @@ function createBenchmark( N ) {
7474
b.tic();
7575
for ( i = 0; i < b.iterations; i++ ) {
7676
z = ctrsv( 'upper', 'transpose', 'non-unit', N, A, N, 1, 0, x, 1, 0 );
77-
if ( isnanf( z[ i%(z.length) ] ) ) {
77+
if ( isnanf( z[ i%z.length ] ) ) {
7878
b.fail( 'should not return NaN' );
7979
}
8080
}
8181
b.toc();
82-
if ( isnanf( z[ i%(z.length) ] ) ) {
82+
if ( isnanf( z[ i%z.length ] ) ) {
8383
b.fail( 'should not return NaN' );
8484
}
8585
b.pass( 'benchmark finished' );

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

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

22
{{alias}}( order, uplo, trans, diag, N, A, lda, x, sx )
33
Solves one of the systems of equations `A*x = b` or `A^T*x = b` or
4-
`A^H*x = b` where `b` and `x` are `N` element complex vectors and `A` is an
5-
`N` by `N` unit, or non-unit, upper or lower triangular complex matrix.
4+
`A^H*x = b` where `b` and `x` are `N` element vectors and `A` is an `N` by
5+
`N` unit, or non-unit, upper or lower triangular matrix.
66

77
Indexing is relative to the first index. To introduce an offset, use typed
88
array views.
@@ -20,8 +20,7 @@
2020

2121
trans: string
2222
Specifies whether `A` should be transposed, conjugate-transposed, or not
23-
transposed. Accepted values typically include: 'no-transpose',
24-
'transpose', 'conjugate-transpose'.
23+
transposed.
2524

2625
diag: string
2726
Specifies whether `A` has a unit diagonal.
@@ -98,11 +97,11 @@
9897
{{alias}}.ndarray( uplo, trans, diag, N, A, sa1, sa2, oa, x, sx, ox )
9998
Solves one of the systems of equations `A*x = b` or `A^T*x = b` or
10099
`A^H*x = b` using alternative indexing semantics and where `b` and `x` are
101-
`N` element complex vectors and `A` is an `N` by `N` unit, or non-unit,
102-
upper or lower triangular complex matrix.
100+
`N` element vectors and `A` is an `N` by `N` unit, or non-unit, upper or
101+
lower triangular matrix.
103102

104-
While typed array views mandate a view offset based on the underlying buffer
105-
, the offset parameters support indexing semantics based on starting
103+
While typed array views mandate a view offset based on the underlying
104+
buffer, the offset parameters support indexing semantics based on starting
106105
indices.
107106

108107
Parameters
@@ -112,8 +111,7 @@
112111

113112
trans: string
114113
Specifies whether `A` should be transposed, conjugate-transposed, or not
115-
transposed. Accepted values typically include: 'no-transpose',
116-
'transpose', 'conjugate-transpose'.
114+
transposed.
117115

118116
diag: string
119117
Specifies whether `A` has a unit diagonal.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import { Complex64Array } from '@stdlib/types/array';
2828
*/
2929
interface Routine {
3030
/**
31-
* Solves one of the systems of equations `A*x = b` or `A^T*x = b` or `A^H*x = b` where `b` and `x` are `N` element complex vectors and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular complex matrix.
31+
* Solves one of the systems of equations `A*x = b` or `A^T*x = b` or `A^H*x = b` where `b` and `x` are `N` element vectors and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix.
3232
*
3333
* @param order - storage layout
3434
* @param uplo - specifies whether `A` is an upper or lower triangular matrix
@@ -53,7 +53,7 @@ interface Routine {
5353
( order: Layout, uplo: MatrixTriangle, trans: TransposeOperation, diag: DiagonalType, N: number, A: Complex64Array, LDA: number, x: Complex64Array, strideX: number ): Complex64Array;
5454

5555
/**
56-
* Solves one of the systems of equations `A*x = b` or `A^T*x = b` or `A^H*x = b` using alternative indexing semantics and where `b` and `x` are `N` element complex vectors and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular complex matrix.
56+
* Solves one of the systems of equations `A*x = b` or `A^T*x = b` or `A^H*x = b` using alternative indexing semantics and where `b` and `x` are `N` element vectors and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix.
5757
*
5858
* @param uplo - specifies whether `A` is an upper or lower triangular matrix
5959
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
@@ -81,7 +81,7 @@ interface Routine {
8181
}
8282

8383
/**
84-
* Solves one of the systems of equations `A*x = b` or `A^T*x = b` or `A^H*x = b` where `b` and `x` are `N` element complex vectors and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular complex matrix.
84+
* Solves one of the systems of equations `A*x = b` or `A^T*x = b` or `A^H*x = b` where `b` and `x` are `N` element vectors and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix.
8585
*
8686
* @param order - storage layout
8787
* @param uplo - specifies whether `A` is an upper or lower triangular matrix

0 commit comments

Comments
 (0)