|
| 1 | + |
| 2 | +{{alias}}( N, zx, strideX, zy, strideY ) |
| 3 | + Calculate the dot product of two single-precision complex floating-point |
| 4 | + vectors. |
| 5 | + |
| 6 | + The `N` and stride parameters determine which elements in the strided |
| 7 | + arrays are accessed at runtime. |
| 8 | + |
| 9 | + Indexing is relative to the first index. To introduce an offset, use a |
| 10 | + typed array view. |
| 11 | + |
| 12 | + If `N <= 0`, the function returns `0 + 0i`. |
| 13 | + |
| 14 | + Parameters |
| 15 | + ---------- |
| 16 | + N: integer |
| 17 | + Number of indexed elements. |
| 18 | + |
| 19 | + zx: Complex64Array |
| 20 | + First input array. |
| 21 | + |
| 22 | + strideX: integer |
| 23 | + Index increment for `zx`. |
| 24 | + |
| 25 | + zy: Complex64Array |
| 26 | + Second input array. |
| 27 | + |
| 28 | + strideY: integer |
| 29 | + Index increment for `zy`. |
| 30 | + |
| 31 | + Returns |
| 32 | + ------- |
| 33 | + out: Complex64 |
| 34 | + Scalar constant. |
| 35 | + |
| 36 | + Examples |
| 37 | + -------- |
| 38 | + // Standard usage: |
| 39 | + > var zx = new {{alias:@stdlib/array/complex64}}( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] ); |
| 40 | + > var zy = new {{alias:@stdlib/array/complex64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] ); |
| 41 | + > var z = {{alias}}( 3, zx, 1, zy, 1 ); |
| 42 | + > var re = {{alias:@stdlib/complex/float32/real}}( z ) |
| 43 | + -52.0 |
| 44 | + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) |
| 45 | + 82.0 |
| 46 | + |
| 47 | + // Advanced indexing: |
| 48 | + > var zx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); |
| 49 | + > var zy = new {{alias:@stdlib/array/complex64}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] ); |
| 50 | + > var z = {{alias}}( 2, zx, 2, zy, -1 ); |
| 51 | + > var re = {{alias:@stdlib/complex/float32/real}}( z ) |
| 52 | + -2.0 |
| 53 | + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) |
| 54 | + 14.0 |
| 55 | + |
| 56 | + // Using typed array views: |
| 57 | + > var zx0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); |
| 58 | + > var zy0 = new {{alias:@stdlib/array/complex64}}( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); |
| 59 | + > var zx1 = new {{alias:@stdlib/array/complex64}}( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); |
| 60 | + > var zy1 = new {{alias:@stdlib/array/complex64}}( zy0.buffer, zy0.BYTES_PER_ELEMENT*2 ); |
| 61 | + > var z = {{alias}}( 1, zx1, 1, zy1, 1 ); |
| 62 | + > var re = {{alias:@stdlib/complex/float32/real}}( z ) |
| 63 | + -15.0 |
| 64 | + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) |
| 65 | + 80.0 |
| 66 | + |
| 67 | + |
| 68 | +{{alias}}.ndarray( N, zx, strideX, offsetX, zy, strideY, offsetY ) |
| 69 | + Computes the dot product of two single-precision complex floating-point |
| 70 | + vectors using alternative indexing semantics. |
| 71 | + |
| 72 | + While typed array views mandate a view offset based on the underlying |
| 73 | + buffer, the offset parameters support indexing based on a starting index. |
| 74 | + |
| 75 | + Parameters |
| 76 | + ---------- |
| 77 | + N: integer |
| 78 | + Number of indexed elements. |
| 79 | + |
| 80 | + zx: Complex64Array |
| 81 | + First input array. |
| 82 | + |
| 83 | + strideX: integer |
| 84 | + Index increment for `zx`. |
| 85 | + |
| 86 | + offsetX: integer |
| 87 | + Starting index for `zx`. |
| 88 | + |
| 89 | + zy: Complex64Array |
| 90 | + Second input array. |
| 91 | + |
| 92 | + strideY: integer |
| 93 | + Index increment for `zy`. |
| 94 | + |
| 95 | + offsetY: integer |
| 96 | + Starting index for `zy`. |
| 97 | + |
| 98 | + Returns |
| 99 | + ------- |
| 100 | + out: Complex64 |
| 101 | + Second input array. |
| 102 | + |
| 103 | + Examples |
| 104 | + -------- |
| 105 | + // Standard usage: |
| 106 | + > var zx = new {{alias:@stdlib/array/complex64}}( [ 4.0, 2.0, -3.0, 5.0, -1.0, 7.0 ] ); |
| 107 | + > var zy = new {{alias:@stdlib/array/complex64}}( [ 2.0, 6.0, -1.0, -4.0, 8.0, 9.0 ] ); |
| 108 | + > var z = {{alias}}.ndarray( zx.length, zx, 1, 0, zy, 1, 0 ); |
| 109 | + > var re = {{alias:@stdlib/complex/float32/real}}( z ) |
| 110 | + -52.0 |
| 111 | + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) |
| 112 | + 82.0 |
| 113 | + |
| 114 | + // Advanced indexing: |
| 115 | + > var zx = new {{alias:@stdlib/array/complex64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); |
| 116 | + > var zy = new {{alias:@stdlib/array/complex64}}( [ 9.0, 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, 16.0 ] ); |
| 117 | + > var z = {{alias}}.ndarray( 2, zx, 2, 1, zy, -1, zy.length-1 ); |
| 118 | + > var re = {{alias:@stdlib/complex/float32/real}}( z ) |
| 119 | + -40.0 |
| 120 | + > var im = {{alias:@stdlib/complex/float32/imag}}( z ) |
| 121 | + 310.0 |
| 122 | + |
| 123 | + See Also |
| 124 | + -------- |
0 commit comments