Skip to content

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

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 21, 2026
Merged

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

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
50 changes: 50 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 @@ -21,6 +21,7 @@
/* eslint-disable max-lines */

import caxpy = require( '@stdlib/blas/base/ndarray/caxpy' );
import ccopy = require( '@stdlib/blas/base/ndarray/ccopy' );
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 @@ -34,6 +35,7 @@ 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' );
import zcopy = require( '@stdlib/blas/base/ndarray/zcopy' );

/**
* Interface describing the `ndarray` namespace.
Expand Down Expand Up @@ -67,6 +69,30 @@ interface Namespace {
*/
caxpy: typeof caxpy;

/**
* Copies values from a one-dimensional single-precision complex floating-point ndarray `x` into a one-dimensional single-precision complex floating-point ndarray `y`.
*
* @param arrays - array-like object containing an input ndarray and an output ndarray
* @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 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 z = ns.ccopy( [ x, y ] );
* // returns <ndarray>[ <Complex64>[ 1.0, 2.0 ], <Complex64>[ 3.0, 4.0 ], <Complex64>[ 5.0, 6.0 ] ]
*
* var bool = ( z === y );
* // returns true
*/
ccopy: typeof ccopy;

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

/**
* Copies values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`.
*
* @param arrays - array-like object containing an input ndarray and an output ndarray
* @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 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 z = ns.zcopy( [ x, y ] );
* // returns <ndarray>[ <Complex128>[ 1.0, 2.0 ], <Complex128>[ 3.0, 4.0 ], <Complex128>[ 5.0, 6.0 ] ]
*
* var bool = ( z === y );
* // returns true
*/
zcopy: typeof zcopy;
}

/**
Expand Down