You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/blas/base/README.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -45,9 +45,9 @@ var o = blas;
45
45
46
46
<divclass="namespace-toc">
47
47
48
-
- <spanclass="signature">[`caxpy( N, ca, cx, strideX, cy, strideY )`][@stdlib/blas/base/caxpy]</span><spanclass="delimiter">: </span><spanclass="description">scale a single-precision complex floating-point vector by a single-precision complex floating-point constant and add the result to a single-precision complex floating-point vector.</span>
48
+
- <spanclass="signature">[`caxpy( N, alpha, x, strideX, y, strideY )`][@stdlib/blas/base/caxpy]</span><spanclass="delimiter">: </span><spanclass="description">scale a single-precision complex floating-point vector by a single-precision complex floating-point constant and add the result to a single-precision complex floating-point vector.</span>
49
49
- <spanclass="signature">[`ccopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/ccopy]</span><spanclass="delimiter">: </span><spanclass="description">copy values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.</span>
50
-
- <spanclass="signature">[`cscal( N, ca, cx, strideX )`][@stdlib/blas/base/cscal]</span><spanclass="delimiter">: </span><spanclass="description">scales a single-precision complex floating-point vector by a single-precision complex floating-point constant.</span>
50
+
- <spanclass="signature">[`cscal( N, alpha, x, strideX )`][@stdlib/blas/base/cscal]</span><spanclass="delimiter">: </span><spanclass="description">scales a single-precision complex floating-point vector by a single-precision complex floating-point constant.</span>
51
51
- <spanclass="signature">[`csrot( N, cx, strideX, cy, strideY, c, s )`][@stdlib/blas/base/csrot]</span><spanclass="delimiter">: </span><spanclass="description">applies a plane rotation.</span>
52
52
- <spanclass="signature">[`cswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/cswap]</span><spanclass="delimiter">: </span><spanclass="description">interchange two complex single-precision floating-point vectors.</span>
53
53
- <spanclass="signature">[`dasum( N, x, stride )`][@stdlib/blas/base/dasum]</span><spanclass="delimiter">: </span><spanclass="description">compute the sum of absolute values (_L1_ norm).</span>
@@ -84,7 +84,7 @@ var o = blas;
84
84
- <spanclass="signature">[`srotm( N, x, strideX, y, strideY, param )`][@stdlib/blas/base/srotm]</span><spanclass="delimiter">: </span><spanclass="description">apply a modified Givens plane rotation.</span>
85
85
- <spanclass="signature">[`sscal( N, alpha, x, stride )`][@stdlib/blas/base/sscal]</span><spanclass="delimiter">: </span><spanclass="description">multiply a single-precision floating-point vector `x` by a constant `alpha`.</span>
86
86
- <spanclass="signature">[`sswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/sswap]</span><spanclass="delimiter">: </span><spanclass="description">interchange two single-precision floating-point vectors.</span>
87
-
- <spanclass="signature">[`zaxpy( N, za, zx, strideX, zy, strideY )`][@stdlib/blas/base/zaxpy]</span><spanclass="delimiter">: </span><spanclass="description">scale a double-precision complex floating-point vector by a double-precision complex floating-point constant and add the result to a double-precision complex floating-point vector.</span>
87
+
- <spanclass="signature">[`zaxpy( N, alpha, x, strideX, y, strideY )`][@stdlib/blas/base/zaxpy]</span><spanclass="delimiter">: </span><spanclass="description">scale a double-precision complex floating-point vector by a double-precision complex floating-point constant and add the result to a double-precision complex floating-point vector.</span>
88
88
- <spanclass="signature">[`zcopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/zcopy]</span><spanclass="delimiter">: </span><spanclass="description">copy values from one complex double-precision floating-point vector to another complex double-precision floating-point vector.</span>
89
89
- <spanclass="signature">[`zdrot( N, zx, strideX, zy, strideY, c, s )`][@stdlib/blas/base/zdrot]</span><spanclass="delimiter">: </span><spanclass="description">applies a plane rotation.</span>
90
90
- <spanclass="signature">[`zdscal( N, da, zx, strideZX )`][@stdlib/blas/base/zdscal]</span><spanclass="delimiter">: </span><spanclass="description">scale a double-precision complex floating-point vector by a double-precision floating-point constant.</span>
-**x**: first input [`Complex64Array`][@stdlib/array/complex64].
54
+
-**strideX**: index increment for `x`.
55
+
-**y**: second input [`Complex64Array`][@stdlib/array/complex64].
56
+
-**strideY**: index increment for `y`.
57
57
58
-
The `N` and stride parameters determine how values from `cx` are scaled by `ca` and added to `cy`. For example, to scale every other value in `cx` by `ca` and add the result to every other value of `cy`,
58
+
The `N` and stride parameters determine how values from `x` are scaled by `alpha` and added to `y`. For example, to scale every other value in `x` by `alpha` and add the result to every other value of `y`,
59
59
60
60
```javascript
61
61
var Complex64Array =require( '@stdlib/array/complex64' );
62
62
var Complex64 =require( '@stdlib/complex/float32/ctor' );
The function has the following additional parameters:
113
113
114
-
-**offsetX**: starting index for `cx`.
115
-
-**offsetY**: starting index for `cy`.
114
+
-**offsetX**: starting index for `x`.
115
+
-**offsetY**: starting index for `y`.
116
116
117
117
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to scale values in the first input strided array starting from the second element and add the result to the second input array starting from the second element,
118
118
119
119
```javascript
120
120
var Complex64Array =require( '@stdlib/array/complex64' );
121
121
var Complex64 =require( '@stdlib/complex/float32/ctor' );
0 commit comments