Skip to content

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

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
Sep 27, 2026
Merged

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

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
120 changes: 120 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 @@ -24,6 +24,7 @@ import caxpb = require( '@stdlib/blas/ext/base/ndarray/caxpb' );
import caxpby = require( '@stdlib/blas/ext/base/ndarray/caxpby' );
import ccopyWithin = require( '@stdlib/blas/ext/base/ndarray/ccopy-within' );
import cdiff = require( '@stdlib/blas/ext/base/ndarray/cdiff' );
import cfill = require( '@stdlib/blas/ext/base/ndarray/cfill' );
import cfillEqual = require( '@stdlib/blas/ext/base/ndarray/cfill-equal' );
import cindexOf = require( '@stdlib/blas/ext/base/ndarray/cindex-of' );
import cindexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/cindex-of-falsy' );
Expand Down Expand Up @@ -123,6 +124,7 @@ import gcusumors = require( '@stdlib/blas/ext/base/ndarray/gcusumors' );
import gcusumpw = require( '@stdlib/blas/ext/base/ndarray/gcusumpw' );
import gdiff = require( '@stdlib/blas/ext/base/ndarray/gdiff' );
import gfill = require( '@stdlib/blas/ext/base/ndarray/gfill' );
import gfillBy = require( '@stdlib/blas/ext/base/ndarray/gfill-by' );
import gfillEqual = require( '@stdlib/blas/ext/base/ndarray/gfill-equal' );
import gfillGreaterThan = require( '@stdlib/blas/ext/base/ndarray/gfill-greater-than' );
import gfillGreaterThanEqual = require( '@stdlib/blas/ext/base/ndarray/gfill-greater-than-equal' );
Expand Down Expand Up @@ -243,6 +245,7 @@ import zaxpb = require( '@stdlib/blas/ext/base/ndarray/zaxpb' );
import zaxpby = require( '@stdlib/blas/ext/base/ndarray/zaxpby' );
import zcopyWithin = require( '@stdlib/blas/ext/base/ndarray/zcopy-within' );
import zdiff = require( '@stdlib/blas/ext/base/ndarray/zdiff' );
import zfill = require( '@stdlib/blas/ext/base/ndarray/zfill' );
import zindexOf = require( '@stdlib/blas/ext/base/ndarray/zindex-of' );
import zindexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/zindex-of-falsy' );
import zindexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/zindex-of-truthy' );
Expand Down Expand Up @@ -414,6 +417,45 @@ interface Namespace {
*/
cdiff: typeof cdiff;

/**
* Fills a one-dimensional single-precision complex floating-point ndarray with a specified scalar constant.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the scalar constant.
* - a zero-dimensional ndarray containing the starting index (inclusive).
* - a zero-dimensional ndarray containing the ending index (exclusive).
*
* @param arrays - array-like object containing ndarrays
* @returns input ndarray
*
* @example
* var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var Complex64 = require( '@stdlib/complex/float32/ctor' );
*
* var x = new Complex64Vector( [ 1.0, 2.0, -2.0, 3.0, 4.0, -6.0, 5.0, 7.0 ] );
*
* var alpha = scalar2ndarray( new Complex64( 5.0, 5.0 ), {
* 'dtype': 'complex64'
* });
*
* var start = scalar2ndarray( 0, {
* 'dtype': 'generic'
* });
*
* var end = scalar2ndarray( 2, {
* 'dtype': 'generic'
* });
*
* var out = ns.cfill( [ x, alpha, start, end ] );
* // returns <ndarray>[ <Complex64>[ 5.0, 5.0 ], <Complex64>[ 5.0, 5.0 ], <Complex64>[ 4.0, -6.0 ], <Complex64>[ 5.0, 7.0 ] ]
*/
cfill: typeof cfill;

/**
* Replaces elements in a one-dimensional single-precision complex floating-point ndarray equal to a provided search element with a specified scalar constant.
*
Expand Down Expand Up @@ -3412,6 +3454,45 @@ interface Namespace {
*/
gfill: typeof gfill;

/**
* Fills a one-dimensional ndarray according to a provided callback function.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the starting index (inclusive).
* - a zero-dimensional ndarray containing the ending index (exclusive).
*
* @param arrays - array-like object containing ndarrays
* @param clbk - callback function
* @param thisArg - callback execution context
* @returns input ndarray
*
* @example
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var vector = require( '@stdlib/ndarray/vector/ctor' );
*
* function fill() {
* return 5.0;
* }
*
* var x = vector( [ -2.0, 1.0, 3.0, -5.0, 4.0, -6.0 ], 'generic' );
*
* var start = scalar2ndarray( 0, {
* 'dtype': 'generic'
* });
*
* var end = scalar2ndarray( 3, {
* 'dtype': 'generic'
* });
*
* var out = ns.gfillBy( [ x, start, end ], fill );
* // returns <ndarray>[ 5.0, 5.0, 5.0, -5.0, 4.0, -6.0 ]
*/
gfillBy: typeof gfillBy;

/**
* Replaces elements in a one-dimensional ndarray equal to a provided search element with a specified scalar constant.
*
Expand Down Expand Up @@ -7050,6 +7131,45 @@ interface Namespace {
*/
zdiff: typeof zdiff;

/**
* Fills a one-dimensional double-precision complex floating-point ndarray with a specified scalar constant.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the scalar constant.
* - a zero-dimensional ndarray containing the starting index (inclusive).
* - a zero-dimensional ndarray containing the ending index (exclusive).
*
* @param arrays - array-like object containing ndarrays
* @returns input ndarray
*
* @example
* var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
* var Complex128 = require( '@stdlib/complex/float64/ctor' );
*
* var x = new Complex128Vector( [ 1.0, 2.0, -2.0, 3.0, 4.0, -6.0, 5.0, 7.0 ] );
*
* var alpha = scalar2ndarray( new Complex128( 5.0, 5.0 ), {
* 'dtype': 'complex128'
* });
*
* var start = scalar2ndarray( 0, {
* 'dtype': 'generic'
* });
*
* var end = scalar2ndarray( 2, {
* 'dtype': 'generic'
* });
*
* var out = ns.zfill( [ x, alpha, start, end ] );
* // returns <ndarray>[ <Complex128>[ 5.0, 5.0 ], <Complex128>[ 5.0, 5.0 ], <Complex128>[ 4.0, -6.0 ], <Complex128>[ 5.0, 7.0 ] ]
*/
zfill: typeof zfill;

/**
* Returns the first index of a search element in a one-dimensional double-precision complex floating-point ndarray.
*
Expand Down
Loading