Skip to content

Commit c7f20c0

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
chore: update markdown file
--- 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 1270d7c commit c7f20c0

File tree

1 file changed

+10
-7
lines changed
  • lib/node_modules/@stdlib/blas/base/dsbmv

1 file changed

+10
-7
lines changed

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

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

2121
# dsbmv
2222

23-
> Perform the matrix-vector operation `y = alpha*A*x + beta*y` where `alpha` and `beta` are scalars, `x` and `y` are `N` element vectors, and `A` is an `N` by `N` symmetric band matrix, with `K` super-diagonals.
23+
> Perform the matrix-vector operation `y = alpha*A*x + beta*y`.
2424
2525
<section class="usage">
2626

@@ -55,10 +55,10 @@ The function has the following parameters:
5555
- **A**: packed banded form of a symmetric matrix `A` stored in linear memory as a [`Float64Array`][mdn-float64array].
5656
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
5757
- **x**: input [`Float64Array`][mdn-float64array].
58-
- **sx**: index increment for `x`.
58+
- **sx**: stride length for `x`.
5959
- **β**: scalar constant.
6060
- **y**: output [`Float64Array`][mdn-float64array].
61-
- **sy**: index increment for `y`.
61+
- **sy**: stride length for `y`.
6262

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

@@ -111,8 +111,8 @@ dsbmv.ndarray( 'lower', 3, 1, 1.0, A, 2, 1, 0, x, 1, 0, 0.0, y, 1, 0 );
111111
The function has the following additional parameters:
112112

113113
- **oa**: starting index for `A`.
114-
- **sa1**: first dimension index increment for `A`.
115-
- **sa2**: second dimension index increment for `A`.
114+
- **sa1**: first dimension stride length for `A`.
115+
- **sa2**: second dimension stride length for `A`.
116116
- **ox**: starting index for `x`.
117117
- **oy**: starting index for `y`.
118118

@@ -158,12 +158,15 @@ var opts = {
158158
};
159159

160160
var N = 3;
161-
var A = [ 1, 2, 0, 3, 4, 5 ];
161+
var A = [ 1.0, 2.0, 3.0, 4.0, 5.0, 0.0 ];
162162

163163
var x = discreteUniform( N, -10, 10, opts );
164164
var y = discreteUniform( N, -10, 10, opts );
165165

166-
dsbmv.ndarray( 'upper', N, 1, 1.0, A, 1, 2, 0, x, 1, 0, 1.0, y, 1, 0 );
166+
dsbmv( 'row-major', 'upper', N, 1, 1.0, A, 2, x, 1, 1.0, y, 1 );
167+
console.log( y );
168+
169+
dsbmv.ndarray( 'upper', N, 1, 1.0, A, 2, 1, 0, x, 1, 0, 1.0, y, 1, 0 );
167170
console.log( y );
168171
```
169172

0 commit comments

Comments
 (0)