Skip to content

Commit 3ab8825

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: 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 98232f7 commit 3ab8825

File tree

6 files changed

+66
-66
lines changed

6 files changed

+66
-66
lines changed

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ limitations under the License.
2424
2525
<section class="intro">
2626

27-
`dlartg` constructs a Givens rotation for a two-dimensional vector such that the following equation is satisfied:
27+
This routine constructs a Givens rotation for a two-dimensional vector such that the following equation is satisfied:
2828

2929

3030
<!-- <equation class="equation" label="eq:givens_rotation" align="center" raw="\begin{bmatrix} C & S \\ -S & C \end{bmatrix} \begin{bmatrix} F \\ G \end{bmatrix} = \begin{bmatrix} R \\ 0 \end{bmatrix}
@@ -71,11 +71,11 @@ dlartg( F, G, C, S, R );
7171

7272
The function has the following parameters:
7373

74-
- **F**: single element array representing the first component of the vector to be rotated as a [`Float64Array`][mdn-float64array].
75-
- **G**: single element array representing the second component of the vector to be rotated as a [`Float64Array`][mdn-float64array].
76-
- **C**: single element array overwritten by the cosine of the rotation as a [`Float64Array`][mdn-float64array].
77-
- **S**: single element array overwritten by the sine of the rotation as a [`Float64Array`][mdn-float64array].
78-
- **R**: single element array overwritten by the length of the rotated vector as a [`Float64Array`][mdn-float64array].
74+
- **F**: [`Float64Array`][mdn-float64array] containing a single element representing the first component of the vector to be rotated.
75+
- **G**: [`Float64Array`][mdn-float64array] containing a single element representing the second component of the vector to be rotated
76+
- **C**: [`Float64Array`][mdn-float64array] containing a single element which is overwritten by the cosine of the rotation.
77+
- **S**: [`Float64Array`][mdn-float64array] containing a single element which is overwritten by the sine of the rotation.
78+
- **R**: [`Float64Array`][mdn-float64array] containing a single element which is overwritten by the length of the rotated vector.
7979

8080
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
8181

@@ -125,16 +125,16 @@ dlartg.ndarray( F, 0, G, 0, C, 0, S, 0, R, 0 );
125125

126126
The function has the following parameters:
127127

128-
- **F**: single element array representing the first component of the vector to be rotated as a [`Float64Array`][mdn-float64array].
129-
- **offsetF**: starting index for `F`.
130-
- **G**: single element array representing the second component of the vector to be rotated as a [`Float64Array`][mdn-float64array].
131-
- **offsetG**: starting index for `G`.
132-
- **C**: single element array overwritten by the cosine of the rotation as a [`Float64Array`][mdn-float64array].
133-
- **offsetC**: starting index for `C`.
134-
- **S**: single element array overwritten by the sine of the rotation as a [`Float64Array`][mdn-float64array].
135-
- **offsetS**: starting index for `S`.
136-
- **R**: single element array overwritten by the length of the rotated vector as a [`Float64Array`][mdn-float64array].
137-
- **offsetR**: starting index for `R`.
128+
- **F**: [`Float64Array`][mdn-float64array] containing a single element representing the first component of the vector to be rotated.
129+
- **offsetF**: index of the element in `F`.
130+
- **G**: [`Float64Array`][mdn-float64array] containing a single element representing the second component of the vector to be rotated.
131+
- **offsetG**: index of the element in `G`.
132+
- **C**: [`Float64Array`][mdn-float64array] containing a single element which is overwritten by the cosine of the rotation.
133+
- **offsetC**: index of the element in `C`.
134+
- **S**: [`Float64Array`][mdn-float64array] containing a single element which is overwritten by the sine of the rotation.
135+
- **offsetS**: index of the element in `S`.
136+
- **R**: [`Float64Array`][mdn-float64array] containing a single element which is overwritten by the length of the rotated vector.
137+
- **offsetR**: index of the element in `R`.
138138

139139
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,
140140

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,31 +64,31 @@
6464
First component of the vector to be rotated.
6565

6666
offsetF: integer
67-
Starting index for `F`.
67+
Index of the element in `F`.
6868

6969
G: Float64Array
7070
Second component of the vector to be rotated.
7171

7272
offsetG: integer
73-
Starting index for `G`.
73+
Index of the element in `G`.
7474

7575
C: Float64Array
7676
Overwritten by the cosine of the rotation.
7777

7878
offsetC: integer
79-
Starting index for `C`.
79+
Index of the element in `C`.
8080

8181
S: Float64Array
8282
Overwritten by the sine of the rotation.
8383

8484
offsetS: integer
85-
Starting index for `S`.
85+
Index of the element in `S`.
8686

8787
R: Float64Array
8888
Overwritten by the length of the rotated vector.
8989

9090
offsetR: integer
91-
Starting index for `R`.
91+
Index of the element in `R`.
9292

9393
Returns
9494
-------

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

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ interface Routine {
3131
* \(\begin{bmatrix} C & S \\ -S & C \end{bmatrix} \begin{bmatrix} F \\ G \end{bmatrix} = \begin{bmatrix} R \\ 0 \end{bmatrix}\)
3232
* ```
3333
*
34-
* @param F - single element array representing the first component of the vector to be rotated
35-
* @param G - single element array representing the second component of the vector to be rotated
36-
* @param C - single element array overwritten by the cosine of the rotation
37-
* @param S - single element array overwritten by the sine of the rotation
38-
* @param R - single element array overwritten by the length of the rotated vector
34+
* @param F - single element array containing the first component of the vector to be rotated
35+
* @param G - single element array containing the second component of the vector to be rotated
36+
* @param C - single element array which is overwritten by the cosine of the rotation
37+
* @param S - single element array which is overwritten by the sine of the rotation
38+
* @param R - single element array which is overwritten by the length of the rotated vector
3939
* @returns {void}
4040
*
4141
* @example
@@ -63,16 +63,16 @@ interface Routine {
6363
* \(\begin{bmatrix} C & S \\ -S & C \end{bmatrix} \begin{bmatrix} F \\ G \end{bmatrix} = \begin{bmatrix} R \\ 0 \end{bmatrix}\)
6464
* ```
6565
*
66-
* @param F - single element array representing the first component of the vector to be rotated
67-
* @param offsetF - starting index for `F`
68-
* @param G - single element array representing the second component of the vector to be rotated
69-
* @param offsetG - starting index for `G`
70-
* @param C - single element array overwritten by the cosine of the rotation
71-
* @param offsetC - starting index for `C`
72-
* @param S - single element array overwritten by the sine of the rotation
73-
* @param offsetS - starting index for `S`
74-
* @param R - single element array overwritten by the length of the rotated vector
75-
* @param offsetR - starting index for `R`
66+
* @param F - single element array containing the first component of the vector to be rotated
67+
* @param offsetF - index of the element in `F`
68+
* @param G - single element array containing the second component of the vector to be rotated
69+
* @param offsetG - index of the element in `G`
70+
* @param C - single element array which is overwritten by the cosine of the rotation
71+
* @param offsetC - index of the element in `C`
72+
* @param S - single element array which is overwritten by the sine of the rotation
73+
* @param offsetS - index of the element in `S`
74+
* @param R - single element array which is overwritten by the length of the rotated vector
75+
* @param offsetR - index of the element in `R`
7676
* @returns {void}
7777
*
7878
* @example
@@ -101,11 +101,11 @@ interface Routine {
101101
* \(\begin{bmatrix} C & S \\ -S & C \end{bmatrix} \begin{bmatrix} F \\ G \end{bmatrix} = \begin{bmatrix} R \\ 0 \end{bmatrix}\)
102102
* ```
103103
*
104-
* @param F - single element array representing the first component of the vector to be rotated
105-
* @param G - single element array representing the second component of the vector to be rotated
106-
* @param C - single element array overwritten by the cosine of the rotation
107-
* @param S - single element array overwritten by the sine of the rotation
108-
* @param R - single element array overwritten by the length of the rotated vector
104+
* @param F - single element array containing the first component of the vector to be rotated
105+
* @param G - single element array containing the second component of the vector to be rotated
106+
* @param C - single element array which is overwritten by the cosine of the rotation
107+
* @param S - single element array which is overwritten by the sine of the rotation
108+
* @param R - single element array which is overwritten by the length of the rotated vector
109109
* @returns {void}
110110
*
111111
* @example

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,16 +49,16 @@ var rtmax = sqrt( safmax / 2.0 );
4949
* ```
5050
*
5151
* @private
52-
* @param {Float64Array} F - single element array representing the first component of the vector to be rotated
53-
* @param {NonNegativeInteger} offsetF - starting index for `F`
54-
* @param {Float64Array} G - single element array representing the second component of the vector to be rotated
55-
* @param {NonNegativeInteger} offsetG - starting index for `G`
56-
* @param {Float64Array} C - single element array overwritten by the cosine of the rotation
57-
* @param {NonNegativeInteger} offsetC - starting index for `C`
58-
* @param {Float64Array} S - single element array overwritten by the sine of the rotation
59-
* @param {NonNegativeInteger} offsetS - starting index for `S`
60-
* @param {Float64Array} R - single element array overwritten by the length of the rotated vector
61-
* @param {NonNegativeInteger} offsetR - starting index for `R`
52+
* @param {Float64Array} F - single element array containing the first component of the vector to be rotated
53+
* @param {NonNegativeInteger} offsetF - index of the element in `F`
54+
* @param {Float64Array} G - single element array containing the second component of the vector to be rotated
55+
* @param {NonNegativeInteger} offsetG - index of the element in `G`
56+
* @param {Float64Array} C - single element array which is overwritten by the cosine of the rotation
57+
* @param {NonNegativeInteger} offsetC - index of the element in `C`
58+
* @param {Float64Array} S - single element array which is overwritten by the sine of the rotation
59+
* @param {NonNegativeInteger} offsetS - index of the element in `S`
60+
* @param {Float64Array} R - single element array which is overwritten by the length of the rotated vector
61+
* @param {NonNegativeInteger} offsetR - index of the element in `R`
6262
* @returns {void}
6363
*
6464
* @example

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ var base = require( './base.js' );
3434
* \(\begin{bmatrix} C & S \\ -S & C \end{bmatrix} \begin{bmatrix} F \\ G \end{bmatrix} = \begin{bmatrix} R \\ 0 \end{bmatrix}\)
3535
* ```
3636
*
37-
* @param {Float64Array} F - single element array representing the first component of the vector to be rotated
38-
* @param {Float64Array} G - single element array representing the second component of the vector to be rotated
39-
* @param {Float64Array} C - single element array overwritten by the cosine of the rotation
40-
* @param {Float64Array} S - single element array overwritten by the sine of the rotation
41-
* @param {Float64Array} R - single element array overwritten by the length of the rotated vector
37+
* @param {Float64Array} F - single element array containing the first component of the vector to be rotated
38+
* @param {Float64Array} G - single element array containing the second component of the vector to be rotated
39+
* @param {Float64Array} C - single element array which is overwritten by the cosine of the rotation
40+
* @param {Float64Array} S - single element array which is overwritten by the sine of the rotation
41+
* @param {Float64Array} R - single element array which is overwritten by the length of the rotated vector
4242
* @returns {void}
4343
*
4444
* @example

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,16 @@ var base = require( './base.js' );
3434
* \(\begin{bmatrix} C & S \\ -S & C \end{bmatrix} \begin{bmatrix} F \\ G \end{bmatrix} = \begin{bmatrix} R \\ 0 \end{bmatrix}\)
3535
* ```
3636
*
37-
* @param {Float64Array} F - single element array representing the first component of the vector to be rotated
38-
* @param {NonNegativeInteger} offsetF - starting index for `F`
39-
* @param {Float64Array} G - single element array representing the second component of the vector to be rotated
40-
* @param {NonNegativeInteger} offsetG - starting index for `G`
41-
* @param {Float64Array} C - single element array overwritten by the cosine of the rotation
42-
* @param {NonNegativeInteger} offsetC - starting index for `C`
43-
* @param {Float64Array} S - single element array overwritten by the sine of the rotation
44-
* @param {NonNegativeInteger} offsetS - starting index for `S`
45-
* @param {Float64Array} R - single element array overwritten by the length of the rotated vector
46-
* @param {NonNegativeInteger} offsetR - starting index for `R`
37+
* @param {Float64Array} F - single element array containing the first component of the vector to be rotated
38+
* @param {NonNegativeInteger} offsetF - index of the element in `F`
39+
* @param {Float64Array} G - single element array containing the second component of the vector to be rotated
40+
* @param {NonNegativeInteger} offsetG - index of the element in `G`
41+
* @param {Float64Array} C - single element array which is overwritten by the cosine of the rotation
42+
* @param {NonNegativeInteger} offsetC - index of the element in `C`
43+
* @param {Float64Array} S - single element array which is overwritten by the sine of the rotation
44+
* @param {NonNegativeInteger} offsetS - index of the element in `S`
45+
* @param {Float64Array} R - single element array which is overwritten by the length of the rotated vector
46+
* @param {NonNegativeInteger} offsetR - index of the element in `R`
4747
* @returns {void}
4848
*
4949
* @example

0 commit comments

Comments
 (0)