Skip to content

Commit d8d41e6

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
chore: update repl.txt
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: passed - 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 844115d commit d8d41e6

File tree

1 file changed

+18
-21
lines changed
  • lib/node_modules/@stdlib/blas/base/zher2/docs

1 file changed

+18
-21
lines changed

lib/node_modules/@stdlib/blas/base/zher2/docs/repl.txt

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,13 @@
11

22
{{alias}}( order, uplo, N, α, x, strideX, y, strideY, A, LDA )
3-
Performs the hermitian rank 2 operation
4-
`A = α*x*y**H + conjg( α )*y*x**H + A`, where `α` is a scalar,
5-
`x` and `y` are `N` element vectors and `A` is an `N` by `N` hermitian
6-
matrix.
3+
Performs the hermitian rank 2 operation `A = α*x*y^H + conjg( α )*y*x^H + A`
4+
where `α` is a scalar, `x` and `y` are `N` element vectors and `A` is an `N`
5+
by `N` hermitian matrix.
76

87
Indexing is relative to the first index. To introduce an offset, use typed
98
array views.
109

11-
If `N` is equal to `0`, the function returns `A` unchanged.
12-
13-
If `α` is equal to `0`, the function returns `A` unchanged.
10+
If `N` or `α` is equal to `0`, the function returns `A` unchanged.
1411

1512
Parameters
1613
----------
@@ -31,13 +28,13 @@
3128
First input array.
3229

3330
strideX: integer
34-
Index increment for `x`.
31+
Stride length for `x`.
3532

3633
y: Complex128Array
3734
Second input array.
3835

3936
strideY: integer
40-
Index increment for `y`.
37+
Stride length for `y`.
4138

4239
A: Complex128Array
4340
Input matrix.
@@ -62,10 +59,10 @@
6259
<Complex128Array>[ 11.0, 0.0, 0.0, 0.0, 27.0, 2.0, 57.0, 0.0 ]
6360

6461
// Advanced indexing:
65-
> var x = new {{alias:@stdlib/array/complex128}}( [ 3.0, 4.0, 1.0, 2.0 ] );
66-
> var y = new {{alias:@stdlib/array/complex128}}( [ 3.0, 4.0, 1.0, 2.0 ] );
67-
> var A = new {{alias:@stdlib/array/complex128}}( [ 1.0, 0.0, 0.0, 0.0, 5.0, 6.0, 7.0, 0.0 ] );
68-
> var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 0.0 );
62+
> x = new {{alias:@stdlib/array/complex128}}( [ 3.0, 4.0, 1.0, 2.0 ] );
63+
> y = new {{alias:@stdlib/array/complex128}}( [ 3.0, 4.0, 1.0, 2.0 ] );
64+
> A = new {{alias:@stdlib/array/complex128}}( [ 1.0, 0.0, 0.0, 0.0, 5.0, 6.0, 7.0, 0.0 ] );
65+
> alpha = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 0.0 );
6966
> {{alias}}( 'row-major', 'lower', 2, alpha, x, -1, y, -1, A, 2 )
7067
<Complex128Array>[ 11.0, 0.0, 0.0, 0.0, 27.0, 2.0, 57.0, 0.0 ]
7168

@@ -74,17 +71,17 @@
7471
> var y0 = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0 ] );
7572
> var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
7673
> var y1 = new {{alias:@stdlib/array/complex128}}( y0.buffer, y0.BYTES_PER_ELEMENT*1 );
77-
> var A = new {{alias:@stdlib/array/complex128}}( [ 1.0, 0.0, 0.0, 0.0, 5.0, 6.0, 7.0, 0.0 ] );
78-
> var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 0.0 );
74+
> A = new {{alias:@stdlib/array/complex128}}( [ 1.0, 0.0, 0.0, 0.0, 5.0, 6.0, 7.0, 0.0 ] );
75+
> alpha = new {{alias:@stdlib/complex/float64/ctor}}( 1.0, 0.0 );
7976
> {{alias}}( 'row-major', 'lower', 2, alpha, x1, -1, y1, -1, A, 2 )
8077
<Complex128Array>[ 11.0, 0.0, 0.0, 0.0, 27.0, 2.0, 57.0, 0.0 ]
8178

8279

8380
{{alias}}.ndarray( uplo, N, α, x, sx, ox, y, sy, oy, A, sa1, sa2, oa )
84-
Performs the hermitian rank 2 operation
85-
`A = α*x*y**H + conjg( α )*y*x**H + A`, where `α` is a scalar,
86-
`x` and `y` are `N` element vectors and `A` is an `N` by `N` hermitian
87-
matrix using alternative indexing semantics.
81+
Performs the hermitian rank 2 operation `A = α*x*y^H + conjg( α )*y*x^H + A`
82+
using alternative indexing semantics and where `α` is a scalar, `x` and `y`
83+
are `N` element vectors and `A` is an `N` by `N` hermitian matrix using
84+
alternative indexing semantics.
8885

8986
While typed array views mandate a view offset based on the underlying
9087
buffer, the offset parameter supports indexing semantics based on a starting
@@ -106,7 +103,7 @@
106103
First input array.
107104

108105
sx: integer
109-
Index increment for `x`.
106+
Stride length for `x`.
110107

111108
ox: integer
112109
Starting index for `x`.
@@ -115,7 +112,7 @@
115112
Second input array.
116113

117114
sy: integer
118-
Index increment for `y`.
115+
Stride length for `y`.
119116

120117
oy: integer
121118
Starting index for `y`.

0 commit comments

Comments
 (0)