Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
Expand Down Expand Up @@ -116,6 +117,32 @@ interface Namespace {
*/
gasum: typeof gasum;

/**
* Multiplies a one-dimensional ndarray `x` by a constant `alpha` and adds the result to a one-dimensional ndarray `y`.
*
* @param arrays - array-like object containing an input ndarray, an output ndarray, and a zero-dimensional ndarray containing a scalar constant
* @returns output ndarray
*
* @example
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
* var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var ybuf = [ 1.0, 1.0, 1.0, 1.0, 1.0 ];
* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var alpha = scalar2ndarray( 5.0, 'generic', 'row-major' );
*
* var z = ns.gaxpy( [ x, y, alpha ] );
* // returns <ndarray>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
*
* var bool = ( z === y );
* // returns true
*/
gaxpy: typeof gaxpy;

/**
* Computes the dot product of two one-dimensional ndarrays.
*
Expand Down