Skip to content

feat: update blas/ext/base/ndarray TypeScript declarations #11305

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 5, 2026
+38 −0
Merged

feat: update blas/ext/base/ndarray TypeScript declarations #11305

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
38 changes: 38 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/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 csum = require( '@stdlib/blas/ext/base/ndarray/csum' );
import csumkbn = require( '@stdlib/blas/ext/base/ndarray/csumkbn' );
import czeroTo = require( '@stdlib/blas/ext/base/ndarray/czero-to' );
import dcircshift = require( '@stdlib/blas/ext/base/ndarray/dcircshift' );
import dcusum = require( '@stdlib/blas/ext/base/ndarray/dcusum' );
import dcusumkbn = require( '@stdlib/blas/ext/base/ndarray/dcusumkbn' );
Expand Down Expand Up @@ -93,6 +94,7 @@ import ssumpw = require( '@stdlib/blas/ext/base/ndarray/ssumpw' );
import szeroTo = require( '@stdlib/blas/ext/base/ndarray/szero-to' );
import zsum = require( '@stdlib/blas/ext/base/ndarray/zsum' );
import zsumkbn = require( '@stdlib/blas/ext/base/ndarray/zsumkbn' );
import zzeroTo = require( '@stdlib/blas/ext/base/ndarray/zzero-to' );

/**
* Interface describing the `ndarray` namespace.
Expand Down Expand Up @@ -134,6 +136,24 @@ interface Namespace {
*/
csumkbn: typeof csumkbn;

/**
* Fills a one-dimensional single-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from zero.
*
* @param arrays - array-like object containing a one-dimensional input ndarray
* @returns input ndarray
*
* @example
* var Complex64Array = require( '@stdlib/array/complex64' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var x = new ndarray( 'complex64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var out = ns.czeroTo( [ x ] );
* // returns <ndarray>[ <Complex64>[ 0.0, 0.0 ], <Complex64>[ 1.0, 0.0 ], <Complex64>[ 2.0, 0.0 ], <Complex64>[ 3.0, 0.0 ] ]
*/
czeroTo: typeof czeroTo;

/**
* Circularly shifts the elements of a one-dimensional double-precision floating-point ndarray by a specified number of positions.
*
Expand Down Expand Up @@ -1803,6 +1823,24 @@ interface Namespace {
* // returns <Complex128>[ 5.0, 5.0 ]
*/
zsumkbn: typeof zsumkbn;

/**
* Fills a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from zero.
*
* @param arrays - array-like object containing a one-dimensional input ndarray
* @returns input ndarray
*
* @example
* var Complex128Array = require( '@stdlib/array/complex128' );
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
*
* var xbuf = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ] );
* var x = new ndarray( 'complex128', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var out = ns.zzeroTo( [ x ] );
* // returns <ndarray>[ <Complex128>[ 0.0, 0.0 ], <Complex128>[ 1.0, 0.0 ], <Complex128>[ 2.0, 0.0 ], <Complex128>[ 3.0, 0.0 ] ]
*/
zzeroTo: typeof zzeroTo;
}

/**
Expand Down