Skip to content

Commit b72e23b

Browse files
committed
chore: clean up in readme
--- 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: na - 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: na - task: lint_license_headers status: passed ---
1 parent 7002bc3 commit b72e23b

2 files changed

Lines changed: 32 additions & 20 deletions

File tree

lib/node_modules/@stdlib/blas/base/chpmv/README.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,15 @@ var chpmv = require( '@stdlib/blas/base/chpmv' );
3232

3333
#### chpmv( order, uplo, N, α, AP, x, sx, β, y, sy )
3434

35-
Performs the matrix-vector operation `y = α*A*x + β*y`, where `α` and `β` are complex scalars, `x` and `y` are `N` element complex vectors, and `A` is an `N` by `N` Hermitian matrix supplied in packed form.
35+
Performs the matrix-vector operation `y = α*A*x + β*y`, where `α` and `β` are scalars, `x` and `y` are `N` element vectors, and `A` is an `N` by `N` Hermitian matrix supplied in packed form.
36+
37+
<!-- eslint-disable max-len -->
3638

3739
```javascript
3840
var Complex64Array = require( '@stdlib/array/complex64' );
3941
var Complex64 = require( '@stdlib/complex/float32/ctor' );
4042

41-
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] ); // eslint-disable-line max-params, max-len
43+
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] );
4244
var x = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] );
4345
var y = new Complex64Array( [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] );
4446
var alpha = new Complex64( 0.5, 0.5 );
@@ -53,23 +55,25 @@ The function has the following parameters:
5355
- **order**: storage layout.
5456
- **uplo**: specifies whether the upper or lower triangular part of the matrix `A` is supplied.
5557
- **N**: specifies number of elements along each dimension of `A`.
56-
- **α**: complex scalar constant.
57-
- **AP**: Complex input matrix in packed form stored in linear memory as a [`Complex64Array`][@stdlib/array/complex64].
58-
- **x**: complex input vector [`Complex64Array`][@stdlib/array/complex64].
58+
- **α**: scalar constant.
59+
- **AP**: input matrix in packed form stored in linear memory as a [`Complex64Array`][@stdlib/array/complex64].
60+
- **x**: input vector [`Complex64Array`][@stdlib/array/complex64].
5961
- **sx**: stride length for `x`.
60-
- **β**: complex scalar constant.
62+
- **β**: scalar constant.
6163
- **y**: output [`Complex64Array`][@stdlib/array/complex64].
6264
- **sy**: stride length for `y`.
6365

6466
The stride parameters determine how elements are accessed. For example, to iterate over every other element in `x` and `y`,
6567

68+
<!-- eslint-disable max-len -->
69+
6670
```javascript
6771
var Complex64Array = require( '@stdlib/array/complex64' );
6872
var Complex64 = require( '@stdlib/complex/float32/ctor' );
6973

70-
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] ); // eslint-disable-line max-params, max-len
71-
var x = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 2.0, 2.0, 0.0, 0.0, 0.0, 0.0, 3.0, 3.0 ] ); // eslint-disable-line max-params, max-len
72-
var y = new Complex64Array( [ 3.0, 3.0, 0.0, 0.0, 2.0, 2.0, 0.0, 0.0, 1.0, 1.0 ] ); // eslint-disable-line max-params, max-len
74+
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] );
75+
var x = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 0.0, 0.0, 2.0, 2.0, 0.0, 0.0, 0.0, 0.0, 3.0, 3.0 ] );
76+
var y = new Complex64Array( [ 3.0, 3.0, 0.0, 0.0, 2.0, 2.0, 0.0, 0.0, 1.0, 1.0 ] );
7377
var alpha = new Complex64( 0.5, 0.5 );
7478
var beta = new Complex64( 0.5, -0.5 );
7579

@@ -81,14 +85,16 @@ Note that indexing is relative to the first index. To introduce an offset, use [
8185

8286
<!-- eslint-disable stdlib/capitalized-comments -->
8387

88+
<!-- eslint-disable max-len -->
89+
8490
```javascript
8591
var Complex64Array = require( '@stdlib/array/complex64' );
8692
var Complex64 = require( '@stdlib/complex/float32/ctor' );
8793

8894
// Initial arrays...
8995
var x0 = new Complex64Array( [ 0.0, 0.0, 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] );
90-
var y0 = new Complex64Array( [ 0.0, 0.0, 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] ); // eslint-disable-line max-params, max-len
91-
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] ); // eslint-disable-line max-params, max-len
96+
var y0 = new Complex64Array( [ 0.0, 0.0, 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] );
97+
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] );
9298
var alpha = new Complex64( 0.5, 0.5 );
9399
var beta = new Complex64( 0.5, -0.5 );
94100

@@ -104,13 +110,15 @@ chpmv( 'row-major', 'lower', 3, alpha, AP, x1, 1, beta, y1, 1 );
104110

105111
#### chpmv.ndarray( order, uplo, N, α, A, sap, oap, x, sx, ox, β, y, sy, oy )
106112

107-
Performs the matrix-vector operation `y = α*A*x + β*y` using alternative indexing semantics, where `α` and `β` are complex scalars, `x` and `y` are `N` element complex vectors, and `A` is an `N` by `N` Hermitian matrix supplied in packed form.
113+
Performs the matrix-vector operation `y = α*A*x + β*y` using alternative indexing semantics, where `α` and `β` are scalars, `x` and `y` are `N` element vectors, and `A` is an `N` by `N` Hermitian matrix supplied in packed form.
114+
115+
<!-- eslint-disable max-len -->
108116

109117
```javascript
110118
var Complex64Array = require( '@stdlib/array/complex64' );
111119
var Complex64 = require( '@stdlib/complex/float32/ctor' );
112120

113-
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] ); // eslint-disable-line max-params, max-len
121+
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] );
114122
var x = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] );
115123
var y = new Complex64Array( [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] );
116124
var alpha = new Complex64( 0.5, 0.5 );
@@ -129,13 +137,15 @@ The function has the following additional parameters:
129137

130138
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,
131139

140+
<!-- eslint-disable max-len -->
141+
132142
```javascript
133143
var Complex64Array = require( '@stdlib/array/complex64' );
134144
var Complex64 = require( '@stdlib/complex/float32/ctor' );
135145

136-
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] ); // eslint-disable-line max-params, max-len
146+
var AP = new Complex64Array( [ 1.0, 0.0, 2.0, -2.0, 4.0, 0.0, 3.0, -3.0, 5.0, -5.0, 6.0, 0.0 ] );
137147
var x = new Complex64Array( [ 0.0, 0.0, 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] );
138-
var y = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 2.0, 2.0, 0.0, 0.0, 3.0, 3.0 ] ); // eslint-disable-line max-params, max-len
148+
var y = new Complex64Array( [ 1.0, 1.0, 0.0, 0.0, 2.0, 2.0, 0.0, 0.0, 3.0, 3.0 ] );
139149

140150
var alpha = new Complex64( 0.5, 0.5 );
141151
var beta = new Complex64( 0.5, -0.5 );
@@ -164,6 +174,8 @@ chpmv.ndarray( 'row-major', 'lower', 3, alpha, AP, 1, 0, x, 1, 1, beta, y, -2, 4
164174

165175
<!-- eslint no-undef: "error" -->
166176

177+
<!-- eslint-disable max-len -->
178+
167179
```javascript
168180
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
169181
var Complex64 = require( '@stdlib/complex/float32/ctor' );
@@ -172,12 +184,12 @@ var logEach = require( '@stdlib/console/log-each' );
172184
var chpmv = require( '@stdlib/blas/base/chpmv' );
173185

174186
function rand() {
175-
return new Complex64( discreteUniform( 0, 255 ), discreteUniform( -128, 127 ) ); // eslint-disable-line max-params, max-len
187+
return new Complex64( discreteUniform( 0, 255 ), discreteUniform( -128, 127 ) );
176188
}
177189

178190
var N = 5;
179191

180-
var AP = filledarrayBy( N * ( N + 1 ) / 2, 'complex64', rand );
192+
var AP = filledarrayBy( N*(N+1)/2, 'complex64', rand );
181193
var x = filledarrayBy( N, 'complex64', rand );
182194
var y = filledarrayBy( N, 'complex64', rand );
183195

@@ -187,12 +199,12 @@ var beta = new Complex64( 0.5, -0.5 );
187199
chpmv( 'row-major', 'lower', N, alpha, AP, x, 1, beta, y, 1 );
188200

189201
// Print the results:
190-
logEach( '(%s)', x );
202+
logEach( '%s', x );
191203

192204
chpmv.ndarray( 'row-major', 'lower', N, alpha, AP, 1, 0, x, 1, 0, beta, y, 1, 0 );
193205

194206
// Print the results:
195-
logEach( '(%s)', x );
207+
logEach( '%s', x );
196208
```
197209

198210
</section>

lib/node_modules/@stdlib/blas/base/chpmv/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/blas/base/chpmv",
33
"version": "0.0.0",
4-
"description": "Performs the matrix-vector operation `y = α*A*x + β*y`, where `α` and `β` are complex scalars, `x` and `y` are `N` element complex vectors, and `A` is an `N` by `N` Hermitian matrix supplied in packed form.",
4+
"description": "Performs the matrix-vector operation `y = α*A*x + β*y`.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)