Skip to content

Commit 411c9b1

Browse files
committed
chore: update repl.txt
1 parent 2bde17e commit 411c9b1

File tree

1 file changed

+49
-66
lines changed
  • lib/node_modules/@stdlib/blas/base/zaxpy/docs

1 file changed

+49
-66
lines changed
Lines changed: 49 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,71 @@
11

2-
{{alias}}( N, za, zx, strideX, zy, strideY )
2+
{{alias}}( N, alpha, x, strideX, y, strideY )
33
Scales a double-precision complex floating-point vector by a double-
44
precision complex floating point constant and adds the result to a double-
55
precision complex floating-point vector.
66

7-
The `N` and stride parameters determine how values from `zx` are scaled by
8-
`za` and added to `zy`.
7+
The `N` and stride parameters determine how values from `x` are scaled by
8+
`alpha` and added to `y`.
99

1010
Indexing is relative to the first index. To introduce an offset, use typed
1111
array views.
1212

13-
If `N` is less than or equal to `0`, the function returns `zy` unchanged.
13+
If `N` is less than or equal to `0`, the function returns `y` unchanged.
14+
15+
If `alpha` is equal to `0`, the function returns `y` unchanged.
1416

1517
Parameters
1618
----------
1719
N: integer
1820
Number of indexed elements.
1921

20-
za: Complex128
22+
alpha: Complex128
2123
Scalar constant.
2224

23-
zx: Complex128Array
25+
x: Complex128Array
2426
First input array.
2527

2628
strideX: integer
27-
Index increment for `zx`.
29+
Stride length for `x`.
2830

29-
zy: Complex128Array
31+
y: Complex128Array
3032
Second input array.
3133

3234
strideY: integer
33-
Index increment for `zy`.
35+
Stride length for `y`.
3436

3537
Returns
3638
-------
37-
zy: Complex128Array
39+
y: Complex128Array
3840
Second input array.
3941

4042
Examples
4143
--------
4244
// Standard usage:
43-
> var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
44-
> var zy = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0 ] );
45-
> var za = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 );
46-
> {{alias}}( 2, za, zx, 1, zy, 1 );
47-
> var z = zy.get( 0 );
48-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
49-
-1.0
50-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
51-
7.0
45+
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
46+
> var y = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0 ] );
47+
> var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 );
48+
> {{alias}}( 2, alpha, x, 1, y, 1 )
49+
<Complex128Array>[ -1.0, 7.0, -1.0, 15.0 ]
5250

5351
// Advanced indexing:
54-
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
55-
> zy = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
56-
> {{alias}}( 2, za, zx, -2, zy, 1 );
57-
> z = zy.get( 0 );
58-
> re = {{alias:@stdlib/complex/float64/real}}( z )
59-
-1.0
60-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
61-
23.0
52+
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
53+
> y = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
54+
> {{alias}}( 2, alpha, x, -2, y, 1 )
55+
<Complex128Array>[ -1.0, 23.0, -1.0, 7.0, 1.0, 1.0 ]
6256

6357
// Using typed array views:
64-
> var zx0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
65-
> var zy0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0 ] );
66-
> var zx1 = new {{alias:@stdlib/array/complex128}}( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 );
67-
> var zy1 = new {{alias:@stdlib/array/complex128}}( zy0.buffer, zy0.BYTES_PER_ELEMENT*1 );
68-
> {{alias}}( 1, za, zx1, 1, zy1, 1 );
69-
> z = zy0.get( 1 );
70-
> re = {{alias:@stdlib/complex/float64/real}}( z )
71-
-1.0
72-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
73-
15.0
74-
75-
76-
{{alias}}.ndarray( N, za, zx, strideX, offsetX, zy, strideY, offsetY )
58+
> var x0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
59+
> var y0 = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0 ] );
60+
> var x1 = new {{alias:@stdlib/array/complex128}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
61+
> var y1 = new {{alias:@stdlib/array/complex128}}( y0.buffer, y0.BYTES_PER_ELEMENT*1 );
62+
> {{alias}}( 1, alpha, x1, 1, y1, 1 )
63+
<Complex128Array>[ -1.0, 15.0 ]
64+
> y0
65+
<Complex128Array>[ 1.0, 1.0, -1.0, 15.0 ]
66+
67+
68+
{{alias}}.ndarray( N, alpha, x, strideX, offsetX, y, strideY, offsetY )
7769
Scales a double-precision complex floating-point vector by a double-
7870
precision complex floating-point constant and adds the result to a double-
7971
precision complex floating-point vector using alternative indexing
@@ -88,55 +80,46 @@
8880
N: integer
8981
Number of indexed elements.
9082

91-
za: Complex128
83+
alpha: Complex128
9284
Scalar constant.
9385

94-
zx: Complex128Array
86+
x: Complex128Array
9587
First input array.
9688

9789
strideX: integer
98-
Index increment for `zx`.
90+
Stride length for `x`.
9991

10092
offsetX: integer
101-
Starting index for `zx`.
93+
Starting index for `x`.
10294

103-
zy: Complex128Array
95+
y: Complex128Array
10496
Second input array.
10597

10698
strideY: integer
107-
Index increment for `zy`.
99+
Stride length for `y`.
108100

109101
offsetY: integer
110-
Starting index for `zy`.
102+
Starting index for `y`.
111103

112104
Returns
113105
-------
114-
zy: Complex128Array
106+
y: Complex128Array
115107
Second input array.
116108

117109
Examples
118110
--------
119111
// Standard usage:
120-
> var zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
121-
> var zy = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0 ] );
122-
> var za = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 );
123-
> {{alias}}.ndarray( zx.length, za, zx, 1, 0, zy, 1, 0 );
124-
> var z = zy.get( 0 );
125-
> var re = {{alias:@stdlib/complex/float64/real}}( z )
126-
-1.0
127-
> var im = {{alias:@stdlib/complex/float64/imag}}( z )
128-
7.0
112+
> var x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0 ] );
113+
> var y = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0 ] );
114+
> var alpha = new {{alias:@stdlib/complex/float64/ctor}}( 2.0, 2.0 );
115+
> {{alias}}.ndarray( x.length, alpha, x, 1, 0, y, 1, 0 )
116+
<Complex128Array>[ -1.0, 7.0, -1.0, 15.0 ]
129117

130118
// Advanced indexing:
131-
> zx = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
132-
> zy = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
133-
> {{alias}}.ndarray( 2, za, zx, 1, 1, zy, 1, 1 );
134-
> z = zy.get( 2 );
135-
> re = {{alias:@stdlib/complex/float64/real}}( z )
136-
-1.0
137-
> im = {{alias:@stdlib/complex/float64/imag}}( z )
138-
23.0
119+
> x = new {{alias:@stdlib/array/complex128}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
120+
> y = new {{alias:@stdlib/array/complex128}}( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
121+
> {{alias}}.ndarray( 2, alpha, x, 1, 1, y, 1, 1 )
122+
<Complex128Array>[ -1.0, 23.0, -1.0, 7.0, 1.0, 1.0 ]
139123

140124
See Also
141125
--------
142-

0 commit comments

Comments
 (0)