Skip to content

Commit f0da964

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 3348010 commit f0da964

2 files changed

Lines changed: 30 additions & 18 deletions

File tree

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

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

2121
# ctpmv
2222

23-
> Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`, or `x = A**H*x` for complex-valued data.
23+
> Perform one of the matrix-vector operations `x = A*x` or `x = A^T*x` or `x = A**H*x` for complex-valued data.
2424
2525
<section class="usage">
2626

@@ -32,13 +32,15 @@ var ctpmv = require( '@stdlib/blas/base/ctpmv' );
3232

3333
#### ctpmv( order, uplo, trans, diag, N, AP, x, sx )
3434

35-
Performs one of the matrix-vector operations `x = A*x`, or `x = A**T*x`, or `x = A**H*x`, where `x` is an `N` element complex vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular complex matrix, supplied in packed form.
35+
Performs one of the matrix-vector operations `x = A*x` or `x = A**T*x` or `x = A**H*x`, where `x` is an `N` element vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix, supplied in packed form.
3636

3737

38+
<!-- eslint-disable max-len -->
39+
3840
```javascript
3941
var Complex64Array = require( '@stdlib/array/complex64' );
4042

41-
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] ); // eslint-disable-line max-params, max-len
43+
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] );
4244
var x = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] );
4345

4446
ctpmv( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, x, 1 );
@@ -52,16 +54,18 @@ The function has the following parameters:
5254
- **trans**: specifies whether `A` should be transposed, conjugate-transposed, or not transposed.
5355
- **diag**: specifies whether `A` has a unit diagonal.
5456
- **N**: number of elements along each dimension of `A`.
55-
- **AP**: Complex input matrix in packed form stored in linear memory as a [`Complex64Array`][@stdlib/array/complex64].
56-
- **x**: complex input vector [`Complex64Array`][@stdlib/array/complex64].
57+
- **AP**: input matrix in packed form stored in linear memory as a [`Complex64Array`][@stdlib/array/complex64].
58+
- **x**: input vector [`Complex64Array`][@stdlib/array/complex64].
5759
- **sx**: stride length for `x`.
5860

5961
The stride parameters determine how elements in the input arrays are accessed at runtime. For example, to iterate over the elements of `x` in reverse order,
6062

63+
<!-- eslint-disable max-len -->
64+
6165
```javascript
6266
var Complex64Array = require( '@stdlib/array/complex64' );
6367

64-
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] ); // eslint-disable-line max-params, max-len
68+
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] );
6569
var x = new Complex64Array( [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] );
6670

6771
ctpmv( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, x, -1 );
@@ -72,13 +76,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [
7276

7377
<!-- eslint-disable stdlib/capitalized-comments -->
7478

79+
<!-- eslint-disable max-len -->
80+
7581
```javascript
7682
var Complex64Array = require( '@stdlib/array/complex64' );
7783
var Complex64 = require( '@stdlib/complex/float32/ctor' );
7884

7985
// Initial arrays...
8086
var x0 = new Complex64Array( [ 0.0, 0.0, 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] );
81-
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] ); // eslint-disable-line max-params, max-len
87+
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] );
8288

8389
// Create offset views...
8490
var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd complex element
@@ -91,15 +97,17 @@ ctpmv( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, x1, 1 );
9197

9298
#### ctpmv.ndarray( order, uplo, trans, diag, N, AP, sap, oap, x, sx, ox )
9399

94-
Performs one of the matrix-vector operations `x = A*x`, or `x = A**T*x`, or `x = A**H*x`, using alternative indexing semantics and where `x` is an `N` element complex vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular complex matrix, supplied in packed form.
100+
Performs one of the matrix-vector operations `x = A*x` or `x = A**T*x` or `x = A**H*x`, using alternative indexing semantics and where `x` is an `N` element complex vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix, supplied in packed form.
101+
102+
<!-- eslint-disable max-len -->
95103

96104
```javascript
97105
var Complex64Array = require( '@stdlib/array/complex64' );
98106

99-
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] ); // eslint-disable-line max-params, max-len
100-
var x = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ); // eslint-disable-line max-params, max-len
107+
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] );
108+
var x = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] );
101109

102-
ctpmv.ndarray( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, 1, 0, x, 1, 0 ); // eslint-disable-line max-params, max-len
110+
ctpmv.ndarray( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, 1, 0, x, 1, 0 );
103111
// x => <Complex64Array>[ 0.0, 2.0, 0.0, 20.0, 0.0, 62.0 ]
104112
```
105113

@@ -111,13 +119,15 @@ The function has the following additional parameters:
111119

112120
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,
113121

122+
<!-- eslint-disable max-len -->
123+
114124
```javascript
115125
var Complex64Array = require( '@stdlib/array/complex64' );
116126

117-
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] ); // eslint-disable-line max-params, max-len
127+
var AP = new Complex64Array( [ 1.0, 1.0, 2.0, 2.0, 4.0, 4.0, 3.0, 3.0, 5.0, 5.0, 6.0, 6.0 ] );
118128
var x = new Complex64Array( [ 3.0, 3.0, 2.0, 2.0, 1.0, 1.0 ] );
119129

120-
ctpmv.ndarray( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, 1, 0, x, -1, 2 ); // eslint-disable-line max-params, max-len
130+
ctpmv.ndarray( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, 1, 0, x, -1, 2 );
121131
// x => <Complex64Array>[ 0.0, 62.0, 0.0, 20.0, 0.0, 2.0 ]
122132
```
123133

@@ -141,6 +151,8 @@ ctpmv.ndarray( 'row-major', 'lower', 'no-transpose', 'non-unit', 3, AP, 1, 0, x,
141151

142152
<!-- eslint no-undef: "error" -->
143153

154+
<!-- eslint-disable max-len -->
155+
144156
```javascript
145157
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
146158
var Complex64 = require( '@stdlib/complex/float32/ctor' );
@@ -149,23 +161,23 @@ var logEach = require( '@stdlib/console/log-each' );
149161
var ctpmv = require( '@stdlib/blas/base/ctpmv' );
150162

151163
function rand() {
152-
return new Complex64( discreteUniform( 0, 255 ), discreteUniform( -128, 127 ) ); // eslint-disable-line max-params, max-len
164+
return new Complex64( discreteUniform( 0, 255 ), discreteUniform( -128, 127 ) );
153165
}
154166

155167
var N = 5;
156168

157-
var AP = filledarrayBy( N * ( N + 1 ) / 2, 'complex64', rand );
169+
var AP = filledarrayBy( N*(N+1)/2, 'complex64', rand );
158170
var x = filledarrayBy( N, 'complex64', rand );
159171

160172
ctpmv( 'column-major', 'lower', 'no-transpose', 'non-unit', N, AP, x, 1 );
161173

162174
// Print the results:
163-
logEach( '(%s)', x );
175+
logEach( '%s', x );
164176

165177
ctpmv.ndarray( 'row-major', 'upper', 'transpose', 'unit', N, AP, 1, 0, x, 1, 0 );
166178

167179
// Print the results:
168-
logEach( '(%s)', x );
180+
logEach( '%s', x );
169181
```
170182

171183
</section>

lib/node_modules/@stdlib/blas/base/ctpmv/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/ctpmv",
33
"version": "0.0.0",
4-
"description": "Performs one of the matrix-vector operations `x = A*x`, or `x = A**T*x`, or `x = A**H*x`, where `x` is an `N` element vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix, supplied in packed form.",
4+
"description": "Performs one of the matrix-vector operations `x = A*x` or `x = A**T*x` or `x = A**H*x`.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)