Skip to content

Commit 7392aa6

Browse files
committed
docs: add repl.txt
--- 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: na - 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 e1d65b2 commit 7392aa6

File tree

6 files changed

+148
-15
lines changed

6 files changed

+148
-15
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ The function has the following parameters:
5959
- **side**: specifies the side of the eigenvectors in `V` (`right` or `left`).
6060
- **N**: number of rows in `V`.
6161
- **M**: number of columns in `V`.
62-
- **ilo**: index of the leftmost element in the submatrix computed by `dgebal` (0 based).
63-
- **ihi**: index of the rightmost element in the submatrix computed by `dgebal` (0 based).
62+
- **ilo**: index of the leftmost element in the submatrix computed by `dgebal` (zero-based).
63+
- **ihi**: index of the rightmost element in the submatrix computed by `dgebal` (zero-based).
6464
- **scale**: contains the details of the permutations and scaling factors applied when balancing `V`, computed by `dgebal` as a [`Float64Array`][mdn-float64array].
6565
- **V**: input matrix stored in linear memory as a [`Float64Array`][mdn-float64array].
6666
- **LDV**: stride of the first dimension of `V` (a.k.a., leading dimension of the matrix `V`).
Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
{{alias}}( order, job, side, N, M, ilo, ihi, scale, V, LDV )
3+
Forms the right or left eigenvectors of a real general matrix by backward
4+
transformation on the computed eigenvectors of the balanced matrix output
5+
by `dgebal`.
6+
7+
Indexing is relative to the first index. To introduce an offset, use typed
8+
array views.
9+
10+
Parameters
11+
----------
12+
order: string
13+
Row-major (C-style) or column-major (Fortran-style) order. Must be
14+
either 'row-major' or 'column-major'.
15+
16+
job: string
17+
Indicates the operations to be performed. The `job` parameter can be
18+
one of the following. 'none' (do nothing), 'permute' (permute only),
19+
'scale' (scale only) and 'both' (both permute and scale).
20+
21+
side: string
22+
Specifies the side of the eigenvectors in `V` (`right` or `left`).
23+
24+
N: integer
25+
Number of rows in `V`.
26+
27+
M: integer
28+
Number of columns in `V`.
29+
30+
ilo: integer
31+
Index of leftmost column of the submatrix computed by `dgebal`
32+
(zero-based).
33+
34+
ihi: integer
35+
Index of rightmost column of the submatrix computed by `dgebal`
36+
(zero-based).
37+
38+
scale: Float64Array
39+
Contains the details of the permutations and scaling factors applied
40+
when balancing `V`, computed by `dgebal`.
41+
42+
V: Float64Array
43+
Input matrix.
44+
45+
LDV: integer
46+
Stride of the first dimension of `V` (a.k.a., leading dimension of the
47+
matrix `A`).
48+
49+
Returns
50+
-------
51+
V: Float64Array
52+
Mutated input matrix.
53+
54+
Examples
55+
--------
56+
> var V = new {{alias:@stdlib/array/float64}}( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] );
57+
> var scale = new {{alias:@stdlib/array/float64}}( [ 0.5, 2.0, 1.0 ] );
58+
> var ord = 'row-major';
59+
> var out = {{alias}}( ord, 'scale', 'right', 3, 2, 0, 2, scale, V, 2 )
60+
<Float64Array>[ 0.5, 2.0, 4.0, 10.0, 3.0, 6.0 ]
61+
62+
63+
{{alias}}.ndarray( job, side, N, M, ilo, ihi, scale, ss, os, V, sv1, sv2, ov )
64+
Forms the right or left eigenvectors of a real general matrix by backward
65+
transformation on the computed eigenvectors of the balanced matrix output
66+
by `dgebal` using alternative indexing semantics.
67+
68+
While typed array views mandate a view offset based on the underlying
69+
buffer, the offset parameters support indexing semantics based on starting
70+
indices.
71+
72+
Parameters
73+
----------
74+
job: string
75+
Indicates the operations to be performed. The `job` parameter can be
76+
one of the following. 'none' (do nothing), 'permute' (permute only),
77+
'scale' (scale only) and 'both' (both permute and scale).
78+
79+
side: string
80+
Specifies the side of the eigenvectors in `V` (`right` or `left`).
81+
82+
N: integer
83+
Number of rows in `V`.
84+
85+
M: integer
86+
Number of columns in `V`.
87+
88+
ilo: integer
89+
Index of leftmost column of the submatrix computed by `dgebal`
90+
(zero-based).
91+
92+
ihi: integer
93+
Index of rightmost column of the submatrix computed by `dgebal`
94+
(zero-based).
95+
96+
scale: Float64Array
97+
Contains the details of the permutations and scaling factors applied
98+
when balancing `V`, computed by `dgebal`.
99+
100+
ss: integer
101+
Stride length of `scale`.
102+
103+
os: integer
104+
Starting index of `scale`.
105+
106+
V: Float64Array
107+
Input matrix.
108+
109+
sv1: integer
110+
Stride of the first dimension of `V`.
111+
112+
sv2: integer
113+
Stride of the second dimension of `V`.
114+
115+
ov: integer
116+
Starting index of `V`.
117+
118+
Returns
119+
-------
120+
V: Float64Array
121+
Mutated input matrix.
122+
123+
Examples
124+
--------
125+
> var V = new {{alias:@stdlib/array/float64}}( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] );
126+
> var scale = new {{alias:@stdlib/array/float64}}( [ 0.5, 2.0, 1.0 ] );
127+
> var job = 'both';
128+
> var side = 'right';
129+
> var out = {{alias}}.ndarray( job,side, 3,2, 0,2, scale,1,0, V,2,1,0 )
130+
<Float64Array>[ 0.5, 2.0, 4.0, 10.0, 3.0, 6.0 ]
131+
132+
See Also
133+
--------

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ interface Routine {
6969
* @param side - specifies the side of the eigenvectors in `V` (`right` or `left`).
7070
* @param N - number of rows in matrix `V`
7171
* @param M - number of columns in matrix `V`
72-
* @param ilo - index of leftmost column of the submatrix
73-
* @param ihi - index of rightmost column of the submatrix
72+
* @param ilo - index of leftmost column of the submatrix computed by `dgebal` (zero-based)
73+
* @param ihi - index of rightmost column of the submatrix computed by `dgebal` (zero-based)
7474
* @param scale - contains the details of the permutations and scaling factors applied when balancing `V`, computed by `dgebal`
7575
* @param V - input matrix
7676
* @param LDV - leading dimension of `V`
@@ -107,8 +107,8 @@ interface Routine {
107107
* @param side - specifies the side of the eigenvectors in `V` (`right` or `left`).
108108
* @param N - number of rows in matrix `V`
109109
* @param M - number of columns in matrix `V`
110-
* @param ilo - index of leftmost column of the submatrix
111-
* @param ihi - index of rightmost column of the submatrix
110+
* @param ilo - index of leftmost column of the submatrix computed by `dgebal` (zero-based)
111+
* @param ihi - index of rightmost column of the submatrix computed by `dgebal` (zero-based)
112112
* @param scale - contains the details of the permutations and scaling factors applied when balancing `V`, computed by `dgebal`
113113
* @param strideScale - stride of `scale`
114114
* @param offsetScale - starting index for `scale`
@@ -149,8 +149,8 @@ interface Routine {
149149
* @param side - specifies the side of the eigenvectors in `V` (`right` or `left`).
150150
* @param N - number of rows in matrix `V`
151151
* @param M - number of columns in matrix `V`
152-
* @param ilo - index of leftmost column of the submatrix
153-
* @param ihi - index of rightmost column of the submatrix
152+
* @param ilo - index of leftmost column of the submatrix computed by `dgebal` (zero-based)
153+
* @param ihi - index of rightmost column of the submatrix computed by `dgebal` (zero-based)
154154
* @param scale - contains the details of the permutations and scaling factors applied when balancing `V`, computed by `dgebal`
155155
* @param V - input matrix
156156
* @param LDV - leading dimension of `V`

lib/node_modules/@stdlib/lapack/base/dgebak/lib/base.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ var trunc = require( '@stdlib/math/base/special/trunc' );
4444
* @param {string} side - specifies the side of the eigenvectors in `V` (`right` or `left`).
4545
* @param {NonNegativeInteger} N - number of rows in matrix `V`
4646
* @param {NonNegativeInteger} M - number of columns in matrix `V`
47-
* @param {NonNegativeInteger} ilo - index of leftmost column of the submatrix
48-
* @param {NonNegativeInteger} ihi - index of rightmost column of the submatrix
47+
* @param {NonNegativeInteger} ilo - index of leftmost column of the submatrix computed by `dgebal` (zero-based)
48+
* @param {NonNegativeInteger} ihi - index of rightmost column of the submatrix computed by `dgebal` (zero-based)
4949
* @param {Float64Array} scale - contains the details of the permutations and scaling factors applied when balancing `V`, computed by `dgebal`
5050
* @param {integer} strideScale - stride of `scale`
5151
* @param {NonNegativeInteger} offsetScale - starting index for `scale`

lib/node_modules/@stdlib/lapack/base/dgebak/lib/dgebak.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ var base = require( './base.js' );
4747
* @param {string} side - specifies the side of the eigenvectors in `V` (`right` or `left`)
4848
* @param {NonNegativeInteger} N - number of rows in matrix `V`
4949
* @param {NonNegativeInteger} M - number of columns in matrix `V`
50-
* @param {NonNegativeInteger} ilo - index of leftmost column of the submatrix
51-
* @param {NonNegativeInteger} ihi - index of rightmost column of the submatrix
50+
* @param {NonNegativeInteger} ilo - index of leftmost column of the submatrix computed by `dgebal` (zero-based)
51+
* @param {NonNegativeInteger} ihi - index of rightmost column of the submatrix computed by `dgebal` (zero-based)
5252
* @param {Float64Array} scale - contains the details of the permutations and scaling factors applied when balancing `V`, computed by `dgebal`
5353
* @param {Float64Array} V - input matrix
5454
* @param {integer} LDV - leading dimension of `V`

lib/node_modules/@stdlib/lapack/base/dgebak/lib/ndarray.js

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

2929
/**
30-
* Forms the right or left eigenvectors of a real general matrix by backward transformation on the computed eigenvectors of the balanced matrix output by `dgebal`.
30+
* Forms the right or left eigenvectors of a real general matrix by backward transformation on the computed eigenvectors of the balanced matrix output by `dgebal` using alternative indexing semantics.
3131
*
3232
* ## Notes
3333
*
@@ -42,8 +42,8 @@ var base = require( './base.js' );
4242
* @param {string} side - specifies the side of the eigenvectors in `V` (`right` or `left`).
4343
* @param {NonNegativeInteger} N - number of rows in matrix `V`
4444
* @param {NonNegativeInteger} M - number of columns in matrix `V`
45-
* @param {NonNegativeInteger} ilo - index of leftmost column of the submatrix
46-
* @param {NonNegativeInteger} ihi - index of rightmost column of the submatrix
45+
* @param {NonNegativeInteger} ilo - index of leftmost column of the submatrix computed by `dgebal` (zero-based)
46+
* @param {NonNegativeInteger} ihi - index of rightmost column of the submatrix computed by `dgebal` (zero-based)
4747
* @param {Float64Array} scale - contains the details of the permutations and scaling factors applied when balancing `V`, computed by `dgebal`
4848
* @param {integer} strideScale - stride of `scale`
4949
* @param {NonNegativeInteger} offsetScale - starting index for `scale`

0 commit comments

Comments
 (0)