Skip to content

Commit e49863a

Browse files
refactor: rename routine to follow standard
--- 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: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - 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 196b32b commit e49863a

27 files changed

Lines changed: 488 additions & 514 deletions

File tree

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ limitations under the License.
1818
1919
-->
2020

21-
# dla_gbrpvgrw
21+
# dlagbrpvgrw
2222

2323
> LAPACK routine to computes the reciprocal pivot growth factor norm(A)/norm(U) for a general banded matrix `A`.
2424
2525
<section class="intro">
2626

27-
The `dla_gbrpvgrw` routine computes the reciprocal pivot growth factor for a general banded matrix `A`. The factorization has the form:
27+
The `dlagbrpvgrw` routine computes the reciprocal pivot growth factor for a general banded matrix `A`. The factorization has the form:
2828

2929
<!-- <equation class="equation" label="eq:rpg_factor" align="center" raw="RPGFactor = norm(A) / norm(U)" alt="Equation for calculating RPG Factor."> -->
3030

@@ -47,16 +47,16 @@ The `dla_gbrpvgrw` routine computes the reciprocal pivot growth factor for a gen
4747
<!-- eslint-disable camelcase max-len -->
4848

4949
```javascript
50-
var dla_gbrpvgrw = require( '@stdlib/lapack/base/dla_gbrpvgrw' );
50+
var dlagbrpvgrw = require( '@stdlib/lapack/base/dla-gbrpvgrw' );
5151
```
5252

53-
#### dla_gbrpvgrw( order, N, KL, KU, NCOLS, AB, LDAB, AFB, LDAFB )
53+
#### dlagbrpvgrw( order, N, KL, KU, NCOLS, AB, LDAB, AFB, LDAFB )
5454

5555
Computes the reciprocal pivot growth factor norm(A)/norm(U) for a general banded matrix `A`.
5656

5757
```javascript
5858
var Float64Array = require( '@stdlib/array/float64' );
59-
var dla_gbrpvgrw = require( '@stdlib/lapack/base/dla_gbrpvgrw' );
59+
var dlagbrpvgrw = require( '@stdlib/lapack/base/dla-gbrpvgrw' );
6060

6161
/*
6262
A = [
@@ -70,8 +70,8 @@ var dla_gbrpvgrw = require( '@stdlib/lapack/base/dla_gbrpvgrw' );
7070
var AB = new Float64Array( [ 0.0, 2.0, 5.0, 8.0, 1.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 0.0 ] );
7171
var AFB = new Float64Array( [ 0.0, 0.0, 5.0, 8.0, 0.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 1.8272, 0.3333, 0.1111, -0.2716, 0.0 ] );
7272

73-
dla_gbrpvgrw( 'row-major', 4, 1, 1, 4, AB, 3, AFB, 4 );
74-
// 1.0
73+
var out = dlagbrpvgrw( 'row-major', 4, 1, 1, 4, AB, 3, AFB, 4 );
74+
// returns 1.0
7575
```
7676

7777
The function has the following parameters:
@@ -94,7 +94,7 @@ Note that indexing is relative to the first index. To introduce an offset, use [
9494

9595
```javascript
9696
var Float64Array = require( '@stdlib/array/float64' );
97-
var dla_gbrpvgrw = require( '@stdlib/lapack/base/dla_gbrpvgrw' );
97+
var dlagbrpvgrw = require( '@stdlib/lapack/base/dla-gbrpvgrw' );
9898

9999
// Initial arrays...
100100
var AB0 = new Float64Array( [ 0.0, 0.0, 2.0, 5.0, 8.0, 1.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 0.0 ] );
@@ -113,19 +113,19 @@ var AFB0 = new Float64Array( [ 0.0, 0.0, 0.0, 5.0, 8.0, 0.0, 4.0, 7.0, 10.0, 3.0
113113
var AB = new Float64Array( AB0.buffer, AB0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
114114
var AFB = new Float64Array( AFB0.buffer, AFB0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
115115

116-
dla_gbrpvgrw( 'row-major', 4, 1, 1, 4, AB, 3, AFB, 4 );
117-
// 1.0
116+
var out = dlagbrpvgrw( 'row-major', 4, 1, 1, 4, AB, 3, AFB, 4 );
117+
// returns 1.0
118118
```
119119

120120
<!-- lint disable maximum-heading-length -->
121121

122-
#### dla_gbrpvgrw.ndarray( N, KL, KU, NCOLS, AB, strideAB1, strideAB2, offsetAB, AFB, strideAFB1, strideAFB2, offsetAFB )
122+
#### dlagbrpvgrw.ndarray( N, KL, KU, NCOLS, AB, strideAB1, strideAB2, offsetAB, AFB, strideAFB1, strideAFB2, offsetAFB )
123123

124124
Computes the reciprocal pivot growth factor norm(A)/norm(U) for a general banded matrix `A` using alternative indexing semantics.
125125

126126
```javascript
127127
var Float64Array = require( '@stdlib/array/float64' );
128-
var dla_gbrpvgrw = require( '@stdlib/lapack/base/dla_gbrpvgrw' );
128+
var dlagbrpvgrw = require( '@stdlib/lapack/base/dla-gbrpvgrw' );
129129

130130
/*
131131
A = [
@@ -139,8 +139,8 @@ var dla_gbrpvgrw = require( '@stdlib/lapack/base/dla_gbrpvgrw' );
139139
var AB = new Float64Array( [ 0.0, 2.0, 5.0, 8.0, 1.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 0.0 ] );
140140
var AFB = new Float64Array( [ 0.0, 0.0, 5.0, 8.0, 0.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 1.8272, 0.3333, 0.1111, -0.2716, 0.0 ] );
141141

142-
dla_gbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 0, AFB, 4, 1, 0 );
143-
// 1.0
142+
var out = dlagbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 0, AFB, 4, 1, 0 );
143+
// returns 1.0
144144
```
145145

146146
The function has the following parameters:
@@ -164,7 +164,7 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
164164

165165
```javascript
166166
var Float64Array = require( '@stdlib/array/float64' );
167-
var dla_gbrpvgrw = require( '@stdlib/lapack/base/dla_gbrpvgrw' );
167+
var dlagbrpvgrw = require( '@stdlib/lapack/base/dla-gbrpvgrw' );
168168

169169
/*
170170
A = [
@@ -178,8 +178,8 @@ var dla_gbrpvgrw = require( '@stdlib/lapack/base/dla_gbrpvgrw' );
178178
var AB = new Float64Array( [ 0.0, 0.0, 2.0, 5.0, 8.0, 1.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 0.0 ] );
179179
var AFB = new Float64Array( [ 0.0, 0.0, 0.0, 5.0, 8.0, 0.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 1.8272, 0.3333, 0.1111, -0.2716, 0.0 ] );
180180

181-
dla_gbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 1, AFB, 4, 1, 1 );
182-
// 1.0
181+
var out = dlagbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 1, AFB, 4, 1, 1 );
182+
// returns 1.0
183183
```
184184

185185
</section>
@@ -194,7 +194,7 @@ dla_gbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 1, AFB, 4, 1, 1 );
194194
- 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.
195195
- The leading dimension of `AB`, `LDAB` >= KL+KU+1.
196196
- The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
197-
- `dla_gbrpvgrw()` corresponds to the [LAPACK][LAPACK] function [`dla_gbrpvgrw`][lapack-dla_gbrpvgrw].
197+
- `dlagbrpvgrw()` corresponds to the [LAPACK][LAPACK] function [`dlagbrpvgrw`][lapack-dlagbrpvgrw].
198198

199199
</section>
200200

@@ -211,7 +211,7 @@ dla_gbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 1, AFB, 4, 1, 1 );
211211
```javascript
212212
var Float64Array = require( '@stdlib/array/float64' );
213213
var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
214-
var dla_gbrpvgrw = require( '@stdlib/lapack/base/dla_gbrpvgrw' );
214+
var dlagbrpvgrw = require( '@stdlib/lapack/base/dla-gbrpvgrw' );
215215

216216
var N = 4;
217217
var KL = 1;
@@ -230,7 +230,7 @@ console.log( 'The matrix `AFB` containing the details of the LU factorization of
230230
console.log( ndarray2array( AFB, [ LDAFB, N ], [ N, 1 ], 0, 'row-major' ) );
231231

232232
console.log( 'The reciprocal pivot growth factor norm(A)/norm(U) for `AB`:' );
233-
console.log( dla_gbrpvgrw( 'row-major', N, KL, KU, NCOLS, AB, LDAB, AFB, LDAFB ) );
233+
console.log( dlagbrpvgrw( 'row-major', N, KL, KU, NCOLS, AB, LDAB, AFB, LDAFB ) );
234234
```
235235

236236
</section>
@@ -321,7 +321,7 @@ TODO
321321

322322
[lapack]: https://www.netlib.org/lapack/explore-html/
323323

324-
[lapack-dla_gbrpvgrw]: https://netlib.org/lapack/explore-html//d1/ddf/group__la__gbrpvgrw_ga8475794e57172d20803e770faa7d4543.html
324+
[lapack-dlagbrpvgrw]: https://netlib.org/lapack/explore-html//d1/ddf/group__la__gbrpvgrw_ga8475794e57172d20803e770faa7d4543.html
325325

326326
[mdn-float64array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array
327327

lib/node_modules/@stdlib/lapack/base/dla_gbrpvgrw/benchmark/benchmark.js renamed to lib/node_modules/@stdlib/lapack/base/dla-gbrpvgrw/benchmark/benchmark.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var pow = require( '@stdlib/math/base/special/pow' );
2929
var floor = require( '@stdlib/math/base/special/floor' );
3030
var format = require( '@stdlib/string/format' );
3131
var pkg = require( './../package.json' ).name;
32-
var dla_gbrpvgrw = require( './../lib/dla_gbrpvgrw.js' );
32+
var dla_gbrpvgrw = require( './../lib/dlagbrpvgrw.js' );
3333

3434

3535
// VARIABLES //
@@ -59,7 +59,6 @@ function createBenchmark( order, N ) {
5959
'dtype': 'float64'
6060
};
6161

62-
// Random input matrix;
6362
AFB = uniform( 4*N*N, -1.0, 1.0, opts );
6463
AB = uniform( 4*N*N, -1.0, 1.0, opts );
6564

@@ -116,7 +115,7 @@ function main() {
116115
for ( i = min; i <= max; i++ ) {
117116
N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
118117
f = createBenchmark( ord, N );
119-
bench( format( '%s:order=%s,size=%d', pkg, ord, (N*N) ), f );
118+
bench( format( '%s:order=%s,size=%d', pkg, ord, N*N ), f );
120119
}
121120
}
122121
}

lib/node_modules/@stdlib/lapack/base/dla_gbrpvgrw/benchmark/benchmark.ndarray.js renamed to lib/node_modules/@stdlib/lapack/base/dla-gbrpvgrw/benchmark/benchmark.ndarray.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ function main() {
125125
for ( i = min; i <= max; i++ ) {
126126
N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
127127
f = createBenchmark( ord, N );
128-
bench( format( '%s:ndarray:order=%s,size=%d', pkg, ord, (N*N) ), f );
128+
bench( format( '%s:ndarray:order=%s,size=%d', pkg, ord, N*N ), f );
129129
}
130130
}
131131
}

lib/node_modules/@stdlib/lapack/base/dla_gbrpvgrw/docs/repl.txt renamed to lib/node_modules/@stdlib/lapack/base/dla-gbrpvgrw/docs/repl.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
{{alias}}( order, N, KL, KU, NCOLS, AB, LDAB, AFB, LDAFB )
23
Computes the reciprocal pivot growth factor norm(A)/norm(U) for a
34
general banded matrix `A`.

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

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import { Layout } from '@stdlib/types/blas';
2424

2525
/**
26-
* Interface describing `dla_gbrpvgrw`.
26+
* Interface describing `dla-gbrpvgrw`.
2727
*/
2828
interface Routine {
2929
/**
@@ -32,9 +32,9 @@ interface Routine {
3232
* ## Notes
3333
*
3434
* - 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.
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.
3636
* - The leading dimension of `AB`, `LDAB` >= KL+KU+1.
37-
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
37+
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
3838
*
3939
* @param order - order of matrix `A`
4040
* @param N - number of rows in matrix `A`
@@ -49,13 +49,12 @@ interface Routine {
4949
*
5050
* @example
5151
* var Float64Array = require( '@stdlib/array/float64' );
52-
* var Int32Array = require( '@stdlib/array/int32' );
5352
*
5453
* var AB = new Float64Array( [ 0.0, 2.0, 5.0, 8.0, 1.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 0.0 ] );
5554
* var AFB = new Float64Array( [ 0.0, 0.0, 5.0, 8.0, 0.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 1.8272, 0.3333, 0.1111, -0.2716, 0.0 ] );
5655
*
57-
* dla_gbrpvgrw( 'row-major', 4, 1, 1, 4, AB, 3, AFB, 4 );
58-
* // 1.0
56+
* var out = dlagbrpvgrw( 'row-major', 4, 1, 1, 4, AB, 3, AFB, 4 );
57+
* // returns 1.0
5958
*/
6059
( order: Layout, N: number, KL: number, KU: number, NCOLS: number, AB: Float64Array, LDAB: number, AFB: Float64Array, LDAFB: number ): number;
6160

@@ -65,9 +64,9 @@ interface Routine {
6564
* ## Notes
6665
*
6766
* - 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).
68-
* - 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.
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.
6968
* - The leading dimension of `AB`, `LDAB` >= KL+KU+1.
70-
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
69+
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
7170
*
7271
* @param N - number of rows in matrix `A`
7372
* @param KL - number of subdiagonals within the band of matrix `A`
@@ -85,13 +84,12 @@ interface Routine {
8584
*
8685
* @example
8786
* var Float64Array = require( '@stdlib/array/float64' );
88-
* var Int32Array = require( '@stdlib/array/int32' );
8987
*
9088
* var AB = new Float64Array( [ 0.0, 2.0, 5.0, 8.0, 1.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 0.0 ] );
9189
* var AFB = new Float64Array( [ 0.0, 0.0, 5.0, 8.0, 0.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 1.8272, 0.3333, 0.1111, -0.2716, 0.0 ] );
9290
*
93-
* dla_gbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 0, AFB, 4, 1, 0 );
94-
* // 1.0
91+
* var out = dlagbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 0, AFB, 4, 1, 0 );
92+
* // returns 1.0
9593
*/
9694
ndarray( N: number, KL: number, KU: number, NCOLS: number, AB: Float64Array, strideAB1: number, strideAB2: number, offsetAB: number, AFB: Float64Array, strideAFB1: number, strideAFB2: number, offsetAFB: number ): number; // eslint-disable-line max-len
9795
}
@@ -102,9 +100,9 @@ interface Routine {
102100
* ## Notes
103101
*
104102
* - 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).
105-
* - 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.
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.
106104
* - The leading dimension of `AB`, `LDAB` >= KL+KU+1.
107-
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
105+
* - The leading dimension of `AFB`, `LDAFB` >= 2*KL+KU+1.
108106
*
109107
* @param order - order of matrix `A`
110108
* @param N - number of rows in matrix `A`
@@ -119,27 +117,25 @@ interface Routine {
119117
*
120118
* @example
121119
* var Float64Array = require( '@stdlib/array/float64' );
122-
* var Int32Array = require( '@stdlib/array/int32' );
123120
*
124121
* var AB = new Float64Array( [ 0.0, 2.0, 5.0, 8.0, 1.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 0.0 ] );
125122
* var AFB = new Float64Array( [ 0.0, 0.0, 5.0, 8.0, 0.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 1.8272, 0.3333, 0.1111, -0.2716, 0.0 ] );
126123
*
127-
* dla_gbrpvgrw( 'row-major', 4, 1, 1, 4, AB, 3, AFB, 4 );
128-
* // 1.0
124+
* var out = dlagbrpvgrw( 'row-major', 4, 1, 1, 4, AB, 3, AFB, 4 );
125+
* // returns 1.0
129126
*
130127
* @example
131128
* var Float64Array = require( '@stdlib/array/float64' );
132-
* var Int32Array = require( '@stdlib/array/int32' );
133129
*
134130
* var AB = new Float64Array( [ 0.0, 2.0, 5.0, 8.0, 1.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 0.0 ] );
135131
* var AFB = new Float64Array( [ 0.0, 0.0, 5.0, 8.0, 0.0, 4.0, 7.0, 10.0, 3.0, 6.0, 9.0, 1.8272, 0.3333, 0.1111, -0.2716, 0.0 ] );
136132
*
137-
* dla_gbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 0, AFB, 4, 1, 0 );
138-
* // 1.0
133+
* var out = dlagbrpvgrw.ndarray( 4, 1, 1, 4, AB, 4, 1, 0, AFB, 4, 1, 0 );
134+
* // returns 1.0
139135
*/
140-
declare var dla_gbrpvgrw: Routine;
136+
declare var dlagbrpvgrw: Routine;
141137

142138

143139
// EXPORTS //
144140

145-
export = dla_gbrpvgrw;
141+
export = dlagbrpvgrw;

0 commit comments

Comments
 (0)