Skip to content

Commit 098c622

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
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 a11c94a commit 098c622

File tree

1 file changed

+6
-6
lines changed
  • lib/node_modules/@stdlib/blas/base/zher2

1 file changed

+6
-6
lines changed

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

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

2121
# zher2
2222

23-
> Perform the hermitian rank 2 operation `A = α*x*y**H + conjg( α )*y*x**H + A`.
23+
> Perform the hermitian rank 2 operation `A = α*x*y^H + conjg( α )*y*x^H + A`.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var zher2 = require( '@stdlib/blas/base/zher2' );
3232

3333
#### zher2( order, uplo, N, α, x, strideX, y, strideY, A, LDA )
3434

35-
Performs the hermitian rank 2 operation `A = α*x*y**H + conjg( α )*y*x**H + A`, where `α` is a scalar, `x` and `y` are `N` element vectors and `A` is an `N` by `N` hermitian matrix.
35+
Performs the hermitian rank 2 operation `A = α*x*y^H + conjg( α )*y*x^H + A`, where `α` is a scalar, `x` and `y` are `N` element vectors and `A` is an `N` by `N` hermitian matrix.
3636

3737
```javascript
3838
var Complex128Array = require( '@stdlib/array/complex128' );
@@ -54,9 +54,9 @@ The function has the following parameters:
5454
- **N**: specifies the order of the matrix `A`.
5555
- **α**: scalar constant.
5656
- **x**: first input vector [`Complex128Array`][@stdlib/array/complex128].
57-
- **strideX**: index increment for `x`.
57+
- **strideX**: stride length for `x`.
5858
- **y**: second input vector [`Complex128Array`][@stdlib/array/complex128].
59-
- **strideY**: index increment for `y`.
59+
- **strideY**: stride length for `y`.
6060
- **A**: input matrix stored in linear memory as [`Complex128Array`][@stdlib/array/complex128].
6161
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
6262

@@ -104,7 +104,7 @@ zher2( 'row-major', 'lower', x1.length, alpha, x1, 1, y1, 1, A, 2 );
104104

105105
#### zher2.ndarray( uplo, N, α, x, strideX, offsetX, y, strideY, offsetY, A, strideA1, strideA2, offsetA )
106106

107-
Performs the hermitian rank 2 operation `A = α*x*y**H + conjg( α )*y*x**H + A`, using alternative indexing semantics and where `α` is a scalar, `x` and `y` are `N` element vectors and `A` is an `N` by `N` hermitian matrix.
107+
Performs the hermitian rank 2 operation `A = α*x*y^H + conjg( α )*y*x^H + A`, using alternative indexing semantics and where `α` is a scalar, `x` and `y` are `N` element vectors and `A` is an `N` by `N` hermitian matrix.
108108

109109
```javascript
110110
var Complex128Array = require( '@stdlib/array/complex128' );
@@ -285,7 +285,7 @@ TODO
285285

286286
[blas]: http://www.netlib.org/blas
287287

288-
[zher2]: https://www.netlib.org/lapack/explore-html/dd/de5/group__her2_gaf421f493e6422d08e3acfc6d33bfbf46.html
288+
[zher2]: https://netlib.org/lapack/explore-html//dd/de5/group__her2_ga565bc80dabd392f5a1cb900768b21db4.html
289289

290290
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
291291

0 commit comments

Comments
 (0)