Skip to content

Commit 13e7f57

Browse files
aayush0325aayush0325
committed
docs: update descriptions as per lapack documentation
--- 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: 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 --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent 43f57ea commit 13e7f57

File tree

4 files changed

+58
-58
lines changed

4 files changed

+58
-58
lines changed

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

+23-23
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
*
2828
* - if equal to zero, then the factorization was successful.
2929
* - if less than zero, then the k-th argument had an illegal value, where `k = -StatusCode`.
30-
* - if greater than zero, then the leading principal minor of order `k` is not positive, where `k = StatusCode`. If `k < N`, then the factorization could not be completed. If `k = N`, then the factorization was completed, but `D(N) <= 0`, meaning that the matrix `A` is not positive definite.
30+
* - if greater than zero, then U( k, k ) is exactly zero the factorization has been completed, but the factor U is exactly singular, and division by zero will occur if it is used to solve a system of equations, where `k = StatusCode`.
3131
*/
3232
type StatusCode = number;
3333

@@ -39,10 +39,10 @@ interface Routine {
3939
* Computes an LU factorization of a real tri diagonal matrix A using elimination with partial pivoting and row interchanges.
4040
*
4141
* @param N - order of matrix `A`
42-
* @param DL - the `N-1` subdiagonal elements of `A`
43-
* @param D - the `N` diagonal elements of `A`
44-
* @param DU - the `N-1` superdiagonal elements of `A`
45-
* @param DU2 - the `N-2` elements of the second superdiagonal of `A`
42+
* @param DL - sub diagonal elements of `A`. On exit, `DL` is overwritten by the multipliers that define the matrix `L` from the LU factorization of `A`.
43+
* @param D - diagonal elements of `A`. On exit, `D` is overwritten by the diagonal elements of the upper triangular matrix `U` from the LU factorization of `A`.
44+
* @param DU - super diagonal elements of `A`. On exit, `DU` is overwritten by the elements of the first super-diagonal of `U`.
45+
* @param DU2 - On exit, `DU2` is overwritten by the elements of the second super-diagonal of `U`.
4646
* @param IPIV - vector of pivot indices
4747
* @returns status code
4848
*
@@ -68,21 +68,21 @@ interface Routine {
6868
* Computes an LU factorization of a real tri diagonal matrix A using elimination with partial pivoting and row interchanges and alternative indexing semantics.
6969
*
7070
* @param N - order of matrix `A`
71-
* @param DL - the `N-1` subdiagonal elements of `A`
72-
* @param strideDL - stride of the subdiagonal elements of `A`
73-
* @param offsetDL - offset of the subdiagonal elements of `A`
74-
* @param D - the `N` diagonal elements of `A`
75-
* @param strideD - stride of the diagonal elements of `A`
76-
* @param offsetD - offset of the diagonal elements of `A`
77-
* @param DU - the `N-1` superdiagonal elements of `A`
78-
* @param strideDU - stride of the first superdiagonal elements of `A`
79-
* @param offsetDU - offset of the first superdiagonal elements of `A`
80-
* @param DU2 - the `N-2` elements of the second superdiagonal of `A`
81-
* @param strideDU2 - stride of the second superdiagonal elements of `A`
82-
* @param offsetDU2 - offset of the second superdiagonal elements of `A`
71+
* @param DL - sub diagonal elements of `A`. On exit, `DL` is overwritten by the multipliers that define the matrix `L` from the LU factorization of `A`.
72+
* @param strideDL - stride length for `DL`
73+
* @param offsetDL - starting index of `DL`
74+
* @param D - diagonal elements of `A`. On exit, `D` is overwritten by the diagonal elements of the upper triangular matrix `U` from the LU factorization of `A`.
75+
* @param strideD - stride length for `D`
76+
* @param offsetD - starting index of `D`
77+
* @param DU - super diagonal elements of `A`. On exit, `DU` is overwritten by the elements of the first super-diagonal of `U`.
78+
* @param strideDU - stride length for `DU`
79+
* @param offsetDU - starting index of `DU`
80+
* @param DU2 - On exit, `DU2` is overwritten by the elements of the second super-diagonal of `U`.
81+
* @param strideDU2 - stride length for `DU2`
82+
* @param offsetDU2 - starting index of `DU2`
8383
* @param IPIV - vector of pivot indices
84-
* @param strideIPIV - `IPIV` stride length
85-
* @param offsetIPIV - index offset for `IPIV`
84+
* @param strideIPIV - stride length for `IPIV`
85+
* @param offsetIPIV - starting index of `IPIV`
8686
* @returns status code
8787
*
8888
* @example
@@ -105,10 +105,10 @@ interface Routine {
105105
* LAPACK routine to compute an LU factorization of a real tri diagonal matrix A using elimination with partial pivoting and row interchanges.
106106
*
107107
* @param N - order of matrix `A`
108-
* @param DL - the `N-1` subdiagonal elements of `A`
109-
* @param D - the `N` diagonal elements of `A`
110-
* @param DU - the `N-1` superdiagonal elements of `A`
111-
* @param DU2 - the `N-2` elements of the second superdiagonal of `A`
108+
* @param DL - sub diagonal elements of `A`. On exit, `DL` is overwritten by the multipliers that define the matrix `L` from the LU factorization of `A`.
109+
* @param D - diagonal elements of `A`. On exit, `D` is overwritten by the diagonal elements of the upper triangular matrix `U` from the LU factorization of `A`.
110+
* @param DU - super diagonal elements of `A`. On exit, `DU` is overwritten by the elements of the first super-diagonal of `U`.
111+
* @param DU2 - On exit, `DU2` is overwritten by the elements of the second super-diagonal of `U`.
112112
* @param IPIV - vector of pivot indices
113113
* @returns status code
114114
*

‎lib/node_modules/@stdlib/lapack/base/dgttrf/lib/base.js

+15-15
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,22 @@ var abs = require( '@stdlib/math/base/special/abs' );
2929
* Computes an LU factorization of a real tri diagonal matrix A using elimination with partial pivoting and row interchanges.
3030
*
3131
* @private
32-
* @param {NonNegativeInteger} N - order of `A`
33-
* @param {Float64Array} DL - sub diagonal elements of `A`
34-
* @param {integer} strideDL - stride of the sub diagonal elements of `A`
35-
* @param {NonNegativeInteger} offsetDL - offset of the sub diagonal elements of `A`
36-
* @param {Float64Array} D - diagonal elements of `A`
37-
* @param {integer} strideD - stride of the diagonal elements of `A`
38-
* @param {NonNegativeInteger} offsetD - offset of the diagonal elements of `A`
39-
* @param {Float64Array} DU - diagonal elements of `A`
40-
* @param {integer} strideDU - stride of the first super diagonal elements of `A`
41-
* @param {NonNegativeInteger} offsetDU - offset of the first super diagonal elements of `A`
42-
* @param {Float64Array} DU2 - diagonal elements of `A`
43-
* @param {integer} strideDU2 - stride of the second super diagonal elements of `A`
44-
* @param {NonNegativeInteger} offsetDU2 - offset of the second super diagonal elements of `A`
32+
* @param {NonNegativeInteger} N - order of matrix A
33+
* @param {Float64Array} DL - sub diagonal elements of A. On exit, DL is overwritten by the multipliers that define the matrix L from the LU factorization of A.
34+
* @param {integer} strideDL - stride length for `DL`
35+
* @param {NonNegativeInteger} offsetDL - starting index of `DL`
36+
* @param {Float64Array} D - diagonal elements of A. On exit, D is overwritten by the diagonal elements of the upper triangular matrix U from the LU factorization of A.
37+
* @param {integer} strideD - stride length for `D`
38+
* @param {NonNegativeInteger} offsetD - starting index of `D`
39+
* @param {Float64Array} DU - super diagonal elements of A. On exit, DU is overwritten by the elements of the first super-diagonal of U.
40+
* @param {integer} strideDU - stride length for `DU`
41+
* @param {NonNegativeInteger} offsetDU - starting index of `DU`
42+
* @param {Float64Array} DU2 - On exit, DU2 is overwritten by the elements of the second super-diagonal of U.
43+
* @param {integer} strideDU2 - stride length for `DU2`
44+
* @param {NonNegativeInteger} offsetDU2 - starting index of `DU2`
4545
* @param {Int32Array} IPIV - vector of pivot indices
46-
* @param {integer} strideIPIV - `IPIV` stride length
47-
* @param {NonNegativeInteger} offsetIPIV - index offset for `IPIV`
46+
* @param {integer} strideIPIV - stride length for `IPIV`
47+
* @param {NonNegativeInteger} offsetIPIV - starting index of `IPIV`
4848
* @returns {integer} status code
4949
*
5050
* @example

‎lib/node_modules/@stdlib/lapack/base/dgttrf/lib/dgttrf.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ var base = require( './base.js' );
2929
/**
3030
* Computes an LU factorization of a real tri diagonal matrix A using elimination with partial pivoting and row interchanges.
3131
*
32-
* @param {NonNegativeInteger} N - order of `A`
33-
* @param {Float64Array} DL - sub diagonal elements of `A`
34-
* @param {Float64Array} D - diagonal elements of `A`
35-
* @param {Float64Array} DU - diagonal elements of `A`
36-
* @param {Float64Array} DU2 - diagonal elements of `A`
32+
* @param {NonNegativeInteger} N - order of matrix A
33+
* @param {Float64Array} DL - sub diagonal elements of A. On exit, DL is overwritten by the multipliers that define the matrix L from the LU factorization of A.
34+
* @param {Float64Array} D - diagonal elements of A. On exit, D is overwritten by the diagonal elements of the upper triangular matrix U from the LU factorization of A.
35+
* @param {Float64Array} DU - super diagonal elements of A. On exit, DU is overwritten by the elements of the first super-diagonal of U.
36+
* @param {Float64Array} DU2 - On exit, DU2 is overwritten by the elements of the second super-diagonal of U.
3737
* @param {Int32Array} IPIV - vector of pivot indices
3838
* @throws {RangeError} first argument must be a nonnegative integer
3939
* @returns {integer} status code

‎lib/node_modules/@stdlib/lapack/base/dgttrf/lib/ndarray.js

+15-15
Original file line numberDiff line numberDiff line change
@@ -29,22 +29,22 @@ var base = require( './base.js' );
2929
/**
3030
* Computes an LU factorization of a real tri diagonal matrix A using elimination with partial pivoting and row interchanges and alternative indexing semantics.
3131
*
32-
* @param {NonNegativeInteger} N - order of `A`
33-
* @param {Float64Array} DL - sub diagonal elements of `A`
34-
* @param {integer} strideDL - stride of the sub diagonal elements of `A`
35-
* @param {NonNegativeInteger} offsetDL - offset of the sub diagonal elements of `A`
36-
* @param {Float64Array} D - diagonal elements of `A`
37-
* @param {integer} strideD - stride of the diagonal elements of `A`
38-
* @param {NonNegativeInteger} offsetD - offset of the diagonal elements of `A`
39-
* @param {Float64Array} DU - diagonal elements of `A`
40-
* @param {integer} strideDU - stride of the first super diagonal elements of `A`
41-
* @param {NonNegativeInteger} offsetDU - offset of the first super diagonal elements of `A`
42-
* @param {Float64Array} DU2 - diagonal elements of `A`
43-
* @param {integer} strideDU2 - stride of the second super diagonal elements of `A`
44-
* @param {NonNegativeInteger} offsetDU2 - offset of the second super diagonal elements of `A`
32+
* @param {NonNegativeInteger} N - order of matrix A
33+
* @param {Float64Array} DL - sub diagonal elements of A. On exit, DL is overwritten by the multipliers that define the matrix L from the LU factorization of A.
34+
* @param {integer} strideDL - stride length for `DL`
35+
* @param {NonNegativeInteger} offsetDL - starting index of `DL`
36+
* @param {Float64Array} D - diagonal elements of A. On exit, D is overwritten by the diagonal elements of the upper triangular matrix U from the LU factorization of A.
37+
* @param {integer} strideD - stride length for `D`
38+
* @param {NonNegativeInteger} offsetD - starting index of `D`
39+
* @param {Float64Array} DU - super diagonal elements of A. On exit, DU is overwritten by the elements of the first super-diagonal of U.
40+
* @param {integer} strideDU - stride length for `DU`
41+
* @param {NonNegativeInteger} offsetDU - starting index of `DU`
42+
* @param {Float64Array} DU2 - On exit, DU2 is overwritten by the elements of the second super-diagonal of U.
43+
* @param {integer} strideDU2 - stride length for `DU2`
44+
* @param {NonNegativeInteger} offsetDU2 - starting index of `DU2`
4545
* @param {Int32Array} IPIV - vector of pivot indices
46-
* @param {integer} strideIPIV - `IPIV` stride length
47-
* @param {NonNegativeInteger} offsetIPIV - index offset for `IPIV`
46+
* @param {integer} strideIPIV - stride length for `IPIV`
47+
* @param {NonNegativeInteger} offsetIPIV - starting index of `IPIV`
4848
* @throws {RangeError} first argument must be a nonnegative integer
4949
* @returns {integer} status code
5050
*

0 commit comments

Comments
 (0)