|
1 | 1 |
|
2 | 2 | {{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. |
7 | 6 |
|
8 | 7 | Indexing is relative to the first index. To introduce an offset, use typed |
9 | 8 | array views. |
10 | 9 |
|
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. |
14 | 11 |
|
15 | 12 | Parameters |
16 | 13 | ---------- |
|
31 | 28 | First input array. |
32 | 29 |
|
33 | 30 | strideX: integer |
34 | | - Index increment for `x`. |
| 31 | + Stride length for `x`. |
35 | 32 |
|
36 | 33 | y: Complex128Array |
37 | 34 | Second input array. |
38 | 35 |
|
39 | 36 | strideY: integer |
40 | | - Index increment for `y`. |
| 37 | + Stride length for `y`. |
41 | 38 |
|
42 | 39 | A: Complex128Array |
43 | 40 | Input matrix. |
|
62 | 59 | <Complex128Array>[ 11.0, 0.0, 0.0, 0.0, 27.0, 2.0, 57.0, 0.0 ] |
63 | 60 |
|
64 | 61 | // 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 ); |
69 | 66 | > {{alias}}( 'row-major', 'lower', 2, alpha, x, -1, y, -1, A, 2 ) |
70 | 67 | <Complex128Array>[ 11.0, 0.0, 0.0, 0.0, 27.0, 2.0, 57.0, 0.0 ] |
71 | 68 |
|
|
74 | 71 | > var y0 = new {{alias:@stdlib/array/complex128}}( [ 0.0, 0.0, 3.0, 4.0, 1.0, 2.0 ] ); |
75 | 72 | > var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); |
76 | 73 | > 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 ); |
79 | 76 | > {{alias}}( 'row-major', 'lower', 2, alpha, x1, -1, y1, -1, A, 2 ) |
80 | 77 | <Complex128Array>[ 11.0, 0.0, 0.0, 0.0, 27.0, 2.0, 57.0, 0.0 ] |
81 | 78 |
|
82 | 79 |
|
83 | 80 | {{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. |
88 | 85 |
|
89 | 86 | While typed array views mandate a view offset based on the underlying |
90 | 87 | buffer, the offset parameter supports indexing semantics based on a starting |
|
106 | 103 | First input array. |
107 | 104 |
|
108 | 105 | sx: integer |
109 | | - Index increment for `x`. |
| 106 | + Stride length for `x`. |
110 | 107 |
|
111 | 108 | ox: integer |
112 | 109 | Starting index for `x`. |
|
115 | 112 | Second input array. |
116 | 113 |
|
117 | 114 | sy: integer |
118 | | - Index increment for `y`. |
| 115 | + Stride length for `y`. |
119 | 116 |
|
120 | 117 | oy: integer |
121 | 118 | Starting index for `y`. |
|
0 commit comments