Skip to content

Commit 92532e2

Browse files
refactor: improve notes in the description of the routine
--- 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: passed - 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: passed - task: lint_license_headers status: passed ---
1 parent e49863a commit 92532e2

5 files changed

Lines changed: 40 additions & 28 deletions

File tree

lib/node_modules/@stdlib/lapack/base/dla-gbrpvgrw/README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,10 +190,16 @@ var out = dlagbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 1, AFB, 4, 1, 1 );
190190

191191
## Notes
192192

193-
- Matrix `AB` is the matrix A in band storage, in rows 1 to KL+KU+1. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB(KU+1+i-j,j) = A(i,j)` for max(1,j-KU)<=i<=min(N,j+kl).
194-
- Matrix `AFB` stores the details of the LU factorization of the band matrix A, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 1 to `KL`+`KU`+1, and the multipliers used during the factorization are stored in rows `KL`+`KU`+2 to 2*`KL`+`KU`+1.
195-
- The leading dimension of `AB`, `LDAB` >= KL+KU+1.
196-
- The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
193+
- The norm is used. If this is much less than 1, the stability of the LU factorization of the (equilibrated) matrix `A` could be poor. This also means that the solution `X`, estimated condition numbers, and error bounds could be unreliable.
194+
195+
- Matrix `AB` is the matrix A in band storage, in rows 0 to `KL+KU`. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB( KU+i-j, j ) = A( i, j )` for `max( 0, j - KU ) <= i <= min( N - 1, j + KL )`.
196+
197+
- Matrix `AFB` stores the details of the LU factorization of the band matrix `A`, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 0 to `KL+KU+1`, and the multipliers used during the factorization are stored in rows `KL+KU+1` to `2*KL+KU`.
198+
199+
- The leading dimension of `AB`, `LDAB` >= `KL+KU+1`.
200+
201+
- The leading dimension of `AFB`, `LDAFB` >= `2*KL+KU+1`.
202+
197203
- `dlagbrpvgrw()` corresponds to the [LAPACK][LAPACK] function [`dlagbrpvgrw`][lapack-dlagbrpvgrw].
198204

199205
</section>

lib/node_modules/@stdlib/lapack/base/dla-gbrpvgrw/docs/types/index.d.ts

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ interface Routine {
3131
*
3232
* ## Notes
3333
*
34-
* - Matrix `AB` is the matrix A in band storage, in rows 1 to KL+KU+1. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB(KU+1+i-j,j) = A(i,j)` for max(1,j-KU)<=i<=min(N,j+kl).
35-
* - Matrix `AFB` stores the details of the LU factorization of the band matrix A, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 1 to `KL`+`KU`+1, and the multipliers used during the factorization are stored in rows `KL`+`KU`+2 to 2*`KL`+`KU`+1.
36-
* - The leading dimension of `AB`, `LDAB` >= KL+KU+1.
37-
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
34+
* - The norm is used. If this is much less than 1, the stability of the LU factorization of the (equilibrated) matrix `A` could be poor. This also means that the solution `X`, estimated condition numbers, and error bounds could be unreliable.
35+
* - Matrix `AB` is the matrix A in band storage, in rows 0 to `KL+KU`. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB( KU+i-j, j ) = A( i, j )` for `max( 0, j - KU ) <= i <= min( N - 1, j + KL )`.
36+
* - Matrix `AFB` stores the details of the LU factorization of the band matrix `A`, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 0 to `KL+KU+1`, and the multipliers used during the factorization are stored in rows `KL+KU+1` to `2*KL+KU`.
37+
* - The leading dimension of `AB`, `LDAB` >= `KL+KU+1`.
38+
* - The leading dimension of `AFB`, `LDAFB` >= `2*KL+KU+1`.
3839
*
3940
* @param order - order of matrix `A`
4041
* @param N - number of rows in matrix `A`
@@ -63,10 +64,11 @@ interface Routine {
6364
*
6465
* ## Notes
6566
*
66-
* - Matrix `AB` is the matrix A in band storage, in rows 1 to KL+KU+1. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB(KU+1+i-j,j) = A(i,j)` for max(1,j-KU)<=i<=min(N,j+kl).
67-
* - Matrix `AFB` stores the details of the LU factorization of the band matrix A, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 1 to `KL`+`KU`+1, and the multipliers used during the factorization are stored in rows `KL`+`KU`+2 to 2*`KL`+`KU`+1.
68-
* - The leading dimension of `AB`, `LDAB` >= KL+KU+1.
69-
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
67+
* - The norm is used. If this is much less than 1, the stability of the LU factorization of the (equilibrated) matrix `A` could be poor. This also means that the solution `X`, estimated condition numbers, and error bounds could be unreliable.
68+
* - Matrix `AB` is the matrix A in band storage, in rows 0 to `KL+KU`. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB( KU+i-j, j ) = A( i, j )` for `max( 0, j - KU ) <= i <= min( N - 1, j + KL )`.
69+
* - Matrix `AFB` stores the details of the LU factorization of the band matrix `A`, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 0 to `KL+KU+1`, and the multipliers used during the factorization are stored in rows `KL+KU+1` to `2*KL+KU`.
70+
* - The leading dimension of `AB`, `LDAB` >= `KL+KU+1`.
71+
* - The leading dimension of `AFB`, `LDAFB` >= `2*KL+KU+1`.
7072
*
7173
* @param N - number of rows in matrix `A`
7274
* @param KL - number of subdiagonals within the band of matrix `A`
@@ -99,10 +101,11 @@ interface Routine {
99101
*
100102
* ## Notes
101103
*
102-
* - Matrix `AB` is the matrix A in band storage, in rows 1 to KL+KU+1. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB(KU+1+i-j,j) = A(i,j)` for max(1,j-KU)<=i<=min(N,j+kl).
103-
* - Matrix `AFB` stores the details of the LU factorization of the band matrix A, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 1 to `KL`+`KU`+1, and the multipliers used during the factorization are stored in rows `KL`+`KU`+2 to 2*`KL`+`KU`+1.
104-
* - The leading dimension of `AB`, `LDAB` >= KL+KU+1.
105-
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
104+
* - The norm is used. If this is much less than 1, the stability of the LU factorization of the (equilibrated) matrix `A` could be poor. This also means that the solution `X`, estimated condition numbers, and error bounds could be unreliable.
105+
* - Matrix `AB` is the matrix A in band storage, in rows 0 to `KL+KU`. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB( KU+i-j, j ) = A( i, j )` for `max( 0, j - KU ) <= i <= min( N - 1, j + KL )`.
106+
* - Matrix `AFB` stores the details of the LU factorization of the band matrix `A`, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 0 to `KL+KU+1`, and the multipliers used during the factorization are stored in rows `KL+KU+1` to `2*KL+KU`.
107+
* - The leading dimension of `AB`, `LDAB` >= `KL+KU+1`.
108+
* - The leading dimension of `AFB`, `LDAFB` >= `2*KL+KU+1`.
106109
*
107110
* @param order - order of matrix `A`
108111
* @param N - number of rows in matrix `A`

lib/node_modules/@stdlib/lapack/base/dla-gbrpvgrw/lib/base.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,11 @@ var min = require( '@stdlib/math/base/special/min' );
3232
*
3333
* ## Notes
3434
*
35-
* - Matrix `AB` is the matrix A in band storage, in rows 1 to KL+KU+1. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB(KU+1+i-j,j) = A(i,j)` for max(1,j-KU)<=i<=min(N,j+kl).
36-
* - Matrix `AFB` stores the details of the LU factorization of the band matrix A, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 1 to `KL`+`KU`+1, and the multipliers used during the factorization are stored in rows `KL`+`KU`+2 to 2*`KL`+`KU`+1.
37-
* - The leading dimension of `AB`, `LDAB` >= KL+KU+1.
38-
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
35+
* - The norm is used. If this is much less than 1, the stability of the LU factorization of the (equilibrated) matrix `A` could be poor. This also means that the solution `X`, estimated condition numbers, and error bounds could be unreliable.
36+
* - Matrix `AB` is the matrix A in band storage, in rows 0 to `KL+KU`. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB( KU+i-j, j ) = A( i, j )` for `max( 0, j - KU ) <= i <= min( N - 1, j + KL )`.
37+
* - Matrix `AFB` stores the details of the LU factorization of the band matrix `A`, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 0 to `KL+KU+1`, and the multipliers used during the factorization are stored in rows `KL+KU+1` to `2*KL+KU`.
38+
* - The leading dimension of `AB`, `LDAB` >= `KL+KU+1`.
39+
* - The leading dimension of `AFB`, `LDAFB` >= `2*KL+KU+1`.
3940
*
4041
* @private
4142
* @param {NonNegativeInteger} N - number of rows in matrix `A`

lib/node_modules/@stdlib/lapack/base/dla-gbrpvgrw/lib/dlagbrpvgrw.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ var base = require( './base.js' );
3333
*
3434
* ## Notes
3535
*
36-
* - Matrix `AB` is the matrix A in band storage, in rows 1 to `KL+KU+1`. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB(KU+1+i-j,j) = A(i,j)` for max(1,j-KU)<=i<=min(N,j+kl).
37-
* - Matrix `AFB` stores the details of the LU factorization of the band matrix `A`, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with `KL+KU` superdiagonals in rows 0 to `KL+KU+1`, and the multipliers used during the factorization are stored in rows `KL+KU+2` to `2*KL+KU+1`.
38-
* - The leading dimension of `AB`, `LDAB` >= KL+KU+1.
39-
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
36+
* - The norm is used. If this is much less than 1, the stability of the LU factorization of the (equilibrated) matrix `A` could be poor. This also means that the solution `X`, estimated condition numbers, and error bounds could be unreliable.
37+
* - Matrix `AB` is the matrix A in band storage, in rows 0 to `KL+KU`. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB( KU+i-j, j ) = A( i, j )` for `max( 0, j - KU ) <= i <= min( N - 1, j + KL )`.
38+
* - Matrix `AFB` stores the details of the LU factorization of the band matrix `A`, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 0 to `KL+KU+1`, and the multipliers used during the factorization are stored in rows `KL+KU+1` to `2*KL+KU`.
39+
* - The leading dimension of `AB`, `LDAB` >= `KL+KU+1`.
40+
* - The leading dimension of `AFB`, `LDAFB` >= `2*KL+KU+1`.
4041
*
4142
* @param {string} order - order of matrix `A`
4243
* @param {NonNegativeInteger} N - number of rows in matrix `A`

lib/node_modules/@stdlib/lapack/base/dla-gbrpvgrw/lib/ndarray.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,11 @@ var base = require( './base.js' );
3030
*
3131
* ## Notes
3232
*
33-
* - Matrix `AB` is the matrix A in band storage, in rows 1 to KL+KU+1. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB(KU+1+i-j,j) = A(i,j)` for max(1,j-KU)<=i<=min(N,j+kl).
34-
* - Matrix `AFB` stores the details of the LU factorization of the band matrix A, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 1 to `KL`+`KU`+1, and the multipliers used during the factorization are stored in rows `KL`+`KU`+2 to 2*`KL`+`KU`+1.
35-
* - The leading dimension of `AB`, `LDAB` >= KL+KU+1.
36-
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
33+
* - The norm is used. If this is much less than 1, the stability of the LU factorization of the (equilibrated) matrix `A` could be poor. This also means that the solution `X`, estimated condition numbers, and error bounds could be unreliable.
34+
* - Matrix `AB` is the matrix A in band storage, in rows 0 to `KL+KU`. The j-th column of A is stored in the j-th column of the matrix `AB` as `AB( KU+i-j, j ) = A( i, j )` for `max( 0, j - KU ) <= i <= min( N - 1, j + KL )`.
35+
* - Matrix `AFB` stores the details of the LU factorization of the band matrix `A`, as computed by `DGBTRF`. `U` is stored as an upper triangular band matrix with KL+KU superdiagonals in rows 0 to `KL+KU+1`, and the multipliers used during the factorization are stored in rows `KL+KU+1` to `2*KL+KU`.
36+
* - The leading dimension of `AB`, `LDAB` >= `KL+KU+1`.
37+
* - The leading dimension of `AFB`, `LDAFB` >= `2*KL+KU+1`.
3738
*
3839
* @param {NonNegativeInteger} N - number of rows in matrix `A`
3940
* @param {NonNegativeInteger} KL - number of subdiagonals within the band of matrix `A`

0 commit comments

Comments
 (0)