Skip to content

Commit 8ecacc5

Browse files
aayush0325aayush0325
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 477c0ea commit 8ecacc5

File tree

8 files changed

+60
-60
lines changed

8 files changed

+60
-60
lines changed

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

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

2121
# dlarf1f
2222

23-
> Apply a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C`.
23+
> Apply a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.
2424
2525
<section class="intro">
2626

@@ -40,7 +40,7 @@ var dlarf1f = require( '@stdlib/lapack/base/dlarf1f' );
4040

4141
#### dlarf1f( order, side, M, N, V, incv, tau, C, LDC, work )
4242

43-
Applies a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C`.
43+
Applies a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.
4444

4545
<!-- eslint-disable max-len -->
4646

@@ -58,20 +58,20 @@ var out = dlarf1f( 'row-major', 'left', 4, 3, V, 1, 1.0, C, 3, work );
5858
The function has the following parameters:
5959

6060
- **order**: storage layout.
61-
- **side**: specifies the side of multiplication with `C`. Use `left` to form `H * C` and `right` to from `C * H`.
61+
- **side**: specifies the side of multiplication with `C`. Use `'left'` to form `H * C` and `'right'` to form `C * H`.
6262
- **M**: number of rows in `C`.
6363
- **N**: number of columns in `C`.
64-
- **V**: the vector `v` in the representation of `H` as a [`Float64Array`][mdn-float64array].
64+
- **V**: the vector `v` as a [`Float64Array`][mdn-float64array].
6565
- **incv**: stride length for `V`. If `incv` is negative, the elements of `V` are accessed in reverse order.
66-
- **tau**: the value of `tau` in representation of `H`.
66+
- **tau**: scalar constant.
6767
- **C**: input matrix stored in linear memory as a [`Float64Array`][mdn-float64array].
6868
- **LDC**: stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`).
6969
- **work**: workspace [`Float64Array`][mdn-float64array].
7070

7171
Based on the `side` of multiplication, the expected storage of the array changes:
7272

73-
- `work` should have `N` indexed elements if `side` = `left` and `M` indexed elements if `side` = `right`.
74-
- `V` should have `1 + (M-1) * abs(incv)` indexed elements if `side` = `left` and `1 + (N-1) * abs(incv)` indexed elements if `side` = `right`.
73+
- `work` should have `N` indexed elements if `side` = `'left'` and `M` indexed elements if `side` = `'right'`.
74+
- `V` should have `1 + (M-1) * abs(incv)` indexed elements if `side` = `'left'` and `1 + (N-1) * abs(incv)` indexed elements if `side` = `'right'`.
7575

7676
The sign of the increment parameter `incv` determines the order in which elements of `V` are accessed. For example, to access elements in reverse order,
7777

@@ -126,7 +126,7 @@ var our = dlarf1f( 'row-major', 'left', 4, 3, V1, 1, 1.0, C1, 3, work1 );
126126

127127
#### dlarf1f.ndarray( side, M, N, V, sv, ov, tau, C, sc1, sc2, oc, work, sw, ow )
128128

129-
Applies a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C` using alternative indexing semantics.
129+
Applies a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C` using alternative indexing semantics.
130130

131131
<!-- eslint-disable max-len -->
132132

@@ -143,13 +143,13 @@ var out = dlarf1f.ndarray( 'left', 4, 3, V, 1, 0, 1.0, C, 3, 1, 0, work, 1, 0 );
143143

144144
The function has the following additional parameters:
145145

146-
- **side**: specifies the side of multiplication with `C`. Use `left` to form `H * C` and `right` to from `C * H`.
146+
- **side**: specifies the side of multiplication with `C`. Use `'left'` to form `H * C` and `'right'` to form `C * H`.
147147
- **M**: number of rows in `C`.
148148
- **N**: number of columns in `C`.
149-
- **V**: the vector `v` in the representation of `H` as a [`Float64Array`][mdn-float64array].
149+
- **V**: the vector `v` as a [`Float64Array`][mdn-float64array].
150150
- **sv**: stride length for `V`.
151151
- **ov**: starting index for `V`.
152-
- **tau**: the value of `tau` in representation of `H`.
152+
- **tau**: scalar constant.
153153
- **C**: input matrix as a [`Float64Array`][mdn-float64array].
154154
- **sc1**: stride of the first dimension of `C`.
155155
- **sc2**: stride of the second dimension of `C`.
@@ -160,8 +160,8 @@ The function has the following additional parameters:
160160

161161
Based on the `side` of multiplication, the expected storage of the array changes:
162162

163-
- `work` should have `N` indexed elements if `side` = `left` and `M` indexed elements if `side` = `right`.
164-
- `V` should have `1 + (M-1) * abs(incv)` indexed elements if `side` = `left` and `1 + (N-1) * abs(incv)` indexed elements if `side` = `right`.
163+
- `work` should have `N` indexed elements if `side` = `'left'` and `M` indexed elements if `side` = `'right'`.
164+
- `V` should have `1 + (M-1) * abs(incv)` indexed elements if `side` = `'left'` and `1 + (N-1) * abs(incv)` indexed elements if `side` = `'right'`.
165165

166166
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,
167167

@@ -186,7 +186,7 @@ var out = dlarf1f.ndarray( 'left', 4, 3, V, 1, 2, 1.0, C, 3, 1, 4, work, 1, 0 );
186186

187187
## Notes
188188

189-
- `C` is overwritten by `H * C` if side = `left` and `C * H` if side = `right`.
189+
- `C` is overwritten by `H * C` if side = `'left'` and `C * H` if side = `'right'`.
190190
- `dlarf1f()` corresponds to the [LAPACK][LAPACK] function [`dlarf1f`][lapack-dlarf1f].
191191

192192
</section>

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( order, side, M, N, V, incv, tau, C, LDC, work )
3-
Applies a real elementary reflector `H = I - tau * v * v ^ T` to a
3+
Applies a real elementary reflector `H = I - tau * v * v^T` to a
44
real M by N matrix `C`.
55

66
Parameters
@@ -9,8 +9,8 @@
99
Storage layout. Must be either 'row-major' or 'column-major'.
1010

1111
side: string
12-
Specifies the side of multiplication with `C`. Use `left` to form
13-
`H * C` and `right` to from `C * H`.
12+
Specifies the side of multiplication with `C`. Use `'left'` to form
13+
`H * C` and `'right'` to form `C * H`.
1414

1515
M: integer
1616
Number of rows in `C`.
@@ -25,7 +25,7 @@
2525
Stride length for `V`.
2626

2727
tau: number
28-
The value of `tau` in representation of `H`.
28+
Scalar constant.
2929

3030
C: Float64Array
3131
Input matrix.
@@ -52,14 +52,14 @@
5252

5353

5454
{{alias}}.ndarray( side, M, N, V, sv, ov, tau, C, sc1, sc2, oc, work, sw, ow )
55-
Applies a real elementary reflector `H = I - tau * v * v ^ T` to a real
55+
Applies a real elementary reflector `H = I - tau * v * v^T` to a real
5656
M by N matrix `C` using alternative indexing semantics.
5757

5858
Parameters
5959
----------
6060
side: string
61-
Specifies the side of multiplication with `C`. Use `left` to form
62-
`H * C` and `right` to from `C * H`.
61+
Specifies the side of multiplication with `C`. Use `'left'` to form
62+
`H * C` and `'right'` to form `C * H`.
6363

6464
M: integer
6565
Number of rows in `C`.
@@ -77,7 +77,7 @@
7777
Starting index for `V`.
7878

7979
tau: number
80-
The value of `tau` in representation of `H`.
80+
Scalar constant.
8181

8282
C: Float64Array
8383
Input matrix.

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ type Side = 'left' | 'right';
2828
*/
2929
interface Routine {
3030
/**
31-
* Applies a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C`.
31+
* Applies a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.
3232
*
33-
* @param side - specifies the side of multiplication with `C`. Use `left` to form `H * C` and `right` to from `C * H`.
33+
* @param side - specifies the side of multiplication with `C`. Use `'left'` to form `H * C` and `'right'` to form `C * H`.
3434
* @param M - number of rows in `C`
3535
* @param N - number of columns in `C`
36-
* @param V - the vector `v` in the representation of `H`
36+
* @param V - the vector `v`
3737
* @param incv - stride length for `V`
38-
* @param tau - the value of `tau` in representation of `H`
38+
* @param tau - scalar constant
3939
* @param C - input matrix
4040
* @param ldc - leading dimension of `C`
4141
* @param work - workspace array
@@ -54,15 +54,15 @@ interface Routine {
5454
( side: Side, M: number, N: number, V: Float64Array, incv: number, tau: number, C: Float64Array, ldc: number, work: Float64Array ): Float64Array;
5555

5656
/**
57-
* Applies a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C` using alternative indexing semantics.
57+
* Applies a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C` using alternative indexing semantics.
5858
*
59-
* @param side - specifies the side of multiplication with `C`. Use `left` to form `H * C` and `right` to from `C * H`.
59+
* @param side - specifies the side of multiplication with `C`. Use `'left'` to form `H * C` and `'right'` to form `C * H`.
6060
* @param M - number of rows in `C`
6161
* @param N - number of columns in `C`
62-
* @param V - the vector `v` in the representation of `H`
62+
* @param V - the vector `v`
6363
* @param strideV - stride length for `V`
6464
* @param offsetV - starting index for `V`
65-
* @param tau - the value of `tau` in representation of `H`
65+
* @param tau - scalar constant
6666
* @param C - input matrix
6767
* @param strideC1 - stride of the first dimension of `C`
6868
* @param strideC2 - stride of the second dimension of `C`
@@ -86,14 +86,14 @@ interface Routine {
8686
}
8787

8888
/**
89-
* Applies a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C`.
89+
* Applies a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.
9090
*
91-
* @param side - specifies the side of multiplication with `C`. Use `left` to form `H * C` and `right` to from `C * H`.
91+
* @param side - specifies the side of multiplication with `C`. Use `'left'` to form `H * C` and `'right'` to form `C * H`.
9292
* @param M - number of rows in `C`
9393
* @param N - number of columns in `C`
94-
* @param V - the vector `v` in the representation of `H`
94+
* @param V - the vector `v`
9595
* @param incv - stride length for `V`
96-
* @param tau - the value of `tau` in representation of `H`
96+
* @param tau - scalar constant
9797
* @param C - input matrix
9898
* @param ldc - leading dimension of `C`
9999
* @param work - workspace array

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,22 @@ var dscal = require( '@stdlib/blas/base/dscal' ).ndarray;
3333
// MAIN //
3434

3535
/**
36-
* Applies a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C`.
36+
* Applies a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.
3737
*
3838
* ## Notes
3939
*
40-
* - `work` should have `N` indexed elements if side = `left` and `M` indexed elements if side = `right`.
41-
* - `V` should have `1 + (M-1) * abs(strideV)` indexed elements if side = `left` and `1 + (N-1) * abs(strideV)` indexed elements if side = `right`.
42-
* - `C` is overwritten by `H * C` if side = `left` and `C * H` if side = `right`.
40+
* - `work` should have `N` indexed elements if side = `'left'` and `M` indexed elements if side = `'right'`.
41+
* - `V` should have `1 + (M-1) * abs(strideV)` indexed elements if side = `'left'` and `1 + (N-1) * abs(strideV)` indexed elements if side = `'right'`.
42+
* - `C` is overwritten by `H * C` if side = `'left'` and `C * H` if side = `'right'`.
4343
*
4444
* @private
45-
* @param {string} side - specifies the side of multiplication with `C`. Use `left` to form `H * C` and `right` to from `C * H`.
45+
* @param {string} side - specifies the side of multiplication with `C`. Use `'left'` to form `H * C` and `'right'` to form `C * H`.
4646
* @param {NonNegativeInteger} M - number of rows in `C`
4747
* @param {NonNegativeInteger} N - number of columns in `C`
48-
* @param {Float64Array} V - the vector `v` in the representation of `H`
48+
* @param {Float64Array} V - the vector `v`
4949
* @param {integer} strideV - stride length for `V`
5050
* @param {NonNegativeInteger} offsetV - starting index for `V`
51-
* @param {number} tau - the value of `tau` in representation of `H`
51+
* @param {number} tau - scalar constant
5252
* @param {Float64Array} C - input matrix
5353
* @param {integer} strideC1 - stride of the first dimension of `C`
5454
* @param {integer} strideC2 - stride of the second dimension of `C`

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,21 @@ var base = require( './base.js' );
3232
// MAIN //
3333

3434
/**
35-
* Applies a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C`.
35+
* Applies a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.
3636
*
3737
* ## Notes
3838
*
39-
* - `work` should have `N` indexed elements if side = `left` and `M` indexed elements if side = `right`.
40-
* - `V` should have `1 + (M-1) * abs(incv)` indexed elements if side = `left` and `1 + (N-1) * abs(incv)` indexed elements if side = `right`.
41-
* - `C` is overwritten by `H * C` if side = `left` and `C * H` if side = `right`.
39+
* - `work` should have `N` indexed elements if side = `'left'` and `M` indexed elements if side = `'right'`.
40+
* - `V` should have `1 + (M-1) * abs(incv)` indexed elements if side = `'left'` and `1 + (N-1) * abs(incv)` indexed elements if side = `'right'`.
41+
* - `C` is overwritten by `H * C` if side = `'left'` and `C * H` if side = `'right'`.
4242
*
4343
* @param {string} order - storage layout
44-
* @param {string} side - specifies the side of multiplication with `C`. Use `left` to form `H * C` and `right` to from `C * H`.
44+
* @param {string} side - specifies the side of multiplication with `C`. Use `'left'` to form `H * C` and `'right'` to form `C * H`.
4545
* @param {NonNegativeInteger} M - number of rows in `C`
4646
* @param {NonNegativeInteger} N - number of columns in `C`
47-
* @param {Float64Array} V - the vector `v` in the representation of `H`
47+
* @param {Float64Array} V - the vector `v`
4848
* @param {integer} incv - stride length for `V`
49-
* @param {number} tau - the value of `tau` in representation of `H`
49+
* @param {number} tau - scalar constant
5050
* @param {Float64Array} C - input matrix
5151
* @param {PositiveInteger} LDC - stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`)
5252
* @param {Float64Array} work - workspace array

‎lib/node_modules/@stdlib/lapack/base/dlarf1f/lib/index.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919
'use strict';
2020

2121
/**
22-
* LAPACK routine to apply a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C`.
22+
* LAPACK routine to apply a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.
2323
*
2424
* ## Notes
2525
*
26-
* - `work` should have `N` indexed elements if side = `left` and `M` indexed elements if side = `right`.
27-
* - `V` should have `1 + (M-1) * abs(incv)` indexed elements if side = `left` and `1 + (N-1) * abs(incv)` indexed elements if side = `right`.
28-
* - `C` is overwritten by `H * C` if side = `left` and `C * H` if side = `right`.
26+
* - `work` should have `N` indexed elements if side = `'left'` and `M` indexed elements if side = `'right'`.
27+
* - `V` should have `1 + (M-1) * abs(incv)` indexed elements if side = `'left'` and `1 + (N-1) * abs(incv)` indexed elements if side = `'right'`.
28+
* - `C` is overwritten by `H * C` if side = `'left'` and `C * H` if side = `'right'`.
2929
*
3030
* @module @stdlib/lapack/base/dlarf1f
3131
*

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,21 @@ var base = require( './base.js' );
2929
// MAIN //
3030

3131
/**
32-
* Applies a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C`.
32+
* Applies a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.
3333
*
3434
* ## Notes
3535
*
36-
* - `work` should have `N` indexed elements if side = `left` and `M` indexed elements if side = `right`.
37-
* - `V` should have `1 + (M-1) * abs(strideV)` indexed elements if side = `left` and `1 + (N-1) * abs(strideV)` indexed elements if side = `right`.
38-
* - `C` is overwritten by `H * C` if side = `left` and `C * H` if side = `right`.
36+
* - `work` should have `N` indexed elements if side = `'left'` and `M` indexed elements if side = `'right'`.
37+
* - `V` should have `1 + (M-1) * abs(strideV)` indexed elements if side = `'left'` and `1 + (N-1) * abs(strideV)` indexed elements if side = `'right'`.
38+
* - `C` is overwritten by `H * C` if side = `'left'` and `C * H` if side = `'right'`.
3939
*
40-
* @param {string} side - specifies the side of multiplication with `C`. Use `left` to form `H * C` and `right` to from `C * H`.
40+
* @param {string} side - specifies the side of multiplication with `C`. Use `'left'` to form `H * C` and `'right'` to form `C * H`.
4141
* @param {NonNegativeInteger} M - number of rows in `C`
4242
* @param {NonNegativeInteger} N - number of columns in `C`
43-
* @param {Float64Array} V - the vector `v` in the representation of `H`
43+
* @param {Float64Array} V - the vector `v`
4444
* @param {integer} strideV - stride length for `V`
4545
* @param {NonNegativeInteger} offsetV - starting index for `V`
46-
* @param {number} tau - the value of `tau` in representation of `H`
46+
* @param {number} tau - scalar constant
4747
* @param {Float64Array} C - input matrix
4848
* @param {integer} strideC1 - stride of the first dimension of `C`
4949
* @param {integer} strideC2 - stride of the second dimension of `C`

‎lib/node_modules/@stdlib/lapack/base/dlarf1f/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/lapack/base/dlarf1f",
33
"version": "0.0.0",
4-
"description": "LAPACK routine to apply a real elementary reflector `H = I - tau * v * v ^ T` to a real M by N matrix `C`.",
4+
"description": "LAPACK routine to apply a real elementary reflector `H = I - tau * v * v^T` to a real M by N matrix `C`.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)