Skip to content

Commit 122ec07

Browse files
aayush0325aayush0325
committed
docs: update description
--- 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 98967e9 commit 122ec07

File tree

8 files changed

+16
-16
lines changed

8 files changed

+16
-16
lines changed

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

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

2121
# dlaqr1
2222

23-
> Given a 2-by-2 or a 3-by-3 matrix, this LAPACK routine sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
23+
> Given a 2-by-2 or a 3-by-3 matrix `H`, this LAPACK routine sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var dlaqr1 = require( '@stdlib/lapack/base/dlaqr1' );
3232

3333
#### dlaqr1( order, N, H, LDH, sr1, si1, sr2, si2, V )
3434

35-
Given a 2-by-2 or a 3-by-3 matrix, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
35+
Given a 2-by-2 or a 3-by-3 matrix `H`, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
3636

3737
```javascript
3838
var Float64Array = require( '@stdlib/array/float64' );
@@ -77,7 +77,7 @@ dlaqr1( 'row-major', 3, H1, 3, 1.5, 0.0, 2.5, 0.0, V1 );
7777

7878
#### dlaqr1.ndarray( N, H, sh1, sh2, oh, sr1, si1, sr2, si2, V, sv, ov )
7979

80-
Given a 2-by-2 or a 3-by-3 matrix, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)` using alternative indexing semantics.
80+
Given a 2-by-2 or a 3-by-3 matrix `H`, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)` using alternative indexing semantics.
8181

8282
```javascript
8383
var Float64Array = require( '@stdlib/array/float64' );

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

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

22
{{alias}}( order, N, H, LDH, sr1, si1, sr2, si2, V )
3-
Given a 2-by-2 or a 3-by-3 matrix, this LAPACK routine sets `V` to a scalar
4-
multiple of the first column of `K` where:
3+
Given a 2-by-2 or a 3-by-3 matrix `H`, this LAPACK routine sets `V` to a
4+
scalar multiple of the first column of `K` where:
55
`K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
66

77
Indexing is relative to the first index. To introduce an offset, use typed
@@ -56,9 +56,9 @@
5656

5757

5858
{{alias}}.ndarray( N, H, sh1, sh2, oh, sr1, si1, sr2, si2, V, sv, ov )
59-
Given a 2-by-2 or a 3-by-3 matrix, this LAPACK routine sets `V` to a scalar
60-
multiple of the first column of `K` using alternative indexing semantics
61-
where:
59+
Given a 2-by-2 or a 3-by-3 matrix `H`, this LAPACK routine sets `V` to a
60+
scalar multiple of the first column of `K` using alternative indexing
61+
semantics where:
6262
`K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
6363

6464
It is expected that either `sr1 = sr2` and `si1 + si2 = 0` or si1 = si2 = 0`

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { Layout } from '@stdlib/types/blas';
2727
*/
2828
interface Routine {
2929
/**
30-
* Given a 2-by-2 or a 3-by-3 matrix, sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
30+
* Given a 2-by-2 or a 3-by-3 matrix `H`, sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
3131
*
3232
* ## Notes
3333
*
@@ -58,7 +58,7 @@ interface Routine {
5858
( order: Layout, N: number, H: Float64Array, LDH: number, sr1: number, si1: number, sr2: number, si2: number, V: Float64Array ): Float64Array;
5959

6060
/**
61-
* Given a 2-by-2 or a 3-by-3 matrix, sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)` using alternative indexing semantics.
61+
* Given a 2-by-2 or a 3-by-3 matrix `H`, sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)` using alternative indexing semantics.
6262
*
6363
* ## Notes
6464
*
@@ -93,7 +93,7 @@ interface Routine {
9393
}
9494

9595
/**
96-
* Given a 2-by-2 or a 3-by-3 matrix, sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
96+
* Given a 2-by-2 or a 3-by-3 matrix `H`, sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
9797
*
9898
* ## Notes
9999
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var abs = require( '@stdlib/math/base/special/fast/abs' );
2626
// MAIN //
2727

2828
/**
29-
* Given a 2-by-2 or a 3-by-3 matrix, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
29+
* Given a 2-by-2 or a 3-by-3 matrix `H`, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
3030
*
3131
* ## Notes
3232
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var base = require( './base.js' );
3131
// MAIN //
3232

3333
/**
34-
* Given a 2-by-2 or a 3-by-3 matrix, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
34+
* Given a 2-by-2 or a 3-by-3 matrix `H`, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
3535
*
3636
* ## Notes
3737
*

‎lib/node_modules/@stdlib/lapack/base/dlaqr1/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-
* Given a 2-by-2 or a 3-by-3 matrix, this LAPACK routine sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
22+
* Given a 2-by-2 or a 3-by-3 matrix `H`, this LAPACK routine sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.
2323
*
2424
* ## Notes
2525
*

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

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

2929
/**
30-
* Given a 2-by-2 or a 3-by-3 matrix, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)` using alternative indexing semantics.
30+
* Given a 2-by-2 or a 3-by-3 matrix `H`, this function sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)` using alternative indexing semantics.
3131
*
3232
* ## Notes
3333
*

‎lib/node_modules/@stdlib/lapack/base/dlaqr1/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/dlaqr1",
33
"version": "0.0.0",
4-
"description": "Given a 2-by-2 or a 3-by-3 matrix, this LAPACK routine sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.",
4+
"description": "Given a 2-by-2 or a 3-by-3 matrix `H`, this LAPACK routine sets `V` to a scalar multiple of the first column of `K` where `K = (H - (sr1 + i*si1)*I)*(H - (sr2 + i*si2)*I)`.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)