diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts index 4c289b607f11..3f07f1009fc8 100644 --- a/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts @@ -20,16 +20,113 @@ /* eslint-disable max-lines */ +import dasum = require( '@stdlib/blas/base/ndarray/dasum' ); import ddot = require( '@stdlib/blas/base/ndarray/ddot' ); +import gdot = require( '@stdlib/blas/base/ndarray/gdot' ); +import sasum = require( '@stdlib/blas/base/ndarray/sasum' ); +import sdot = require( '@stdlib/blas/base/ndarray/sdot' ); /** * Interface describing the `ndarray` namespace. */ interface Namespace { /** - * TODO + * Computes the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray. + * + * @param arrays - array-like object containing a one-dimensional input ndarray + * @returns sum + * + * @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 y = ns.dasum( [ x ] ); + * // returns 15.0 + */ + dasum: typeof dasum; + + /** + * Computes the dot product of two one-dimensional double-precision floating-point ndarrays. + * + * @param arrays - array-like object containing two one-dimensional input ndarrays + * @returns dot product + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * var ndarray = require( '@stdlib/ndarray/base/ctor' ); + * + * var xbuf = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + * var x = new ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var ybuf = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + * var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var z = ns.ddot( [ x, y ] ); + * // returns -5.0 */ ddot: typeof ddot; + + /** + * Computes the dot product of two one-dimensional ndarrays. + * + * @param arrays - array-like object containing two one-dimensional input ndarrays + * @returns dot product + * + * @example + * var ndarray = require( '@stdlib/ndarray/base/ctor' ); + * + * var xbuf = [ 4.0, 2.0, -3.0, 5.0, -1.0 ]; + * var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ]; + * var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var z = ns.gdot( [ x, y ] ); + * // returns -5.0 + */ + gdot: typeof gdot; + + /** + * Computes the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray. + * + * @param arrays - array-like object containing a one-dimensional input ndarray + * @returns sum + * + * @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 y = ns.sasum( [ x ] ); + * // returns 15.0 + */ + sasum: typeof sasum; + + /** + * Computes the dot product of two one-dimensional single-precision floating-point ndarrays. + * + * @param arrays - array-like object containing two one-dimensional input ndarrays + * @returns dot product + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * var ndarray = require( '@stdlib/ndarray/base/ctor' ); + * + * var xbuf = new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + * var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var ybuf = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + * var y = new ndarray( 'float32', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); + * + * var z = ns.sdot( [ x, y ] ); + * // returns -5.0 + */ + sdot: typeof sdot; } /**