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
74 changes: 74 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 @@ -23,12 +23,15 @@
import caxpy = require( '@stdlib/blas/base/ndarray/caxpy' );
import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
import dcopy = require( '@stdlib/blas/base/ndarray/dcopy' );
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 gcopy = require( '@stdlib/blas/base/ndarray/gcopy' );
import gdot = require( '@stdlib/blas/base/ndarray/gdot' );
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
import scopy = require( '@stdlib/blas/base/ndarray/scopy' );
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' );

Expand Down Expand Up @@ -109,6 +112,30 @@ interface Namespace {
*/
daxpy: typeof daxpy;

/**
* Copies values from a one-dimensional double-precision floating-point ndarray `x` into a one-dimensional double-precision floating-point ndarray `y`.
*
* @param arrays - array-like object containing an input ndarray and an output ndarray
* @returns output ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var x = new ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var z = ns.dcopy( [ x, y ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
*
* var bool = ( z === y );
* // returns true
*/
dcopy: typeof dcopy;

/**
* Computes the dot product of two one-dimensional double-precision floating-point ndarrays.
*
Expand Down Expand Up @@ -173,6 +200,29 @@ interface Namespace {
*/
gaxpy: typeof gaxpy;

/**
* Copies values from a one-dimensional ndarray `x` into a one-dimensional ndarray `y`.
*
* @param arrays - array-like object containing an input ndarray and an output ndarray
* @returns output ndarray
*
* @example
* 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 = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var z = ns.gcopy( [ x, y ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
*
* var bool = ( z === y );
* // returns true
*/
gcopy: typeof gcopy;

/**
* Computes the dot product of two one-dimensional ndarrays.
*
Expand Down Expand Up @@ -238,6 +288,30 @@ interface Namespace {
*/
saxpy: typeof saxpy;

/**
* Copies values from a one-dimensional single-precision floating-point ndarray `x` into a one-dimensional single-precision floating-point ndarray `y`.
*
* @param arrays - array-like object containing an input ndarray and an output ndarray
* @returns output ndarray
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var ybuf = new Float32Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var y = new ndarray( 'float32', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var z = ns.scopy( [ x, y ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
*
* var bool = ( z === y );
* // returns true
*/
scopy: typeof scopy;

/**
* Computes the dot product of two one-dimensional single-precision floating-point ndarrays.
*
Expand Down
Loading