Skip to content

Commit 154588f

Browse files
committed
docs: add info about itrans
--- 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: 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: na - task: lint_license_headers status: passed ---
1 parent aed4c82 commit 154588f

File tree

5 files changed

+45
-3
lines changed

5 files changed

+45
-3
lines changed

lib/node_modules/@stdlib/lapack/base/dgtts2/docs/repl.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@
1515
either 'row-major' or 'column-major'.
1616

1717
itrans: integer
18-
Specifies the form of the system of equations.
18+
Specifies the form of the system of equations. To solve A * X = B
19+
(no transpose) use itrans = 0, to solve A**T * X = B (transpose)
20+
use itrans = 1, to solve A**T * X = B (conjugate transpose = transpose)
21+
use itrans = 2.
1922

2023
N: integer
2124
Order of the matrix `A`.
@@ -92,7 +95,10 @@
9295
Parameters
9396
----------
9497
tr: integer
95-
Specifies the form of the system of equations.
98+
Specifies the form of the system of equations. To solve A * X = B
99+
(no transpose) use itrans = 0, to solve A**T * X = B (transpose)
100+
use itrans = 1, to solve A**T * X = B (conjugate transpose = transpose)
101+
use itrans = 2.
96102

97103
N: integer
98104
Order of the matrix `A`.

lib/node_modules/@stdlib/lapack/base/dgtts2/docs/types/index.d.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ interface Routine {
2929
/**
3030
* Solves a system of linear equations with a tri diagonal matrix using the LU factorization.
3131
*
32+
* ## Notes
33+
*
34+
* - To solve A * X = B (no transpose), use itrans = 0.
35+
* - To solve AT * X = B (transpose), use itrans = 1.
36+
* - To solve AT * X = B (conjugate transpose = transpose), use itrans = 2.
37+
*
3238
* @param order - storage layout of B
3339
* @param itrans - specifies the form of the system of equations (0: no transpose, 1: transpose, 2: conjugate transpose)
3440
* @param N - order of the matrix A
@@ -61,6 +67,12 @@ interface Routine {
6167
/**
6268
* Solves a system of linear equations with alternative indexing semantics.
6369
*
70+
* ## Notes
71+
*
72+
* - To solve A * X = B (no transpose), use itrans = 0.
73+
* - To solve AT * X = B (transpose), use itrans = 1.
74+
* - To solve AT * X = B (conjugate transpose = transpose), use itrans = 2.
75+
*
6476
* @param itrans - specifies the form of the system of equations
6577
* @param N - order of the matrix A
6678
* @param nrhs - number of right-hand sides
@@ -105,6 +117,12 @@ interface Routine {
105117
/**
106118
* Solves a system of linear equations with a tri diagonal matrix using the LU factorization.
107119
*
120+
* ## Notes
121+
*
122+
* - To solve A * X = B (no transpose), use itrans = 0.
123+
* - To solve AT * X = B (transpose), use itrans = 1.
124+
* - To solve AT * X = B (conjugate transpose = transpose), use itrans = 2.
125+
*
108126
* @param order - storage layout of B
109127
* @param itrans - system equation form specification
110128
* @param N - matrix order

lib/node_modules/@stdlib/lapack/base/dgtts2/lib/base.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,13 @@ function noTranspose( N, nrhs, DL, sdl, odl, D, sd, od, DU, sdu, odu, DU2, sdu2,
229229
// MAIN //
230230

231231
/**
232-
* Solves a system of linear equations with a tri diagonal matrix using the LU factorization.
232+
* Solves a system of linear equations with a tri diagonal matrix using the LU factorization computed by `dgttrf`.
233+
*
234+
* ## Notes
235+
*
236+
* - To solve A * X = B (no transpose), use itrans = 0.
237+
* - To solve AT * X = B (transpose), use itrans = 1.
238+
* - To solve AT * X = B (conjugate transpose = transpose), use itrans = 2.
233239
*
234240
* @param {integer} itrans - specifies the form of the system of equations
235241
* @param {NonNegativeInteger} N - order of the matrix A

lib/node_modules/@stdlib/lapack/base/dgtts2/lib/dgtts2.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ var base = require( './base.js' );
3030
/**
3131
* Solves a system of linear equations with a tri diagonal matrix using the LU factorization computed by `dgttrf`.
3232
*
33+
* ## Notes
34+
*
35+
* - To solve A * X = B (no transpose), use itrans = 0.
36+
* - To solve AT * X = B (transpose), use itrans = 1.
37+
* - To solve AT * X = B (conjugate transpose = transpose), use itrans = 2.
38+
*
3339
* @param {string} order - storage layout of B
3440
* @param {integer} itrans - specifies the form of the system of equations
3541
* @param {NonNegativeInteger} N - order of the matrix A

lib/node_modules/@stdlib/lapack/base/dgtts2/lib/ndarray.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ var base = require( './base.js' );
2828
/**
2929
* Solves a system of linear equations with a tri diagonal matrix using the LU factorization and alternative indexing semantics.
3030
*
31+
* ## Notes
32+
*
33+
* - To solve A * X = B (no transpose), use itrans = 0.
34+
* - To solve AT * X = B (transpose), use itrans = 1.
35+
* - To solve AT * X = B (conjugate transpose = transpose), use itrans = 2.
36+
*
3137
* @param {integer} itrans - specifies the form of the system of equations
3238
* @param {NonNegativeInteger} N - order of the matrix A
3339
* @param {NonNegativeInteger} nrhs - number of right-hand sides, i.e., the number of columns of the matrix B

0 commit comments

Comments
 (0)