Skip to content

Commit 1ebc801

Browse files
committed
chore: update markdown
--- 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: 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent e034063 commit 1ebc801

File tree

1 file changed

+20
-20
lines changed
  • lib/node_modules/@stdlib/blas/base/ssymv

1 file changed

+20
-20
lines changed

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

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ Performs the matrix-vector operation `y = α*A*x + β*y` where `α` and `β` are
3737
```javascript
3838
var Float32Array = require( '@stdlib/array/float32' );
3939

40-
var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
40+
var A = new Float32Array( [ 1.0, 4.0, 5.0, 4.0, 2.0, 6.0, 5.0, 6.0, 3.0 ] );
4141
var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
4242
var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
4343

4444
ssymv( 'row-major', 'lower', 3, 1.0, A, 3, x, 1, 0.0, y, 1 );
45-
// y => <Float32Array>[ 1.0, 2.0, 3.0 ]
45+
// y => <Float32Array>[ 10.0, 12.0, 14.0 ]
4646
```
4747

4848
The function has the following parameters:
@@ -54,22 +54,22 @@ The function has the following parameters:
5454
- **A**: input matrix stored in linear memory as a [`Float32Array`][mdn-float32array].
5555
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
5656
- **x**: input [`Float32Array`][mdn-float32array].
57-
- **sx**: index increment for `x`.
57+
- **sx**: stride length for `x`.
5858
- **β**: scalar constant.
5959
- **y**: output [`Float32Array`][mdn-float32array].
60-
- **sy**: index increment for `y`.
60+
- **sy**: stride length for `y`.
6161

6262
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,
6363

6464
```javascript
6565
var Float32Array = require( '@stdlib/array/float32' );
6666

67-
var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
68-
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
69-
var y = new Float32Array( [ 1.0, 2.0, 3.0 ] );
67+
var A = new Float32Array( [ 1.0, 4.0, 5.0, 4.0, 2.0, 6.0, 5.0, 6.0, 3.0 ] );
68+
var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
69+
var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
7070

71-
ssymv( 'row-major', 'upper', 3, 2.0, A, 3, x, -1, 1.0, y, 1 );
72-
// y => <Float32Array>[ 7.0, 10.0, 9.0 ]
71+
ssymv( 'row-major', 'upper', 3, 1.0, A, 3, x, -1, 1.0, y, 1 );
72+
// y => <Float32Array>[ 10.0, 12.0, 14.0 ]
7373
```
7474

7575
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -81,15 +81,15 @@ var Float32Array = require( '@stdlib/array/float32' );
8181

8282
// Initial arrays...
8383
var x0 = new Float32Array( [ 1.0, 1.0, 1.0, 1.0 ] );
84-
var y0 = new Float32Array( [ 1.0, 1.0, 1.0, 1.0 ] );
85-
var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
84+
var y0 = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] );
85+
var A = new Float32Array( [ 1.0, 4.0, 5.0, 4.0, 2.0, 6.0, 5.0, 6.0, 3.0 ] );
8686

8787
// Create offset views...
8888
var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8989
var y1 = new Float32Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
9090

9191
ssymv( 'row-major', 'upper', 3, 1.0, A, 3, x1, -1, 1.0, y1, -1 );
92-
// y0 => <Float32Array>[ 1.0, 4.0, 3.0, 2.0 ]
92+
// y0 => <Float32Array>[ 0.0, 14.0, 12.0, 10.0 ]
9393
```
9494

9595
#### ssymv.ndarray( uplo, N, α, A, sa1, sa2, oa, x, sx, ox, β, y, sy, oy )
@@ -99,12 +99,12 @@ Performs the matrix-vector operation `y = α*A*x + β*y` using alternative index
9999
```javascript
100100
var Float32Array = require( '@stdlib/array/float32' );
101101

102-
var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
103-
var x = new Float32Array( [ 1.0, 2.0, 3.0 ] );
104-
var y = new Float32Array( [ 1.0, 2.0, 3.0 ] );
102+
var A = new Float32Array( [ 1.0, 4.0, 5.0, 4.0, 2.0, 6.0, 5.0, 6.0, 3.0 ] );
103+
var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
104+
var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
105105

106-
ssymv.ndarray( 'upper', 3, 2.0, A, 3, 1, 0, x, -1, 2, 1.0, y, 1, 0 );
107-
// y => <Float32Array>[ 7.0, 10.0, 9.0 ]
106+
ssymv.ndarray( 'upper', 3, 1.0, A, 3, 1, 0, x, -1, 2, 1.0, y, 1, 0 );
107+
// y => <Float32Array>[ 10.0, 12.0, 14.0 ]
108108
```
109109

110110
The function has the following additional parameters:
@@ -120,12 +120,12 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
120120
```javascript
121121
var Float32Array = require( '@stdlib/array/float32' );
122122

123-
var A = new Float32Array( [ 1.0, 0.0, 0.0, 0.0, 2.0, 0.0, 0.0, 0.0, 3.0 ] );
123+
var A = new Float32Array( [ 1.0, 4.0, 5.0, 4.0, 2.0, 6.0, 5.0, 6.0, 3.0 ] );
124124
var x = new Float32Array( [ 1.0, 1.0, 1.0 ] );
125-
var y = new Float32Array( [ 1.0, 1.0, 1.0 ] );
125+
var y = new Float32Array( [ 0.0, 0.0, 0.0 ] );
126126

127127
ssymv.ndarray( 'lower', 3, 1.0, A, 3, 1, 0, x, -1, 2, 1.0, y, -1, 2 );
128-
// y => <Float32Array>[ 4.0, 3.0, 2.0 ]
128+
// y => <Float32Array>[ 14.0, 12.0, 10.0 ]
129129
```
130130

131131
</section>

0 commit comments

Comments
 (0)