Skip to content

Commit fefbdef

Browse files
committed
chore: code review
--- 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: 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 bd9df6b commit fefbdef

File tree

8 files changed

+111
-110
lines changed

8 files changed

+111
-110
lines changed

lib/node_modules/@stdlib/lapack/base/dlascl/README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# dlascl
2222

23-
> LAPACK routine to multiply a real M by N matrix `A` by a real scalar `CTO/CFROM`.
23+
> LAPACK routine to multiply a double-precision floating-point M-by-N matrix `A` by a double-precision floating-point scalar.
2424
2525
<section class="usage">
2626

@@ -30,9 +30,9 @@ limitations under the License.
3030
var dlascl = require( '@stdlib/lapack/base/dlascl' );
3131
```
3232

33-
#### dlascl( order, type, KL, KU, CFROM, CTO, M, N, A, LDA )
33+
#### dlascl( order, type, KL, KU, γ, β, M, N, A, LDA )
3434

35-
Multiplies a real M by N matrix `A` by a real scalar `CTO/CFROM`.
35+
Multiplies a double-precision floating-point M-by-N matrix `A` by a double-precision floating-point scalar.
3636

3737
```javascript
3838
var Float64Array = require( '@stdlib/array/float64' );
@@ -46,11 +46,11 @@ dlascl( 'row-major', 'general', 0, 0, 1.0, 2.0, 3, 2, A, 2 );
4646
The function has the following parameters:
4747

4848
- **order**: storage layout.
49-
- **type**: specifies the type of matrix `A` ( should be one of these: `general`, `upper`, `lower`, `upper-hessenberg`, `symmetric-banded-lower`, `symmetric-banded-upper` or `banded` ).
50-
- **KL**: lower band width of `A`. Referenced only if type is `symmetric-banded-lower` or `banded`.
51-
- **KU**: upper band width of `A`. Referenced only if type is `symmetric-banded-upper` or `banded`.
52-
- **CFROM**: the matrix `A` is multiplied by `CTO / CFROM`.
53-
- **CTO**: the matrix `A` is multiplied by `CTO / CFROM`.
49+
- **type**: specifies the type of matrix `A`. Must be one of the following: `'general'`, `'upper'`, `'lower'`, `'upper-hessenberg'`, `'symmetric-banded-lower'`, `'symmetric-banded-upper'`, or `'banded'`.
50+
- **KL**: lower bandwidth of `A` (i.e., the number of sub-diagonals). Referenced only if type is `'symmetric-banded-lower'` or `'banded'`.
51+
- **KU**: upper bandwidth of `A` (i.e., the number of super-diagonals). Referenced only if type is `'symmetric-banded-upper'` or `'banded'`.
52+
- **γ**: the matrix `A` is multiplied by `β/γ`.
53+
- **β**: the matrix `A` is multiplied by `β/γ`.
5454
- **M**: number of rows in matrix `A`.
5555
- **N**: number of columns in matrix `A`.
5656
- **A**: input [`Float64Array`][mdn-float64array].
@@ -65,19 +65,19 @@ Note that indexing is relative to the first index. To introduce an offset, use [
6565
```javascript
6666
var Float64Array = require( '@stdlib/array/float64' );
6767

68-
// Initial arrays...
68+
// Initial array:
6969
var A0 = new Float64Array( [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
7070

71-
// Create offset views...
71+
// Create offset view:
7272
var A1 = new Float64Array( A0.buffer, A0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
7373

7474
dlascl( 'row-major', 'general', 0, 0, 1.0, 2.0, 3, 2, A1, 2 );
7575
// A0 => <Float64Array>[ 0.0, 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
7676
```
7777

78-
#### dlascl.ndarray( type, KL, KU, CFROM, CTO, M, N, A, strideA1, strideA2, offsetA )
78+
#### dlascl.ndarray( type, KL, KU, γ, β, M, N, A, strideA1, strideA2, offsetA )
7979

80-
Multiplies a real M by N matrix `A` by a real scalar `CTO/CFROM` using alternative indexing semantics.
80+
Multiplies a double-precision floating-point M-by-N matrix `A` by a double-precision floating-point scalar using alternative indexing semantics.
8181

8282
```javascript
8383
var Float64Array = require( '@stdlib/array/float64' );
@@ -88,13 +88,13 @@ dlascl.ndarray( 'general', 0, 0, 1.0, 2.0, 3, 2, A, 2, 1, 0 );
8888
// A => <Float64Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
8989
```
9090

91-
The function has the following additional parameters:
91+
The function has the following parameters:
9292

93-
- **type**: specifies the type of matrix `A` ( should be one of these: `general`, `upper`, `lower`, `upper-hessenberg`, `symmetric-banded-lower`, `symmetric-banded-upper` or `banded` ).
94-
- **KL**: lower band width of `A`. Referenced only if type is `symmetric-banded-lower` or `banded`.
95-
- **KU**: upper band width of `A`. Referenced only if type is `symmetric-banded-upper` or `banded`.
96-
- **CFROM**: the matrix `A` is multiplied by `CTO / CFROM`.
97-
- **CTO**: the matrix `A` is multiplied by `CTO / CFROM`.
93+
- **type**: specifies the type of matrix `A`. Must be one of the following: `'general'`, `'upper'`, `'lower'`, `'upper-hessenberg'`, `'symmetric-banded-lower'`, `'symmetric-banded-upper'`, or `'banded'`.
94+
- **KL**: lower bandwidth of `A` (i.e., the number of sub-diagonals). Referenced only if type is `'symmetric-banded-lower'` or `'banded'`.
95+
- **KU**: upper bandwidth of `A` (i.e., the number of super-diagonals). Referenced only if type is `'symmetric-banded-upper'` or `'banded'`.
96+
- **γ**: the matrix `A` is multiplied by `β/γ`.
97+
- **β**: the matrix `A` is multiplied by `β/γ`.
9898
- **M**: number of rows in matrix `A`.
9999
- **N**: number of columns in matrix `A`.
100100
- **A**: input [`Float64Array`][mdn-float64array].

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

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
{{alias}}( order, type, KL, KU, CFROM, CTO, M, N, A, LDA )
2-
Multiplies a real M by N matrix `A` by a real scalar `CTO/CFROM`.
1+
{{alias}}( order, type, KL, KU, γ, β, M, N, A, LDA )
2+
Multiplies a double-precision floating-point M-by-N matrix `A` by a
3+
double-precision floating-point scalar.
34

45
Indexing is relative to the first index. To introduce an offset, use
56
typed array views.
@@ -13,30 +14,30 @@
1314
type: string
1415
Specifies the type of matrix `A`.
1516

16-
KL: nonNegativeInteger
17-
Lower band width of `A`. Referenced only if type is
18-
`symmetric-banded-lower` or `banded`.
17+
KL: integer
18+
Lower bandwidth of `A` (i.e., the number of sub-diagonals). Referenced
19+
only if type is `symmetric-banded-lower` or `banded`.
1920

20-
KU: nonNegativeInteger
21-
Upper band width of `A`. Referenced only if type is
22-
`symmetric-banded-upper` or `banded`.
21+
KU: integer
22+
Upper bandwidth of `A` (i.e., the number of super-diagonals). Referenced
23+
only if type is `symmetric-banded-upper` or `banded`.
2324

24-
CFROM: number
25-
The matrix `A` are multiplied by `CTO / CFROM`.
25+
γ: number
26+
The matrix `A` is multiplied by `β/γ`.
2627

27-
CTO: number
28-
The matrix `A` are multiplied by `CTO / CFROM`.
28+
β: number
29+
The matrix `A` is multiplied by `β/γ`.
2930

30-
M: nonNegativeInteger
31+
M: integer
3132
Number of rows in matrix `A`.
3233

33-
N: nonNegativeInteger
34+
N: integer
3435
Number of columns in matrix `A`.
3536

3637
A: Float64Array
3738
Input matrix `A`.
3839

39-
LDA: positiveInteger
40+
LDA: integer
4041
Stride of the first dimension of `A` (a.k.a., leading dimension of
4142
the matrix `A`).
4243

@@ -52,9 +53,9 @@
5253
<Float64Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
5354

5455

55-
{{alias}}.ndarray( type, KL, KU, CFROM, CTO, M, N, A, sa1, sa2, oa )
56-
Multiplies a real M by N matrix `A` by a real scalar `CTO/CFROM` using
57-
alternative indexing semantics.
56+
{{alias}}.ndarray( type, KL, KU, γ, β, M, N, A, sa1, sa2, oa )
57+
Multiplies a double-precision floating-point M-by-N matrix `A` by a
58+
double-precision floating-point scalar using alternative indexing semantics.
5859

5960
While typed array views mandate a view offset based on the underlying
6061
buffer, the offset parameters support indexing semantics based on starting
@@ -65,24 +66,24 @@
6566
type: string
6667
Specifies the type of matrix `A`.
6768

68-
KL: nonNegativeInteger
69-
Lower band width of `A`. Referenced only if type is
70-
`symmetric-banded-lower` or `banded`.
69+
KL: integer
70+
Lower bandwidth of `A` (i.e., the number of sub-diagonals). Referenced
71+
only if type is `symmetric-banded-lower` or `banded`.
7172

72-
KU: nonNegativeInteger
73-
Upper band width of `A`. Referenced only if type is
74-
`symmetric-banded-upper` or `banded`.
73+
KU: integer
74+
Upper bandwidth of `A` (i.e., the number of super-diagonals). Referenced
75+
only if type is `symmetric-banded-upper` or `banded`.
7576

76-
CFROM: number
77-
The matrix `A` are multiplied by `CTO / CFROM`.
77+
γ: number
78+
The matrix `A` is multiplied by `β/γ`.
7879

79-
CTO: number
80-
The matrix `A` are multiplied by `CTO / CFROM`.
80+
β: number
81+
The matrix `A` is multiplied by `β/γ`.
8182

82-
M: nonNegativeInteger
83+
M: integer
8384
Number of rows in matrix `A`.
8485

85-
N: nonNegativeInteger
86+
N: integer
8687
Number of columns in matrix `A`.
8788

8889
A: Float64Array
@@ -94,7 +95,7 @@
9495
sa2: integer
9596
Stride of the second dimension of `A`.
9697

97-
oa: nonNegativeInteger
98+
oa: integer
9899
Starting index for `A`.
99100

100101
Returns

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

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ import { Layout } from '@stdlib/types/blas';
2727
*/
2828
interface Routine {
2929
/**
30-
* Multiplies a real M by N matrix `A` by a real scalar `CTO/CFROM`.
30+
* Multiplies a double-precision floating-point M-by-N matrix `A` by a double-precision floating-point scalar.
3131
*
3232
* @param order - storage layout
33-
* @param type - specifies the type of matrix `A`
34-
* @param KL - lower band width of `A`. Referenced only if type is `symmetric-banded-lower` or `banded`.
35-
* @param KU - upper band width of `A`. Referenced only if type is `symmetric-banded-upper` or `banded`.
36-
* @param CFROM - the matrix `A` is multiplied by `CTO / CFROM`
37-
* @param CTO - the matrix `A` is multiplied by `CTO / CFROM`
33+
* @param type - specifies the type of matrix `A`. Must be one of the following: `'general'`, `'upper'`, `'lower'`, `'upper-hessenberg'`, `'symmetric-banded-lower'`, `'symmetric-banded-upper'`, or `'banded'`.
34+
* @param KL - lower bandwidth of `A` (i.e., the number of sub-diagonals). Referenced only if type is `'symmetric-banded-lower'` or `'banded'`.
35+
* @param KU - upper bandwidth of `A` (i.e., the number of super-diagonals). Referenced only if type is `'symmetric-banded-upper'` or `'banded'`.
36+
* @param gamma - the matrix `A` is multiplied by `β/γ`
37+
* @param beta - the matrix `A` is multiplied by `β/γ`
3838
* @param M - number of rows in matrix `A`
3939
* @param N - number of columns in matrix `A`
4040
* @param A - input matrix
@@ -49,16 +49,16 @@ interface Routine {
4949
* dlascl( 'row-major', 'general', 0, 0, 1.0, 2.0, 3, 2, A, 2 );
5050
* // A => <Float64Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
5151
*/
52-
( order: Layout, type: string, KL: number, KU: number, CFROM: number, CTO: number, M: number, N: number, A: Float64Array, LDA: number ): Float64Array;
52+
( order: Layout, type: string, KL: number, KU: number, gamma: number, beta: number, M: number, N: number, A: Float64Array, LDA: number ): Float64Array;
5353

5454
/**
55-
* Multiplies a real M by N matrix `A` by a real scalar `CTO/CFROM` using alternative indexing semantics.
55+
* Multiplies a double-precision floating-point M-by-N matrix `A` by a double-precision floating-point scalar using alternative indexing semantics.
5656
*
57-
* @param type - specifies the type of matrix `A`
58-
* @param KL - lower band width of `A`. Referenced only if type is `symmetric-banded-lower` or `banded`.
59-
* @param KU - upper band width of `A`. Referenced only if type is `symmetric-banded-upper` or `banded`.
60-
* @param CFROM - the matrix `A` is multiplied by `CTO / CFROM`
61-
* @param CTO - the matrix `A` is multiplied by `CTO / CFROM`
57+
* @param type - specifies the type of matrix `A`. Must be one of the following: `'general'`, `'upper'`, `'lower'`, `'upper-hessenberg'`, `'symmetric-banded-lower'`, `'symmetric-banded-upper'`, or `'banded'`.
58+
* @param KL - lower bandwidth of `A` (i.e., the number of sub-diagonals). Referenced only if type is `'symmetric-banded-lower'` or `'banded'`.
59+
* @param KU - upper bandwidth of `A` (i.e., the number of super-diagonals). Referenced only if type is `'symmetric-banded-upper'` or `'banded'`.
60+
* @param gamma - the matrix `A` is multiplied by `β/γ`
61+
* @param beta - the matrix `A` is multiplied by `β/γ`
6262
* @param M - number of rows in matrix `A`
6363
* @param N - number of columns in matrix `A`
6464
* @param A - input matrix
@@ -75,18 +75,18 @@ interface Routine {
7575
* dlascl.ndarray( 'general', 0, 0, 1.0, 2.0, 3, 2, A, 2, 1, 0 );
7676
* // A => <Float64Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
7777
*/
78-
ndarray( type: string, KL: number, KU: number, CFROM: number, CTO: number, M: number, N: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number ): Float64Array;
78+
ndarray( type: string, KL: number, KU: number, gamma: number, beta: number, M: number, N: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number ): Float64Array;
7979
}
8080

8181
/**
82-
* Multiplies a real M by N matrix `A` by a real scalar `CTO/CFROM`.
82+
* Multiplies a double-precision floating-point M-by-N matrix `A` by a double-precision floating-point scalar.
8383
*
8484
* @param order - storage layout
85-
* @param type - specifies the type of matrix `A`
86-
* @param KL - lower band width of `A`. Referenced only if type is `symmetric-banded-lower` or `banded`.
87-
* @param KU - upper band width of `A`. Referenced only if type is `symmetric-banded-upper` or `banded`.
88-
* @param CFROM - the matrix `A` is multiplied by `CTO / CFROM`
89-
* @param CTO - the matrix `A` is multiplied by `CTO / CFROM`
85+
* @param type - specifies the type of matrix `A`. Must be one of the following: `'general'`, `'upper'`, `'lower'`, `'upper-hessenberg'`, `'symmetric-banded-lower'`, `'symmetric-banded-upper'`, or `'banded'`.
86+
* @param KL - lower bandwidth of `A` (i.e., the number of sub-diagonals). Referenced only if type is `'symmetric-banded-lower'` or `'banded'`.
87+
* @param KU - upper bandwidth of `A` (i.e., the number of super-diagonals). Referenced only if type is `'symmetric-banded-upper'` or `'banded'`.
88+
* @param gamma - the matrix `A` is multiplied by `β/γ`
89+
* @param beta - the matrix `A` is multiplied by `β/γ`
9090
* @param M - number of rows in matrix `A`
9191
* @param N - number of columns in matrix `A`
9292
* @param A - input matrix

0 commit comments

Comments
 (0)