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/ndarray/README.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,6 +45,7 @@ The namespace exposes the following APIs:
45
45
46
46
<divclass="namespace-toc">
47
47
48
+
- <spanclass="signature">[`caxpy( arrays )`][@stdlib/blas/base/ndarray/caxpy]</span><spanclass="delimiter">: </span><spanclass="description">multiply a one-dimensional single-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision complex floating-point ndarray `y`.</span>
48
49
- <spanclass="signature">[`dasum( arrays )`][@stdlib/blas/base/ndarray/dasum]</span><spanclass="delimiter">: </span><spanclass="description">calculate the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray.</span>
49
50
- <spanclass="signature">[`daxpy( arrays )`][@stdlib/blas/base/ndarray/daxpy]</span><spanclass="delimiter">: </span><spanclass="description">multiply a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision floating-point ndarray `y`.</span>
50
51
- <spanclass="signature">[`ddot( arrays )`][@stdlib/blas/base/ndarray/ddot]</span><spanclass="delimiter">: </span><spanclass="description">calculate the dot product of two one-dimensional double-precision floating-point ndarrays.</span>
@@ -54,6 +55,7 @@ The namespace exposes the following APIs:
54
55
- <spanclass="signature">[`sasum( arrays )`][@stdlib/blas/base/ndarray/sasum]</span><spanclass="delimiter">: </span><spanclass="description">calculate the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray.</span>
55
56
- <spanclass="signature">[`saxpy( arrays )`][@stdlib/blas/base/ndarray/saxpy]</span><spanclass="delimiter">: </span><spanclass="description">multiply a one-dimensional single-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision floating-point ndarray `y`.</span>
56
57
- <spanclass="signature">[`sdot( arrays )`][@stdlib/blas/base/ndarray/sdot]</span><spanclass="delimiter">: </span><spanclass="description">calculate the dot product of two one-dimensional single-precision floating-point ndarrays.</span>
58
+
- <spanclass="signature">[`zaxpy( arrays )`][@stdlib/blas/base/ndarray/zaxpy]</span><spanclass="delimiter">: </span><spanclass="description">multiply a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision complex floating-point ndarray `y`.</span>
* Multiplies a one-dimensional single-precision complex floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional single-precision complex floating-point ndarray `y`.
41
+
*
42
+
* @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant
43
+
* @returns output ndarray
44
+
*
45
+
* @example
46
+
* var Complex64Array = require( '@stdlib/array/complex64' );
47
+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
48
+
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
49
+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
50
+
*
51
+
* var xbuf = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
52
+
* var x = new ndarray( 'complex64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
53
+
*
54
+
* var ybuf = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
55
+
* var y = new ndarray( 'complex64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
56
+
*
57
+
* var alpha = scalar2ndarray( new Complex64( 1.0, 2.0 ), 'complex64', 'row-major' );
* Computes the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray.
39
69
*
@@ -228,6 +258,34 @@ interface Namespace {
228
258
* // returns -5.0
229
259
*/
230
260
sdot: typeofsdot;
261
+
262
+
/**
263
+
* Multiplies a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and adds the result to a one-dimensional double-precision complex floating-point ndarray `y`.
264
+
*
265
+
* @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant
266
+
* @returns output ndarray
267
+
*
268
+
* @example
269
+
* var Complex128Array = require( '@stdlib/array/complex128' );
270
+
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
271
+
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
272
+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
273
+
*
274
+
* var xbuf = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
275
+
* var x = new ndarray( 'complex128', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
276
+
*
277
+
* var ybuf = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
278
+
* var y = new ndarray( 'complex128', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
279
+
*
280
+
* var alpha = scalar2ndarray( new Complex128( 1.0, 2.0 ), 'complex128', 'row-major' );
0 commit comments