Skip to content

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

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
May 4, 2026
+58 −0
Merged

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

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
58 changes: 58 additions & 0 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 @@ -22,6 +22,7 @@

import caxpy = require( '@stdlib/blas/base/ndarray/caxpy' );
import ccopy = require( '@stdlib/blas/base/ndarray/ccopy' );
import cswap = require( '@stdlib/blas/base/ndarray/cswap' );
import dasum = require( '@stdlib/blas/base/ndarray/dasum' );
import daxpy = require( '@stdlib/blas/base/ndarray/daxpy' );
import dcopy = require( '@stdlib/blas/base/ndarray/dcopy' );
Expand All @@ -39,6 +40,7 @@ import sdot = require( '@stdlib/blas/base/ndarray/sdot' );
import sswap = require( '@stdlib/blas/base/ndarray/sswap' );
import zaxpy = require( '@stdlib/blas/base/ndarray/zaxpy' );
import zcopy = require( '@stdlib/blas/base/ndarray/zcopy' );
import zswap = require( '@stdlib/blas/base/ndarray/zswap' );

/**
* Interface describing the `ndarray` namespace.
Expand Down Expand Up @@ -105,6 +107,34 @@ interface Namespace {
*/
ccopy: typeof ccopy;

/**
* Interchanges two one-dimensional complex single-precision floating-point ndarrays.
*
* ## 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 second input ndarray
*
* @example
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
*
* var x = new Complex64Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex64Vector( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
*
* var z = ns.cswap( [ x, y ] );
* // x => <ndarray>[ <Complex64>[ 7.0, 8.0 ], <Complex64>[ 9.0, 10.0 ], <Complex64>[ 11.0, 12.0 ] ]
* // y => <ndarray>[ <Complex64>[ 1.0, 2.0 ], <Complex64>[ 3.0, 4.0 ], <Complex64>[ 5.0, 6.0 ] ]
*
* var bool = ( z === y );
* // returns true
*/
cswap: typeof cswap;

/**
* Computes the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray.
*
Expand Down Expand Up @@ -567,6 +597,34 @@ interface Namespace {
* // returns true
*/
zcopy: typeof zcopy;

/**
* Interchanges two one-dimensional complex double-precision floating-point ndarrays.
*
* ## 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 second input ndarray
*
* @example
* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
*
* var x = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
* var y = new Complex128Vector( [ 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] );
*
* var z = ns.zswap( [ x, y ] );
* // x => <ndarray>[ <Complex128>[ 7.0, 8.0 ], <Complex128>[ 9.0, 10.0 ], <Complex128>[ 11.0, 12.0 ] ]
* // y => <ndarray>[ <Complex128>[ 1.0, 2.0 ], <Complex128>[ 3.0, 4.0 ], <Complex128>[ 5.0, 6.0 ] ]
*
* var bool = ( z === y );
* // returns true
*/
zswap: typeof zswap;
}

/**
Expand Down