Skip to content

Commit b8653d7

Browse files
aayush0325aayush0325
committed
chore: code review
1 parent e3fd558 commit b8653d7

File tree

8 files changed

+34
-34
lines changed

8 files changed

+34
-34
lines changed

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

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

2121
# dlarfb
2222

23-
> LAPACK routine to apply a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.
23+
> LAPACK routine to apply a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.
2424
2525
<section class="usage">
2626

@@ -34,7 +34,7 @@ var dlarfb = require( '@stdlib/lapack/base/dlarfb' );
3434

3535
#### dlarfb( order, side, trans, direct, storev, M, N, K, V, LDV, T, LDT, C, LDC, work, LDWORK )
3636

37-
Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.
37+
Applies a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.
3838

3939
<!-- eslint-disable max-len -->
4040

@@ -53,10 +53,10 @@ dlarfb( 'row-major', 'left', 'transpose', 'forward', 'columns', 3, 3, 3, V, 3, T
5353
The function has the following parameters:
5454

5555
- **order**: storage layout (`'row-major'` or `'column-major'`).
56-
- **side**: specifies whether `H` or `H ^ T` is applied from the left or right (`'left'` or `'right'`).
57-
- **trans**: specifies whether to apply `H` or `H ^ T` (`'no-transpose'` or `'transpose'`).
56+
- **side**: specifies whether `H` or `H^T` is applied from the left or right (`'left'` or `'right'`).
57+
- **trans**: specifies whether to apply `H` or `H^T` (`'no-transpose'` or `'transpose'`).
5858
- **direct**: indicates how `H` is formed from a product of elementary reflectors (`'forward'` or `'backward'`).
59-
- **storev**: indicates how the vectors which define the elementary reflectors are stored (`'column-major'` or `'row-major'`).
59+
- **storev**: indicates how the vectors which define the elementary reflectors are stored (`'columns'` or `'rows'`).
6060
- **M**: number of rows of the matrix `C`.
6161
- **N**: number of columns of the matrix `C`.
6262
- **K**: order of the matrix `T`.
@@ -73,7 +73,7 @@ The function applies the block reflector `H` to matrix `C` according to the spec
7373

7474
#### dlarfb.ndarray( side, trans, direct, storev, M, N, K, V, strideV1, strideV2, offsetV, T, strideT1, strideT2, offsetT, C, strideC1, strideC2, offsetC, work, strideWork1, strideWork2, offsetWork )
7575

76-
Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right, using alternative indexing semantics.
76+
Applies a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right, using alternative indexing semantics.
7777

7878
<!-- eslint-disable max-len -->
7979

@@ -91,8 +91,8 @@ dlarfb.ndarray( 'left', 'transpose', 'forward', 'columns', 3, 3, 3, V, 3, 1, 0,
9191

9292
The function has the following additional parameters:
9393

94-
- **side**: specifies whether `H` or `H ^ T` is applied from the left or right (`'left'` or `'right'`).
95-
- **trans**: specifies whether to apply `H` or `H ^ T` (`'no-transpose'` or `'transpose'`).
94+
- **side**: specifies whether `H` or `H^T` is applied from the left or right (`'left'` or `'right'`).
95+
- **trans**: specifies whether to apply `H` or `H^T` (`'no-transpose'` or `'transpose'`).
9696
- **direct**: indicates how `H` is formed from a product of elementary reflectors (`'forward'` or `'backward'`).
9797
- **storev**: indicates how the vectors which define the elementary reflectors are stored (`'columns'` or `'rows'`).
9898
- **M**: number of rows of the matrix `C`.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{{alias}}( o, si, tr, dir, sto, M, N, K, V, LDV, T, LDT, C, LDC, W, LDWORK )
2-
Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by
2+
Applies a real block reflector `H` or its transpose `H^T` to a real `M` by
33
`N` matrix `C`, from either the left or the right.
44

55
Indexing is relative to the first index. To introduce an offset, use typed
@@ -17,11 +17,11 @@
1717
either 'row-major' or 'column-major'.
1818

1919
si: string
20-
Specifies whether `H` or `H ^ T` is applied from the left or right.
20+
Specifies whether `H` or `H^T` is applied from the left or right.
2121
Must be either 'left' or 'right'.
2222

2323
tr: string
24-
Specifies whether to apply `H` or `H ^ T`. Must be either
24+
Specifies whether to apply `H` or `H^T`. Must be either
2525
'no-transpose' or 'transpose'.
2626

2727
dir: string
@@ -86,7 +86,7 @@
8686

8787

8888
{{alias}}.ndarray(si,tr,dir,sto,M,N,K,V,sv1,sv2,ov,T,st1,st2,ot,C,sc1,sc2,oc,W,sw1,sw2,ow)
89-
Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by
89+
Applies a real block reflector `H` or its transpose `H^T` to a real `M` by
9090
`N` matrix `C`, from either the left or the right, using alternative
9191
indexing semantics.
9292

@@ -97,11 +97,11 @@
9797
Parameters
9898
----------
9999
si: string
100-
Specifies whether `H` or `H ^ T` is applied from the left or right.
100+
Specifies whether `H` or `H^T` is applied from the left or right.
101101
Must be either 'left' or 'right'.
102102

103103
tr: string
104-
Specifies whether to apply `H` or `H ^ T`. Must be either
104+
Specifies whether to apply `H` or `H^T`. Must be either
105105
'no-transpose' or 'transpose'.
106106

107107
dir: string

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type Direction = 'forward' | 'backward';
3939
*/
4040
interface Routine {
4141
/**
42-
* Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.
42+
* Applies a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.
4343
*
4444
* ## Notes
4545
*
@@ -49,8 +49,8 @@ interface Routine {
4949
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
5050
*
5151
* @param order - storage layout
52-
* @param side - specifies whether `H` or `H ^ T` is applied from the left or right
53-
* @param trans - specifies whether to apply `H` or `H ^ T`
52+
* @param side - specifies whether `H` or `H^T` is applied from the left or right
53+
* @param trans - specifies whether to apply `H` or `H^T`
5454
* @param direct - indicates how `H` is formed from a product of elementary reflectors
5555
* @param storev - indicates how the vectors which define the elementary reflectors are stored
5656
* @param M - number of rows of the matrix `C`
@@ -81,7 +81,7 @@ interface Routine {
8181
( order: Layout, side: OperationSide, trans: TransposeOperation, direct: Direction, storev: MatrixOrientation, M: number, N: number, K: number, V: Float64Array, LDV: number, T: Float64Array, LDT: number, C: Float64Array, LDC: number, work: Float64Array, LDWORK: number ): Float64Array;
8282

8383
/**
84-
* Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.
84+
* Applies a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.
8585
*
8686
* ## Notes
8787
*
@@ -90,8 +90,8 @@ interface Routine {
9090
* - `C` is a double-precision array with dimension `(LDC,N)`. On entry, the `M` by `N` matrix `C`. On exit, `C` is overwritten by the desired matrix product.
9191
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
9292
*
93-
* @param side - specifies whether `H` or `H ^ T` is applied from the left or right
94-
* @param trans - specifies whether to apply `H` or `H ^ T`
93+
* @param side - specifies whether `H` or `H^T` is applied from the left or right
94+
* @param trans - specifies whether to apply `H` or `H^T`
9595
* @param direct - indicates how `H` is formed from a product of elementary reflectors
9696
* @param storev - indicates how the vectors which define the elementary reflectors are stored
9797
* @param M - number of rows of the matrix `C`
@@ -131,7 +131,7 @@ interface Routine {
131131
}
132132

133133
/**
134-
* Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.
134+
* Applies a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.
135135
*
136136
* ## Notes
137137
*
@@ -141,8 +141,8 @@ interface Routine {
141141
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
142142
*
143143
* @param order - storage layout
144-
* @param side - specifies whether `H` or `H ^ T` is applied from the left or right
145-
* @param trans - specifies whether to apply `H` or `H ^ T`
144+
* @param side - specifies whether `H` or `H^T` is applied from the left or right
145+
* @param trans - specifies whether to apply `H` or `H^T`
146146
* @param direct - indicates how `H` is formed from a product of elementary reflectors
147147
* @param storev - indicates how the vectors which define the elementary reflectors are stored
148148
* @param M - number of rows of the matrix `C`

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ var rightBackwardRows = require( './right_backward_rows.js' );
3535
// MAIN //
3636

3737
/**
38-
* Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.
38+
* Applies a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.
3939
*
4040
* ## Notes
4141
*
@@ -45,8 +45,8 @@ var rightBackwardRows = require( './right_backward_rows.js' );
4545
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
4646
*
4747
* @private
48-
* @param {string} side - specifies whether `H` or `H ^ T` is applied from the left or right
49-
* @param {string} trans - specifies whether to apply `H` or `H ^ T`
48+
* @param {string} side - specifies whether `H` or `H^T` is applied from the left or right
49+
* @param {string} trans - specifies whether to apply `H` or `H^T`
5050
* @param {string} direct - indicates how `H` is formed from a product of elementary reflectors
5151
* @param {string} storev - indicates how the vectors which define the elementary reflectors are stored
5252
* @param {NonNegativeInteger} M - number of rows of the matrix `C`

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ var base = require( './base.js' );
3434
// MAIN //
3535

3636
/**
37-
* Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.
37+
* Applies a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.
3838
*
3939
* ## Notes
4040
*
@@ -44,8 +44,8 @@ var base = require( './base.js' );
4444
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
4545
*
4646
* @param {string} order - storage layout
47-
* @param {string} side - specifies whether `H` or `H ^ T` is applied from the left or right
48-
* @param {string} trans - specifies whether to apply `H` or `H ^ T` (`'no-transpose'` or `'transpose'`)
47+
* @param {string} side - specifies whether `H` or `H^T` is applied from the left or right
48+
* @param {string} trans - specifies whether to apply `H` or `H^T` (`'no-transpose'` or `'transpose'`)
4949
* @param {string} direct - indicates how `H` is formed from a product of elementary reflectors (`'forward'` or `'backward'`)
5050
* @param {string} storev - indicates how the vectors which define the elementary reflectors are stored (`'column-major'` or `'row-major'`)
5151
* @param {NonNegativeInteger} M - number of rows of the matrix `C`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* LAPACK routine to apply a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.
22+
* LAPACK routine to apply a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.
2323
*
2424
* ## Notes
2525
*

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

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

3232
/**
33-
* Applies a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.
33+
* Applies a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.
3434
*
3535
* ## Notes
3636
*
@@ -39,8 +39,8 @@ var base = require( './base.js' );
3939
* - `C` is a double-precision array with dimension `(LDC,N)`. On entry, the `M` by `N` matrix `C`. On exit, `C` is overwritten by the desired matrix product.
4040
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
4141
*
42-
* @param {string} side - specifies whether `H` or `H ^ T` is applied from the left or right
43-
* @param {string} trans - specifies whether to apply `H` or `H ^ T`
42+
* @param {string} side - specifies whether `H` or `H^T` is applied from the left or right
43+
* @param {string} trans - specifies whether to apply `H` or `H^T`
4444
* @param {string} direct - indicates how `H` is formed from a product of elementary reflectors
4545
* @param {string} storev - indicates how the vectors which define the elementary reflectors are stored
4646
* @param {NonNegativeInteger} M - number of rows of the matrix `C`

‎lib/node_modules/@stdlib/lapack/base/dlarfb/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/dlarfb",
33
"version": "0.0.0",
4-
"description": "LAPACK routine to apply a real block reflector `H` or its transpose `H ^ T` to a real `M` by `N` matrix `C`, from either the left or the right.",
4+
"description": "LAPACK routine to apply a real block reflector `H` or its transpose `H^T` to a real `M` by `N` matrix `C`, from either the left or the right.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)