Skip to content

Commit 0e444aa

Browse files
committed
feat: update blas/base/ndarray TypeScript declarations
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 4f9ef0a commit 0e444aa

File tree

1 file changed

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

1 file changed

+27
-0
lines changed

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
2424
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
2525
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
2626
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
27+
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
2728
import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
2829
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
2930
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
@@ -116,6 +117,32 @@ interface Namespace {
116117
*/
117118
gasum: typeof gasum;
118119

120+
/**
121+
* Multiplies a one-dimensional ndarray `x` by a constant `alpha` and adds the result to a one-dimensional ndarray `y`.
122+
*
123+
* @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant
124+
* @returns output ndarray
125+
*
126+
* @example
127+
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
128+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
129+
*
130+
* var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
131+
* var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
132+
*
133+
* var ybuf = [ 1.0, 1.0, 1.0, 1.0, 1.0 ];
134+
* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
135+
*
136+
* var alpha = scalar2ndarray( 5.0, 'generic', 'row-major' );
137+
*
138+
* var z = ns.gaxpy( [ x, y, alpha ] );
139+
* // returns <ndarray>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
140+
*
141+
* var bool = ( z === y );
142+
* // returns true
143+
*/
144+
gaxpy: typeof gaxpy;
145+
119146
/**
120147
* Computes the dot product of two one-dimensional ndarrays.
121148
*

0 commit comments

Comments
 (0)