Skip to content

Commit aba7460

Browse files
authored
feat: update blas/base/ndarray TypeScript declarations
PR-URL: #11560 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 4ed570d commit aba7460

File tree

1 file changed

+58
-0
lines changed
  • lib/node_modules/@stdlib/blas/base/ndarray/docs/types

1 file changed

+58
-0
lines changed

lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
/* eslint-disable max-lines */
2222

23+
import caxpy = require( '@stdlib/blas/base/ndarray/caxpy' );
2324
import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
2425
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
2526
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
@@ -29,11 +30,40 @@ import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
2930
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
3031
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
3132
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
33+
import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' );
3234

3335
/**
3436
* Interface describing the `ndarray` namespace.
3537
*/
3638
interface Namespace {
39+
/**
40+
* 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' );
58+
*
59+
* var z = ns.caxpy( [ x, y, alpha ] );
60+
* // returns <ndarray>[ <Complex64>[ -2.0, 5.0 ], <Complex64>[ -4.0, 11.0 ], <Complex64>[ -6.0, 17.0 ], <Complex64>[ -8.0, 23.0 ], <Complex64>[ -10.0, 29.0 ] ]
61+
*
62+
* var bool = ( z === y );
63+
* // returns true
64+
*/
65+
caxpy: typeof caxpy;
66+
3767
/**
3868
* Computes the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray.
3969
*
@@ -228,6 +258,34 @@ interface Namespace {
228258
* // returns -5.0
229259
*/
230260
sdot: typeof sdot;
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' );
281+
*
282+
* var z = ns.zaxpy( [ x, y, alpha ] );
283+
* // returns <ndarray>[ <Complex128>[ -2.0, 5.0 ], <Complex128>[ -4.0, 11.0 ], <Complex128>[ -6.0, 17.0 ], <Complex128>[ -8.0, 23.0 ], <Complex128>[ -10.0, 29.0 ] ]
284+
*
285+
* var bool = ( z === y );
286+
* // returns true
287+
*/
288+
zaxpy: typeof zaxpy;
231289
}
232290

233291
/**

0 commit comments

Comments
 (0)