Skip to content

Commit 9530a86

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

1 file changed

Lines changed: 65 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/blas/base/ndarray/docs/types

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

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
import caxpy = require( '@stdlib/blas/base/ndarray/caxpy' );
2424
import ccopy = require( '@stdlib/blas/base/ndarray/ccopy' );
25+
import cscal = require( '@stdlib/blas/base/ndarray/cscal' );
2526
import cswap = require( '@stdlib/blas/base/ndarray/cswap' );
2627
import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
2728
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
@@ -33,6 +34,7 @@ import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
3334
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
3435
import gcopy = require( '@stdlib/blas/base/ndarray/gcopy' );
3536
import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
37+
import gscal = require( '@stdlib/blas/base/ndarray/gscal' );
3638
import gswap = require( '@stdlib/blas/base/ndarray/gswap' );
3739
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
3840
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
@@ -109,6 +111,38 @@ interface Namespace {
109111
*/
110112
ccopy: typeof ccopy;
111113

114+
/**
115+
* Multiplies a one-dimensional single-precision complex floating-point ndarray by a scalar constant.
116+
*
117+
* ## Notes
118+
*
119+
* - The function expects the following ndarrays:
120+
*
121+
* - a one-dimensional input ndarray.
122+
* - a zero-dimensional ndarray containing a scalar constant.
123+
*
124+
* @param arrays - array-like object containing ndarrays
125+
* @returns input ndarray
126+
*
127+
* @example
128+
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
129+
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
130+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
131+
*
132+
* var x = new Complex64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
133+
*
134+
* var alpha = scalar2ndarray( new Complex64( 2.0, 0.0 ), {
135+
* 'dtype': 'complex64'
136+
* });
137+
*
138+
* var y = ns.cscal( [ x, alpha ] );
139+
* // returns <ndarray>[ <Complex64>[ 2.0, 4.0 ], <Complex64>[ 6.0, 8.0 ], <Complex64>[ 10.0, 12.0 ] ]
140+
*
141+
* var bool = ( y === x );
142+
* // returns true
143+
*/
144+
cscal: typeof cscal;
145+
112146
/**
113147
* Interchanges two one-dimensional single-precision complex floating-point ndarrays.
114148
*
@@ -408,6 +442,37 @@ interface Namespace {
408442
*/
409443
gdot: typeof gdot;
410444

445+
/**
446+
* Multiplies a one-dimensional ndarray by a scalar constant.
447+
*
448+
* ## Notes
449+
*
450+
* - The function expects the following ndarrays:
451+
*
452+
* - a one-dimensional input ndarray.
453+
* - a zero-dimensional ndarray containing a scalar constant.
454+
*
455+
* @param arrays - array-like object containing ndarrays
456+
* @returns input ndarray
457+
*
458+
* @example
459+
* var vector = require( '@stdlib/ndarray/vector/ctor' );
460+
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
461+
*
462+
* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' );
463+
*
464+
* var alpha = scalar2ndarray( 5.0, {
465+
* 'dtype': 'generic'
466+
* });
467+
*
468+
* var y = ns.gscal( [ x, alpha ] );
469+
* // returns <ndarray>[ 5.0, 10.0, 15.0, 20.0, 25.0 ]
470+
*
471+
* var bool = ( y === x );
472+
* // returns true
473+
*/
474+
gscal: typeof gscal;
475+
411476
/**
412477
* Interchanges two one-dimensional ndarrays.
413478
*

0 commit comments

Comments
 (0)