Skip to content

Commit dcd87a5

Browse files
DivitJain26DivitJain26
committed
chore: clean up in docs
--- 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: passed - task: lint_javascript_src status: na - 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: passed - task: lint_license_headers status: passed ---
1 parent 3db65c8 commit dcd87a5

2 files changed

Lines changed: 27 additions & 29 deletions

File tree

‎lib/node_modules/@stdlib/blas/base/cgemv/docs/repl.txt‎

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11

22
{{alias}}( order, trans, M, N, α, A, lda, x, sx, β, y, sy )
3-
Performs one of the matrix-vector operations `y = α*A*x + β*y`,
4-
`y = α*A^T*x + β*y`, or `y = α*A^H*x + β*y`, where α and β are complex
5-
scalars, `x` and `y` are complex vectors, and `A` is an `M` by `N` complex
6-
matrix.
3+
Performs one of the matrix-vector operations `y = α*A*x + β*y` or
4+
`y = α*A**T*x + β*y` or `y = α*A^T*x + β*y`, where `α` and `β` are scalars,
5+
`x` and `y` are vectors, and `A` is an `M` by `N` matrix.
76

87
Indexing is relative to the first index. To introduce an offset, use typed
98
array views.
109

11-
If `M` or `N` is equal to 0, the function returns y unchanged.
10+
If `M` or `N` is equal to `0`, the function returns `y` unchanged.
1211

13-
If `α` equals `0 + 0i` and `β` equals `1 + 0i`, the function returns y
12+
If `α` equals `0 + 0i` and `β` equals `1 + 0i`, the function returns `y`
1413
unchanged.
1514

1615
Parameters
@@ -20,8 +19,7 @@
2019

2120
trans: string
2221
Specifies whether `A` should be transposed, conjugate-transposed, or not
23-
transposed. Accepted values typically include: 'no-transpose',
24-
'transpose', 'conjugate-transpose'.
22+
transposed.
2523

2624
M: integer
2725
Number of rows in `A`.
@@ -30,34 +28,34 @@
3028
Number of columns in `A`.
3129

3230
α: Complex64
33-
Complex scalar constant.
31+
Scalar constant.
3432

3533
A: Complex64Array
36-
Complex input matrix.
34+
Input matrix.
3735

3836
lda: integer
3937
Stride of the first dimension of `A` (a.k.a., leading dimension of the
4038
matrix `A`).
4139

4240
x: Complex64Array
43-
First complex input vector.
41+
First input vector.
4442

4543
sx: integer
4644
Index increment for `x`.
4745

4846
β: Complex64
49-
Complex scalar constant.
47+
Scalar constant.
5048

5149
y: Complex64Array
52-
Second complex input vector.
50+
Second input vector.
5351

5452
sy: integer
5553
Index increment for `y`.
5654

5755
Returns
5856
-------
5957
y: Complex64Array
60-
Second complex input vector.
58+
Second input vector.
6159

6260
Examples
6361
--------
@@ -107,18 +105,18 @@
107105
{{alias}}.ndarray( trans, M, N, α, A, sa1, sa2, oa, x, sx, ox, β, y, sy, oy )
108106
Performs one of the matrix-vector operations `y = α*A*x + β*y`,
109107
`y = α*A^T*x + β*y`, or `y = α*A^H*x + β*y` using alternative indexing
110-
semantics and where `α` and `β` are complex scalars, `x` and `y` are complex
111-
vectors, and `A` is an `M` by `N` complex matrix.
108+
semantics and where `α` and `β` are scalars, `x` and `y` are vectors, and
109+
`A` is an `M` by `N` matrix.
112110

113-
While typed array views mandate a view offset based on the underlying buffer
114-
, the offset parameters support indexing semantics based on starting
111+
While typed array views mandate a view offset based on the underlying
112+
buffer, the offset parameters support indexing semantics based on starting
115113
indices.
116114

117115
Parameters
118116
----------
119117
trans: string
120-
Specifies whether `A` should be `transposed`, `conjugate-transposed`, or
121-
not `transposed`.
118+
Specifies whether `A` should be transposed, conjugate-transposed, or not
119+
transposed.
122120

123121
M: integer
124122
Number of rows in `A`.
@@ -127,10 +125,10 @@
127125
Number of columns in `A`.
128126

129127
α: Complex64
130-
Complex scalar constant.
128+
Scalar constant.
131129

132130
A: Complex64Array
133-
Complex input matrix.
131+
Input matrix.
134132

135133
sa1: integer
136134
Stride of the first dimension of `A`.
@@ -142,7 +140,7 @@
142140
Starting index (offset) for `A`.
143141

144142
x: Complex64Array
145-
First complex input vector.
143+
First input vector.
146144

147145
sx: integer
148146
Index increment for `x`.
@@ -151,10 +149,10 @@
151149
Starting index (offset) for `x`.
152150

153151
β: Complex64
154-
Complex scalar constant.
152+
Scalar constant.
155153

156154
y: Complex64Array
157-
Second complex input vector.
155+
Second input vector.
158156

159157
sy: integer
160158
Index increment for `y`.
@@ -165,7 +163,7 @@
165163
Returns
166164
-------
167165
y: Complex64Array
168-
Second complex input vector.
166+
Second input vector.
169167

170168
Examples
171169
--------

‎lib/node_modules/@stdlib/blas/base/cgemv/docs/types/index.d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import { Complex64 } from '@stdlib/types/complex';
2929
*/
3030
interface Routine {
3131
/**
32-
* Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`, where `α` and `β` are scalars, `x` and `y` are complex vectors, and `A` is an `M` by `N` complex matrix.
32+
* Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`, where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.
3333
*
3434
* @param order - storage layout
3535
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
@@ -61,7 +61,7 @@ interface Routine {
6161
( order: Layout, trans: TransposeOperation, M: number, N: number, alpha: Complex64, A: Complex64Array, LDA: number, x: Complex64Array, strideX: number, beta: Complex64, y: Complex64Array, strideY: number ): Complex64Array;
6262

6363
/**
64-
* Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`, using alternative indexing semantics.
64+
* Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y` or `y = α*A^H*x + β*y`, using alternative indexing semantics and where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.
6565
*
6666
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
6767
* @param M - number of rows in the matrix `A`
@@ -97,7 +97,7 @@ interface Routine {
9797
}
9898

9999
/**
100-
* Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`, where `α` and `β` are complex scalars, `x` and `y` are complex vectors, and `A` is an `M` by `N` complex matrix.
100+
* Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y` or `y = α*A^H*x + β*y`, where `α` and `β` are scalars, `x` and `y` are vectors, and `A` is an `M` by `N` matrix.
101101
*
102102
* @param order - storage layout
103103
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed

0 commit comments

Comments
 (0)