Skip to content

feat: update blas/base/ndarray TypeScript declarations #11752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Apr 24, 2026
Merged

feat: update blas/base/ndarray TypeScript declarations #11752

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
196 changes: 89 additions & 107 deletions lib/node_modules/@stdlib/blas/base/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ 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 dswap = require( '@stdlib/blas/base/ndarray/dswap' );
import gasum = require( '@stdlib/blas/base/ndarray/gasum' );
import gaxpy = require( '@stdlib/blas/base/ndarray/gaxpy' );
import gcopy = require( '@stdlib/blas/base/ndarray/gcopy' );
Expand All @@ -48,18 +49,16 @@ interface Namespace {
* @returns output ndarray
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
* var x = new ndarray( 'complex64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var ybuf = new Complex64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
* var y = new ndarray( 'complex64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
* var x = new Complex64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
* var y = new Complex64Vector( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
*
* var alpha = scalar2ndarray( new Complex64( 1.0, 2.0 ), 'complex64', 'row-major' );
* var alpha = scalar2ndarray( new Complex64( 1.0, 2.0 ), {
* 'dtype': 'complex64'
* });
*
* var z = ns.caxpy( [ x, y, alpha ] );
* // returns <ndarray>[ <Complex64>[ -2.0, 5.0 ], <Complex64>[ -4.0, 11.0 ], <Complex64>[ -6.0, 17.0 ], <Complex64>[ -8.0, 23.0 ], <Complex64>[ -10.0, 29.0 ] ]
Expand All @@ -76,14 +75,10 @@ interface Namespace {
* @returns output ndarray
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var x = new ndarray( 'complex64', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
*
* var ybuf = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var y = new ndarray( 'complex64', ybuf, [ 3 ], [ 1 ], 0, 'row-major' );
* var x = new Complex64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex64Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* var z = ns.ccopy( [ x, y ] );
* // returns <ndarray>[ <Complex64>[ 1.0, 2.0 ], <Complex64>[ 3.0, 4.0 ], <Complex64>[ 5.0, 6.0 ] ]
Expand All @@ -100,11 +95,9 @@ interface Namespace {
* @returns sum
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
*
* 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 x = new Float64Vector( [ 1.0, -2.0, 3.0, -4.0, 5.0 ] );
*
* var y = ns.dasum( [ x ] );
* // returns 15.0
Expand All @@ -118,17 +111,15 @@ interface Namespace {
* @returns output ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* 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 x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Vector( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );
*
* var ybuf = new Float64Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );
* var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var alpha = scalar2ndarray( 5.0, 'float64', 'row-major' );
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float64'
* });
*
* var z = ns.daxpy( [ x, y, alpha ] );
* // returns <ndarray>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
Expand All @@ -145,14 +136,10 @@ interface Namespace {
* @returns output ndarray
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
*
* 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 x = new Float64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float64Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* var z = ns.dcopy( [ x, y ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
Expand All @@ -169,19 +156,40 @@ interface Namespace {
* @returns dot product
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
*
* var x = new Float64Vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
* var y = new Float64Vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
*
* var z = ns.ddot( [ x, y ] );
* // returns -5.0
*/
ddot: typeof ddot;

/**
* Interchanges two one-dimensional double-precision floating-point ndarrays.
*
* @param arrays - array-like object containing two input ndarrays
* @returns second input ndarray
*
* @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 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( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
* var ybuf = new Float64Array( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] );
* var y = new ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var z = ns.ddot( [ x, y ] );
* // returns -5.0
* var z = ns.dswap( [ x, y ] );
* // x => <ndarray>[ 6.0, 7.0, 8.0, 9.0, 10.0 ]
* // y => <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
*
* var bool = ( z === y );
* // returns true
*/
ddot: typeof ddot;
dswap: typeof dswap;

/**
* Computes the sum of absolute values for all elements in a one-dimensional ndarray.
Expand All @@ -190,10 +198,9 @@ interface Namespace {
* @returns sum
*
* @example
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var vector = require( '@stdlib/ndarray/vector/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 x = vector( [ 1.0, -2.0, 3.0, -4.0, 5.0 ], 'generic' );
*
* var y = ns.gasum( [ x ] );
* // returns 15.0
Expand All @@ -207,16 +214,15 @@ interface Namespace {
* @returns output ndarray
*
* @example
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var vector = require( '@stdlib/ndarray/vector/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var xbuf = [ 1.0, 2.0, 3.0, 4.0, 5.0 ];
* var x = new ndarray( 'generic', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' );
* var y = vector( [ 1.0, 1.0, 1.0, 1.0, 1.0 ], 'generic' );
*
* 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 alpha = scalar2ndarray( 5.0, {
* 'dtype': 'generic'
* });
*
* var z = ns.gaxpy( [ x, y, alpha ] );
* // returns <ndarray>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
Expand All @@ -233,13 +239,10 @@ interface Namespace {
* @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 vector = require( '@stdlib/ndarray/vector/ctor' );
*
* var ybuf = [ 0.0, 0.0, 0.0, 0.0, 0.0 ];
* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
* var x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' );
* var y = vector( [ 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' );
*
* var z = ns.gcopy( [ x, y ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
Expand All @@ -256,13 +259,10 @@ interface Namespace {
* @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 vector = require( '@stdlib/ndarray/vector/ctor' );
*
* var ybuf = [ 2.0, 6.0, -1.0, -4.0, 8.0 ];
* var y = new ndarray( 'generic', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
* var x = vector( [ 4.0, 2.0, -3.0, 5.0, -1.0 ], 'generic' );
* var y = vector( [ 2.0, 6.0, -1.0, -4.0, 8.0 ], 'generic' );
*
* var z = ns.gdot( [ x, y ] );
* // returns -5.0
Expand All @@ -276,11 +276,9 @@ interface Namespace {
* @returns sum
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
*
* 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 x = new Float32Vector( [ 1.0, -2.0, 3.0, -4.0, 5.0 ] );
*
* var y = ns.sasum( [ x ] );
* // returns 15.0
Expand All @@ -294,17 +292,15 @@ interface Namespace {
* @returns output ndarray
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* 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 x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float32Vector( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );
*
* var ybuf = new Float32Array( [ 1.0, 1.0, 1.0, 1.0, 1.0 ] );
* var y = new ndarray( 'float32', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var alpha = scalar2ndarray( 5.0, 'float32', 'row-major' );
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float32'
* });
*
* var z = ns.saxpy( [ x, y, alpha ] );
* // returns <ndarray>[ 6.0, 11.0, 16.0, 21.0, 26.0 ]
Expand All @@ -321,14 +317,10 @@ interface Namespace {
* @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 Float32Vector = require( '@stdlib/ndarray/vector/float32' );
*
* 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 x = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
* var y = new Float32Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* var z = ns.scopy( [ x, y ] );
* // returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
Expand All @@ -345,14 +337,10 @@ interface Namespace {
* @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 Float32Vector = require( '@stdlib/ndarray/vector/float32' );
*
* 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 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.sdot( [ x, y ] );
* // returns -5.0
Expand All @@ -366,18 +354,16 @@ interface Namespace {
* @returns output ndarray
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/base/from-scalar' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var xbuf = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
* var x = new ndarray( 'complex128', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
* var x = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
* var y = new Complex128Vector( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
*
* var ybuf = new Complex128Array( [ 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0 ] );
* var y = new ndarray( 'complex128', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
*
* var alpha = scalar2ndarray( new Complex128( 1.0, 2.0 ), 'complex128', 'row-major' );
* var alpha = scalar2ndarray( new Complex128( 1.0, 2.0 ), {
* 'dtype': 'complex128'
* });
*
* var z = ns.zaxpy( [ x, y, alpha ] );
* // returns <ndarray>[ <Complex128>[ -2.0, 5.0 ], <Complex128>[ -4.0, 11.0 ], <Complex128>[ -6.0, 17.0 ], <Complex128>[ -8.0, 23.0 ], <Complex128>[ -10.0, 29.0 ] ]
Expand All @@ -394,14 +380,10 @@ interface Namespace {
* @returns output ndarray
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var x = new ndarray( 'complex128', xbuf, [ 3 ], [ 1 ], 0, 'row-major' );
* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
*
* var ybuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var y = new ndarray( 'complex128', ybuf, [ 3 ], [ 1 ], 0, 'row-major' );
* var x = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex128Vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
*
* var z = ns.zcopy( [ x, y ] );
* // returns <ndarray>[ <Complex128>[ 1.0, 2.0 ], <Complex128>[ 3.0, 4.0 ], <Complex128>[ 5.0, 6.0 ] ]
Expand Down