Skip to content

Commit d8d37d5

Browse files
aayush0325aayush0325
committed
docs: update 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: passed - 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 3dc7e61 commit d8d37d5

File tree

6 files changed

+83
-77
lines changed

6 files changed

+83
-77
lines changed

‎lib/node_modules/@stdlib/lapack/base/dgttrf/README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ var Int32Array = require( '@stdlib/array/int32' );
4141
var DL = new Float64Array( [ 1.0, 1.0 ] );
4242
var D = new Float64Array( [ 2.0, 3.0, 1.0 ] );
4343
var DU = new Float64Array( [ 1.0, 1.0 ] );
44-
var DU2 = new Float64Array( 1 );
45-
var IPIV = new Int32Array( 3 );
44+
var DU2 = new Float64Array( [ 0.0 ] );
45+
var IPIV = new Int32Array( [ 0, 0, 0 ] );
4646

4747
dgttrf( 3, DL, D, DU, DU2, IPIV );
4848
// DL => <Float64Array>[ 0.5, 0.4 ]
@@ -54,12 +54,12 @@ dgttrf( 3, DL, D, DU, DU2, IPIV );
5454

5555
The function has the following parameters:
5656

57-
- **N**: order of matrix `A`.
58-
- **DL**: the sub diagonal elements of `A` as a [`Float64Array`][mdn-float64array]. DL is overwritten by the multipliers that define the matrix `L` from the `LU` factorization of `A`.
59-
- **D**: the diagonal elements of `A` as a [`Float64Array`][mdn-float64array]. D is overwritten by the diagonal elements of the upper triangular matrix `U` from the `LU` factorization of `A`.
60-
- **DU**: the super diagonal elements of `A` as a [`Float64Array`][mdn-float64array]. DU is overwritten by the elements of the first super-diagonal of `U`.
61-
- **DU2**: DU2 is overwritten by the elements of the second super-diagonal of `U` as a [`Float64Array`][mdn-float64array].
62-
- **IPIV**: vector of pivot indices as a [`Int32Array`][mdn-int32array].
57+
- **N**: number of rows/columns in `A`.
58+
- **DL**: the first sub diagonal of `A` as a [`Float64Array`][mdn-float64array]. Expects `N-1` indexed elements. `DL` is overwritten by the multipliers that define the matrix `L` from the `LU` factorization of `A`.
59+
- **D**: the diagonal of `A` as a [`Float64Array`][mdn-float64array]. Expects `N` indexed elements. `D` is overwritten by the diagonal elements of the upper triangular matrix `U` from the `LU` factorization of `A`.
60+
- **DU**: the first super-diagonal of `A` as a [`Float64Array`][mdn-float64array]. Expects `N-1` indexed elements. `DU` is overwritten by the elements of the first super-diagonal of `U`.
61+
- **DU2**: the second super-diagonal of `U` as a [`Float64Array`][mdn-float64array]. Expects `N-2` indexed elements. `DU2` is overwritten by the elements of the second super-diagonal of `U` as a [`Float64Array`][mdn-float64array].
62+
- **IPIV**: vector of pivot indices as a [`Int32Array`][mdn-int32array]. Expects `N` indexed elements.
6363

6464
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
6565

@@ -73,8 +73,8 @@ var Int32Array = require( '@stdlib/array/int32' );
7373
var DL0 = new Float64Array( [ 0.0, 1.0, 1.0 ] );
7474
var D0 = new Float64Array( [ 0.0, 2.0, 3.0, 1.0 ] );
7575
var DU0 = new Float64Array( [ 0.0, 1.0, 1.0 ] );
76-
var DU20 = new Float64Array( 2 );
77-
var IPIV0 = new Int32Array( 4 );
76+
var DU20 = new Float64Array( [ 0.0, 0.0 ] );
77+
var IPIV0 = new Int32Array( [ 0, 0, 0, 0 ] );
7878

7979
// Create offset views...
8080
var DL = new Float64Array( DL0.buffer, DL0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
@@ -145,9 +145,9 @@ var IPIV = new Int32Array( [ 0, 0, 0, 0 ] );
145145

146146
dgttrf.ndarray( 3, DL, 1, 1, D, 1, 1, DU, 1, 1, DU2, 1, 1, IPIV, 1, 1 );
147147
// DL => <Float64Array>[ 0.0, 0.5, 0.4 ]
148-
// D => <Float64Array>[ 0, 2, 2.5, 0.6 ]
149-
// DU => <Float64Array>[ 0, 1, 1 ]
150-
// DU2 => <Float64Array>[ 0, 0 ]
148+
// D => <Float64Array>[ 0.0, 2.0, 2.5, 0.6 ]
149+
// DU => <Float64Array>[ 0.0, 1.0, 1.0 ]
150+
// DU2 => <Float64Array>[ 0.0, 0.0 ]
151151
// IPIV => <Int32Array>[ 0, 0, 1, 2 ]
152152
```
153153

‎lib/node_modules/@stdlib/lapack/base/dgttrf/docs/repl.txt‎

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,28 @@
1111
Parameters
1212
----------
1313
N: integer
14-
Order of matrix `A`.
14+
Number of rows/columns in `A`.
1515

1616
DL: Float64Array
17-
Sub diagonal elements of A. DL is overwritten by the multipliers
18-
that define the matrix L from the LU factorization of A.
17+
The first sub diagonal of `A`, expects N-1 indexed elements. DL is
18+
overwritten by the multipliers that define the matrix L from the LU
19+
factorization of A.
1920

2021
D: Float64Array
21-
Diagonal elements of A. D is overwritten by the diagonal elements
22-
of the upper triangular matrix U from the LU factorization of A.
22+
The diagonal of `A`, expects N indexed elements. D is overwritten by the
23+
diagonal elements of the upper triangular matrix U from the LU
24+
factorization of A.
2325

2426
DU: Float64Array
25-
Super diagonal elements of A. DU is overwritten by the elements of
26-
the first super-diagonal of U.
27+
The first super-diagonal of `A`, expects N-1 indexed elements. DU is
28+
overwritten by the elements of the first super-diagonal of U.
2729

2830
DU2: Float64Array
29-
DU2 is overwritten by the elements of the second super-diagonal of U.
31+
The second super-diagonal of `U`, expects N-2 indexed elements. DU2 is
32+
overwritten by the elements of the second super-diagonal of U.
3033

3134
IPIV: Int32Array
32-
Array of pivot indices.
35+
Vector of pivot indices, expects N indexed elements.
3336

3437
Returns
3538
-------
@@ -101,11 +104,12 @@
101104
Parameters
102105
----------
103106
N: integer
104-
Order of matrix `A`.
107+
Number of rows/columns in `A`.
105108

106109
DL: Float64Array
107-
Sub diagonal elements of A. DL is overwritten by the multipliers that
108-
define the matrix L from the LU factorization of A.
110+
The first sub diagonal of `A`, expects N-1 indexed elements. DL is
111+
overwritten by the multipliers that define the matrix L from the LU
112+
factorization of A.
109113

110114
sdl: integer
111115
Stride length for `DL`.
@@ -114,8 +118,9 @@
114118
Starting index for `DL`.
115119

116120
D: Float64Array
117-
Diagonal elements of A. D is overwritten by the diagonal elements of the
118-
upper triangular matrix U from the LU factorization of A.
121+
The diagonal of `A`, expects N indexed elements. D is overwritten by the
122+
diagonal elements of the upper triangular matrix U from the LU
123+
factorization of A.
119124

120125
sd: integer
121126
Stride length for `D`.
@@ -124,8 +129,8 @@
124129
Starting index for `D`.
125130

126131
DU: Float64Array
127-
Super diagonal elements of A. DU is overwritten by the elements of the
128-
first super-diagonal of U.
132+
The first super-diagonal of `A`, expects N-1 indexed elements. DU is
133+
overwritten by the elements of the first super-diagonal of U.
129134

130135
sdu: integer
131136
Stride length for `DU`.
@@ -134,7 +139,8 @@
134139
Starting index for `DU2`.
135140

136141
DU2: Float64Array
137-
DU2 is overwritten by the elements of the second super-diagonal of U.
142+
The second super-diagonal of `U`, expects N-2 indexed elements. DU2 is
143+
overwritten by the elements of the second super-diagonal of U.
138144

139145
sdu2: integer
140146
Stride length for `DU2`.
@@ -143,7 +149,7 @@
143149
Starting index for `DU2`.
144150

145151
IPIV: Int32Array
146-
Array of pivot indices.
152+
Vector of pivot indices, expects N indexed elements.
147153

148154
si: integer
149155
Stride length for `IPIV`.

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@ interface Routine {
4545
* - `DU2` is overwritten by the elements of the second super-diagonal of `U`.
4646
* - for `0 <= i < n`, row `i` of the matrix was interchanged with row `IPIV(i)`. `IPIV(i)` will always be either `i` or `i+1`; `IPIV(i) = i` indicates a row interchange was not required.
4747
*
48-
* @param N - order of matrix `A`
49-
* @param DL - sub diagonal elements of `A`
50-
* @param D - diagonal elements of `A`
51-
* @param DU - super diagonal elements of `A`
52-
* @param DU2 - vector to store the second super diagonal of `U`
53-
* @param IPIV - vector of pivot indices
48+
* @param N - number of rows/columns in `A`
49+
* @param DL - the first sub diagonal of `A`, expects N-1 indexed elements
50+
* @param D - the diagonal of `A`, expects N indexed elements
51+
* @param DU - the first super-diagonal of `A`, expects N-1 indexed elements
52+
* @param DU2 - the second super-diagonal of `U`, expects N-2 indexed elements
53+
* @param IPIV - vector of pivot indices, expects N indexed elements
5454
* @returns status code
5555
*
5656
* @example
@@ -83,20 +83,20 @@ interface Routine {
8383
* - `DU2` is overwritten by the elements of the second super-diagonal of `U`.
8484
* - for `0 <= i < n`, row `i` of the matrix was interchanged with row `IPIV(i)`. `IPIV(i)` will always be either `i` or `i+1`; `IPIV(i) = i` indicates a row interchange was not required.
8585
*
86-
* @param N - order of matrix `A`
87-
* @param DL - sub diagonal elements of `A`
86+
* @param N - number of rows/columns in `A`
87+
* @param DL - the first sub diagonal of `A`, expects N-1 indexed elements
8888
* @param strideDL - stride length for `DL`
8989
* @param offsetDL - starting index of `DL`
90-
* @param D - diagonal elements of `A`
90+
* @param D - the diagonal of `A`, expects N indexed elements
9191
* @param strideD - stride length for `D`
9292
* @param offsetD - starting index of `D`
93-
* @param DU - super diagonal elements of `A`
93+
* @param DU - the first super-diagonal of `A`, expects N-1 indexed elements
9494
* @param strideDU - stride length for `DU`
9595
* @param offsetDU - starting index of `DU`
96-
* @param DU2 - vector to store the second super diagonal of `U`
96+
* @param DU2 - the second super-diagonal of `U`, expects N-2 indexed elements
9797
* @param strideDU2 - stride length for `DU2`
9898
* @param offsetDU2 - starting index of `DU2`
99-
* @param IPIV - vector of pivot indices
99+
* @param IPIV - vector of pivot indices, expects N indexed elements
100100
* @param strideIPIV - stride length for `IPIV`
101101
* @param offsetIPIV - starting index of `IPIV`
102102
* @returns status code
@@ -129,12 +129,12 @@ interface Routine {
129129
* - `DU2` is overwritten by the elements of the second super-diagonal of `U`.
130130
* - for `0 <= i < n`, row `i` of the matrix was interchanged with row `IPIV(i)`. `IPIV(i)` will always be either `i` or `i+1`; `IPIV(i) = i` indicates a row interchange was not required.
131131
*
132-
* @param N - order of matrix `A`
133-
* @param DL - sub diagonal elements of `A`
134-
* @param D - diagonal elements of `A`
135-
* @param DU - super diagonal elements of `A`
136-
* @param DU2 - `DU2` is overwritten by the elements of the second super-diagonal of `U`
137-
* @param IPIV - vector of pivot indices
132+
* @param N - number of rows/columns in `A`
133+
* @param DL - the first sub diagonal of `A`, expects N-1 indexed elements
134+
* @param D - the diagonal of `A`, expects N indexed elements
135+
* @param DU - the first super-diagonal of `A`, expects N-1 indexed elements
136+
* @param DU2 - the second super-diagonal of `U`, expects N-2 indexed elements
137+
* @param IPIV - vector of pivot indices, expects N indexed elements
138138
* @returns status code
139139
*
140140
* @example

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ var abs = require( '@stdlib/math/base/special/abs' );
3737
* - for `0 <= i < n`, row `i` of the matrix was interchanged with row `IPIV(i)`. `IPIV(i)` will always be either `i` or `i+1`; `IPIV(i) = i` indicates a row interchange was not required.
3838
*
3939
* @private
40-
* @param {NonNegativeInteger} N - order of matrix A
41-
* @param {Float64Array} DL - sub diagonal elements of A, expects N-1 indexed elements
40+
* @param {NonNegativeInteger} N - number of rows/columns in `A`
41+
* @param {Float64Array} DL - the first sub diagonal of `A`, expects N-1 indexed elements
4242
* @param {integer} strideDL - stride length for `DL`
4343
* @param {NonNegativeInteger} offsetDL - starting index of `DL`
44-
* @param {Float64Array} D - diagonal elements of A, expects N indexed elements
44+
* @param {Float64Array} D - the diagonal of `A`, expects N indexed elements
4545
* @param {integer} strideD - stride length for `D`
4646
* @param {NonNegativeInteger} offsetD - starting index of `D`
47-
* @param {Float64Array} DU - super diagonal elements of A, expects N-1 indexed elements
47+
* @param {Float64Array} DU - the first super-diagonal of `A`, expects N-1 indexed elements
4848
* @param {integer} strideDU - stride length for `DU`
4949
* @param {NonNegativeInteger} offsetDU - starting index of `DU`
50-
* @param {Float64Array} DU2 - vector to store the second super diagonal of `U`, expects N-2 indexed elements
50+
* @param {Float64Array} DU2 - the second super-diagonal of `U`, expects N-2 indexed elements
5151
* @param {integer} strideDU2 - stride length for `DU2`
5252
* @param {NonNegativeInteger} offsetDU2 - starting index of `DU2`
5353
* @param {Int32Array} IPIV - vector of pivot indices, expects N indexed elements

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ var base = require( './base.js' );
3737
* - `DU2` is overwritten by the elements of the second super-diagonal of `U`.
3838
* - for `0 <= i < n`, row `i` of the matrix was interchanged with row `IPIV(i)`. `IPIV(i)` will always be either `i` or `i+1`; `IPIV(i) = i` indicates a row interchange was not required.
3939
*
40-
* @param {NonNegativeInteger} N - order of matrix A
41-
* @param {Float64Array} DL - sub diagonal elements of A, expects N-1 indexed elements
42-
* @param {Float64Array} D - diagonal elements of A, expects N indexed elements
43-
* @param {Float64Array} DU - super diagonal elements of A, expects N-1 indexed elements
44-
* @param {Float64Array} DU2 - vector to store the second super diagonal of `U`, expects N-2 indexed elements
40+
* @param {NonNegativeInteger} N - number of rows/columns in `A`
41+
* @param {Float64Array} DL - the first sub diagonal of `A`, expects N-1 indexed elements
42+
* @param {Float64Array} D - the diagonal of `A`, expects N indexed elements
43+
* @param {Float64Array} DU - the first super-diagonal of `A`, expects N-1 indexed elements
44+
* @param {Float64Array} DU2 - the second super-diagonal of `U`, expects N-2 indexed elements
4545
* @param {Int32Array} IPIV - vector of pivot indices, expects N indexed elements
4646
* @throws {RangeError} first argument must be a nonnegative integer
4747
* @returns {integer} status code

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,22 @@ var base = require( './base.js' );
3737
* - `DU2` is overwritten by the elements of the second super-diagonal of `U`.
3838
* - for `0 <= i < n`, row `i` of the matrix was interchanged with row `IPIV(i)`. `IPIV(i)` will always be either `i` or `i+1`; `IPIV(i) = i` indicates a row interchange was not required.
3939
*
40-
* @param {NonNegativeInteger} N - order of matrix A
41-
* @param {Float64Array} DL - sub diagonal elements of A, expects N-1 indexed elements
42-
* @param {integer} sdl - stride length for `DL`
43-
* @param {NonNegativeInteger} odl - starting index of `DL`
44-
* @param {Float64Array} D - diagonal elements of A, expects N indexed elements
45-
* @param {integer} sd - stride length for `D`
46-
* @param {NonNegativeInteger} od - starting index of `D`
47-
* @param {Float64Array} DU - super diagonal elements of A, expects N-1 indexed elements
48-
* @param {integer} sdu - stride length for `DU`
49-
* @param {NonNegativeInteger} odu - starting index of `DU`
50-
* @param {Float64Array} DU2 - vector to store the second super diagonal of `U`, expects N-2 indexed elements
51-
* @param {integer} sdu2 - stride length for `DU2`
52-
* @param {NonNegativeInteger} odu2 - starting index of `DU2`
53-
* @param {Int32Array} IPIV - vector of pivot indices
54-
* @param {integer} si - stride length for `IPIV`
55-
* @param {NonNegativeInteger} oi - starting index of `IPIV`
40+
* @param {NonNegativeInteger} N - number of rows/columns in `A`
41+
* @param {Float64Array} DL - the first sub diagonal of `A`, expects N-1 indexed elements
42+
* @param {integer} strideDL - stride length for `DL`
43+
* @param {NonNegativeInteger} offsetDL - starting index of `DL`
44+
* @param {Float64Array} D - the diagonal of `A`, expects N indexed elements
45+
* @param {integer} strideD - stride length for `D`
46+
* @param {NonNegativeInteger} offsetD - starting index of `D`
47+
* @param {Float64Array} DU - the first super-diagonal of `A`, expects N-1 indexed elements
48+
* @param {integer} strideDU - stride length for `DU`
49+
* @param {NonNegativeInteger} offsetDU - starting index of `DU`
50+
* @param {Float64Array} DU2 - the second super-diagonal of `U`, expects N-2 indexed elements
51+
* @param {integer} strideDU2 - stride length for `DU2`
52+
* @param {NonNegativeInteger} offsetDU2 - starting index of `DU2`
53+
* @param {Int32Array} IPIV - vector of pivot indices, expects N indexed elements
54+
* @param {integer} strideIPIV - stride length for `IPIV`
55+
* @param {NonNegativeInteger} offsetIPIV - starting index of `IPIV`
5656
* @throws {RangeError} first argument must be a nonnegative integer
5757
* @returns {integer} status code
5858
*
@@ -72,11 +72,11 @@ var base = require( './base.js' );
7272
* // DU2 => <Float64Array>[ 0 ]
7373
* // IPIV => <Int32Array>[ 0, 1, 2 ]
7474
*/
75-
function dgttrf( N, DL, sdl, odl, D, sd, od, DU, sdu, odu, DU2, sdu2, odu2, IPIV, si, oi ) { // eslint-disable-line max-len, max-params
75+
function dgttrf( N, DL, strideDL, offsetDL, D, strideD, offsetD, DU, strideDU, offsetDU, DU2, strideDU2, offsetDU2, IPIV, strideIPIV, offsetIPIV ) { // eslint-disable-line max-len, max-params
7676
if ( N < 0 ) {
7777
throw new RangeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%d`.', N ) );
7878
}
79-
return base( N, DL, sdl, odl, D, sd, od, DU, sdu, odu, DU2, sdu2, odu2, IPIV, si, oi ); // eslint-disable-line max-len
79+
return base( N, DL, strideDL, offsetDL, D, strideD, offsetD, DU, strideDU, offsetDU, DU2, strideDU2, offsetDU2, IPIV, strideIPIV, offsetIPIV ); // eslint-disable-line max-len
8080
}
8181

8282

0 commit comments

Comments
 (0)