Skip to content

Commit 7c0136f

Browse files
aayush0325aayush0325
committed
chore: add info about matrix dim
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - 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 f39a952 commit 7c0136f

File tree

5 files changed

+50
-2
lines changed

5 files changed

+50
-2
lines changed

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ interface Routine {
4141
/**
4242
* 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
*
44+
* ## Notes
45+
*
46+
* - `V` is a double-precision array with dimension `(LDV,K)` if `storev = 'C'`, `(LDV,M)` if `storev = 'R'` and `side = 'L'`, or `(LDV,N)` if `storev = 'R'` and `side = 'R'`.
47+
* - `T` is a double-precision array with dimension `(LDT,K)`. The triangular `K` by `K` matrix `T` in the representation of the block reflector.
48+
* - `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.
49+
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
50+
*
4451
* @param order - storage layout
4552
* @param side - specifies whether `H` or `H ^ T` is applied from the left or right
4653
* @param trans - specifies whether to apply `H` or `H ^ T`
@@ -76,6 +83,13 @@ interface Routine {
7683
/**
7784
* 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.
7885
*
86+
* ## Notes
87+
*
88+
* - `V` is a double-precision array with dimension `(LDV,K)` if `storev = 'C'`, `(LDV,M)` if `storev = 'R'` and `side = 'L'`, or `(LDV,N)` if `storev = 'R'` and `side = 'R'`.
89+
* - `T` is a double-precision array with dimension `(LDT,K)`. The triangular `K` by `K` matrix `T` in the representation of the block reflector.
90+
* - `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.
91+
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
92+
*
7993
* @param side - specifies whether `H` or `H ^ T` is applied from the left or right
8094
* @param trans - specifies whether to apply `H` or `H ^ T`
8195
* @param direct - indicates how `H` is formed from a product of elementary reflectors
@@ -119,6 +133,13 @@ interface Routine {
119133
/**
120134
* 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.
121135
*
136+
* ## Notes
137+
*
138+
* - `V` is a double-precision array with dimension `(LDV,K)` if `storev = 'C'`, `(LDV,M)` if `storev = 'R'` and `side = 'L'`, or `(LDV,N)` if `storev = 'R'` and `side = 'R'`.
139+
* - `T` is a double-precision array with dimension `(LDT,K)`. The triangular `K` by `K` matrix `T` in the representation of the block reflector.
140+
* - `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.
141+
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
142+
*
122143
* @param order - storage layout
123144
* @param side - specifies whether `H` or `H ^ T` is applied from the left or right
124145
* @param trans - specifies whether to apply `H` or `H ^ T`

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ var rightBackwardRows = require( './right-backward-rows.js' );
3737
/**
3838
* 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
*
40+
* ## Notes
41+
*
42+
* - `V` is a double-precision array with dimension `(LDV,K)` if `storev = 'C'`, `(LDV,M)` if `storev = 'R'` and `side = 'L'`, or `(LDV,N)` if `storev = 'R'` and `side = 'R'`.
43+
* - `T` is a double-precision array with dimension `(LDT,K)`. The triangular `K` by `K` matrix `T` in the representation of the block reflector.
44+
* - `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.
45+
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
46+
*
4047
* @private
4148
* @param {string} side - specifies whether `H` or `H ^ T` is applied from the left or right
4249
* @param {string} trans - specifies whether to apply `H` or `H ^ T`
@@ -81,7 +88,6 @@ function dlarfb( side, trans, direct, storev, M, N, K, V, strideV1, strideV2, of
8188
return C;
8289
}
8390

84-
// Route to appropriate case function based on parameters
8591
if ( side === 'left' ) {
8692
if ( storev === 'columns' ) {
8793
if ( direct === 'forward' ) {

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ var base = require( './base.js' );
3636
/**
3737
* 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
*
39+
* ## Notes
40+
*
41+
* - `V` is a double-precision array with dimension `(LDV,K)` if `storev = 'C'`, `(LDV,M)` if `storev = 'R'` and `side = 'L'`, or `(LDV,N)` if `storev = 'R'` and `side = 'R'`.
42+
* - `T` is a double-precision array with dimension `(LDT,K)`. The triangular `K` by `K` matrix `T` in the representation of the block reflector.
43+
* - `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.
44+
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
45+
*
3946
* @param {string} order - storage layout
4047
* @param {string} side - specifies whether `H` or `H ^ T` is applied from the left or right
4148
* @param {string} trans - specifies whether to apply `H` or `H ^ T` (`'no-transpose'` or `'transpose'`)
@@ -124,7 +131,7 @@ function dlarfb( order, side, trans, direct, storev, M, N, K, V, LDV, T, LDT, C,
124131
if ( LDWORK < max( 1, K ) ) {
125132
throw new RangeError( format( 'invalid argument. Fifteenth argument must be greater than or equal to max(1,%d). Value: `%d`.', K, LDWORK ) );
126133
}
127-
} else if ( isColumnMajor( order ) ) {
134+
} else {
128135
if ( LDC < max( 1, M ) ) {
129136
throw new RangeError( format( 'invalid argument. Thirteenth argument must be greater than or equal to max(1,%d). Value: `%d`.', M, LDC ) );
130137
}

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@
2121
/**
2222
* 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
*
24+
* ## Notes
25+
*
26+
* - `V` is a double-precision array with dimension `(LDV,K)` if `storev = 'C'`, `(LDV,M)` if `storev = 'R'` and `side = 'L'`, or `(LDV,N)` if `storev = 'R'` and `side = 'R'`.
27+
* - `T` is a double-precision array with dimension `(LDT,K)`. The triangular `K` by `K` matrix `T` in the representation of the block reflector.
28+
* - `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.
29+
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
30+
*
2431
* @module @stdlib/lapack/base/dlarfb
2532
*
2633
* @example

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ var base = require( './base.js' );
3232
/**
3333
* 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
*
35+
* ## Notes
36+
*
37+
* - `V` is a double-precision array with dimension `(LDV,K)` if `storev = 'C'`, `(LDV,M)` if `storev = 'R'` and `side = 'L'`, or `(LDV,N)` if `storev = 'R'` and `side = 'R'`.
38+
* - `T` is a double-precision array with dimension `(LDT,K)`. The triangular `K` by `K` matrix `T` in the representation of the block reflector.
39+
* - `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.
40+
* - `work` is a double-precision array with dimension `(LDWORK,K)`.
41+
*
3542
* @param {string} side - specifies whether `H` or `H ^ T` is applied from the left or right
3643
* @param {string} trans - specifies whether to apply `H` or `H ^ T`
3744
* @param {string} direct - indicates how `H` is formed from a product of elementary reflectors

0 commit comments

Comments
 (0)