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
79 changes: 79 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 @@ -31,6 +31,7 @@ import dcopy = require( '@stdlib/blas/base/ndarray/dcopy' );
import ddot = require( '@stdlib/blas/base/ndarray/ddot' );
import dnrm2 = require( '@stdlib/blas/base/ndarray/dnrm2' );
import dscal = require( '@stdlib/blas/base/ndarray/dscal' );
import dsdot = require( '@stdlib/blas/base/ndarray/dsdot' );
import dswap = require( '@stdlib/blas/base/ndarray/dswap' );
import dznrm2 = require( '@stdlib/blas/base/ndarray/dznrm2' );
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
Expand All @@ -42,9 +43,11 @@ import gscal = require( '@stdlib/blas/base/ndarray/gscal' );
import gswap = require( '@stdlib/blas/base/ndarray/gswap' );
import sasum = require( '@stdlib/blas/base/ndarray/sasum' );
import saxpy = require( '@stdlib/blas/base/ndarray/saxpy' );
import scasum = require( '@stdlib/blas/base/ndarray/scasum' );
import scnrm2 = require( '@stdlib/blas/base/ndarray/scnrm2' );
import scopy = require( '@stdlib/blas/base/ndarray/scopy' );
import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
import sdsdot = require( '@stdlib/blas/base/ndarray/sdsdot' );
import snrm2 = require( '@stdlib/blas/base/ndarray/snrm2' );
import sscal = require( '@stdlib/blas/base/ndarray/sscal' );
import sswap = require( '@stdlib/blas/base/ndarray/sswap' );
Expand Down Expand Up @@ -369,6 +372,30 @@ interface Namespace {
*/
dscal: typeof dscal;

/**
* Computes the dot product of two one-dimensional single-precision floating-point ndarrays with double-precision accumulation.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second one-dimensional input ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns dot product
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
*
* var x = new Float32Vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
* var y = new Float32Vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
*
* var z = ns.dsdot( [ x, y ] );
* // returns -5.0
*/
dsdot: typeof dsdot;

/**
* Interchanges two one-dimensional double-precision floating-point ndarrays.
*
Expand Down Expand Up @@ -661,6 +688,28 @@ interface Namespace {
*/
saxpy: typeof saxpy;

/**
* Computes the sum of absolute values for all elements in a one-dimensional single-precision complex floating-point ndarray.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
*
* @param arrays - array-like object containing ndarrays
* @returns sum
*
* @example
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
*
* var x = new Complex64Vector( [ 1.0, -2.0, 3.0, -4.0 ] );
*
* var y = ns.scasum( [ x ] );
* // returns 10.0
*/
scasum: typeof scasum;

/**
* Computes the L2-norm of a one-dimensional single-precision complex floating-point ndarray.
*
Expand Down Expand Up @@ -734,6 +783,36 @@ interface Namespace {
*/
sdot: typeof sdot;

/**
* Computes the dot product of two one-dimensional single-precision floating-point ndarrays with extended accumulation.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - first one-dimensional input ndarray.
* - second one-dimensional input ndarray.
* - a zero-dimensional ndarray containing a scalar constant.
*
* @param arrays - array-like object containing ndarrays
* @returns dot product
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float32Vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
* var y = new Float32Vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
*
* var scalar = scalar2ndarray( 10.0, {
* 'dtype': 'float32'
* });
*
* var z = ns.sdsdot( [ x, y, scalar ] );
* // returns 5.0
*/
sdsdot: typeof sdsdot;

/**
* Computes the L2-norm of a one-dimensional single-precision floating-point ndarray.
*
Expand Down