Skip to content

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

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

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

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
246 changes: 246 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 @@ -59,7 +59,9 @@ import dcusumkbn2 = require( '@stdlib/blas/ext/base/ndarray/dcusumkbn2' );
import dcusumors = require( '@stdlib/blas/ext/base/ndarray/dcusumors' );
import dcusumpw = require( '@stdlib/blas/ext/base/ndarray/dcusumpw' );
import ddiff = require( '@stdlib/blas/ext/base/ndarray/ddiff' );
import dfill = require( '@stdlib/blas/ext/base/ndarray/dfill' );
import dfillEqual = require( '@stdlib/blas/ext/base/ndarray/dfill-equal' );
import dfillLessThan = require( '@stdlib/blas/ext/base/ndarray/dfill-less-than' );
import dfillNaN = require( '@stdlib/blas/ext/base/ndarray/dfill-nan' );
import dfillNotEqual = require( '@stdlib/blas/ext/base/ndarray/dfill-not-equal' );
import dfirstIndexEqual = require( '@stdlib/blas/ext/base/ndarray/dfirst-index-equal' );
Expand Down Expand Up @@ -120,7 +122,9 @@ import gcusumkbn2 = require( '@stdlib/blas/ext/base/ndarray/gcusumkbn2' );
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 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' );
import gfillNaN = require( '@stdlib/blas/ext/base/ndarray/gfill-nan' );
import gfillNotEqual = require( '@stdlib/blas/ext/base/ndarray/gfill-not-equal' );
Expand Down Expand Up @@ -190,6 +194,7 @@ import scusumkbn = require( '@stdlib/blas/ext/base/ndarray/scusumkbn' );
import scusumkbn2 = require( '@stdlib/blas/ext/base/ndarray/scusumkbn2' );
import scusumors = require( '@stdlib/blas/ext/base/ndarray/scusumors' );
import sdiff = require( '@stdlib/blas/ext/base/ndarray/sdiff' );
import sfill = require( '@stdlib/blas/ext/base/ndarray/sfill' );
import sfillEqual = require( '@stdlib/blas/ext/base/ndarray/sfill-equal' );
import sfillNaN = require( '@stdlib/blas/ext/base/ndarray/sfill-nan' );
import sfillNotEqual = require( '@stdlib/blas/ext/base/ndarray/sfill-not-equal' );
Expand Down Expand Up @@ -225,6 +230,7 @@ import stril2triu = require( '@stdlib/blas/ext/base/ndarray/stril2triu' );
import striu = require( '@stdlib/blas/ext/base/ndarray/striu' );
import striu2tril = require( '@stdlib/blas/ext/base/ndarray/striu2tril' );
import sunitspace = require( '@stdlib/blas/ext/base/ndarray/sunitspace' );
import svander = require( '@stdlib/blas/ext/base/ndarray/svander' );
import swhere = require( '@stdlib/blas/ext/base/ndarray/swhere' );
import swxsa = require( '@stdlib/blas/ext/base/ndarray/swxsa' );
import sxdy = require( '@stdlib/blas/ext/base/ndarray/sxdy' );
Expand Down Expand Up @@ -1480,6 +1486,44 @@ interface Namespace {
*/
ddiff: typeof ddiff;

/**
* Fills a one-dimensional double-precision 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 Float64Vector = require( '@stdlib/ndarray/vector/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float64Vector( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float64'
* });
*
* var start = scalar2ndarray( 0, {
* 'dtype': 'generic'
* });
*
* var end = scalar2ndarray( 2, {
* 'dtype': 'generic'
* });
*
* var out = ns.dfill( [ x, alpha, start, end ] );
* // returns <ndarray>[ 5.0, 5.0, 3.0, -4.0, 5.0, -6.0 ]
*/
dfill: typeof dfill;

/**
* Replaces elements in a one-dimensional double-precision floating-point ndarray equal to a provided search element with a specified scalar constant.
*
Expand Down Expand Up @@ -1525,6 +1569,51 @@ interface Namespace {
*/
dfillEqual: typeof dfillEqual;

/**
* Replaces elements in a one-dimensional double-precision floating-point ndarray less than a provided search element with a specified scalar constant.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the search element.
* - 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).
*
* - When comparing elements, the function uses the less-than operator `<`. As a consequence, `NaN` values are never less than any value, and `-0` and `+0` are considered equal.
*
* @param arrays - array-like object containing ndarrays
* @returns input ndarray
*
* @example
* var Float64Vector = require( '@stdlib/ndarray/vector/float64' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float64Vector( [ 0.0, -2.0, 3.0, 0.0, 4.0, -6.0 ] );
*
* var searchElement = scalar2ndarray( 2.0, {
* 'dtype': 'float64'
* });
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float64'
* });
*
* var start = scalar2ndarray( 0, {
* 'dtype': 'generic'
* });
*
* var end = scalar2ndarray( 2, {
* 'dtype': 'generic'
* });
*
* var out = ns.dfillLessThan( [ x, searchElement, alpha, start, end ] );
* // returns <ndarray>[ 5.0, 5.0, 3.0, 0.0, 4.0, -6.0 ]
*/
dfillLessThan: typeof dfillLessThan;

/**
* Replaces elements in a one-dimensional double-precision floating-point ndarray equal to `NaN` with a specified scalar constant.
*
Expand Down Expand Up @@ -3285,6 +3374,44 @@ interface Namespace {
*/
gdiff: typeof gdiff;

/**
* Fills a one-dimensional 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 vector = require( '@stdlib/ndarray/vector/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = vector( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0 ], 'generic' );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'generic'
* });
*
* var start = scalar2ndarray( 0, {
* 'dtype': 'generic'
* });
*
* var end = scalar2ndarray( 3, {
* 'dtype': 'generic'
* });
*
* var out = ns.gfill( [ x, alpha, start, end ] );
* // returns <ndarray>[ 5.0, 5.0, 5.0, -5.0, 4.0, -1.0 ]
*/
gfill: typeof gfill;

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

/**
* Replaces elements in a one-dimensional ndarray greater than a provided search element with a specified scalar constant.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the search element.
* - 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).
*
* - When comparing elements, the function uses the greater-than operator `>`. As a consequence, `NaN` values are never greater than any value, and `-0` and `+0` are considered equal.
*
* @param arrays - array-like object containing ndarrays
* @returns input ndarray
*
* @example
* var vector = require( '@stdlib/ndarray/vector/ctor' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = vector( [ 0.0, -2.0, 3.0, 0.0, 4.0, -6.0 ], 'generic' );
*
* var searchElement = scalar2ndarray( -3.0, {
* 'dtype': 'generic'
* });
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'generic'
* });
*
* var start = scalar2ndarray( 0, {
* 'dtype': 'generic'
* });
*
* var end = scalar2ndarray( 2, {
* 'dtype': 'generic'
* });
*
* var out = ns.gfillGreaterThan( [ x, searchElement, alpha, start, end ] );
* // returns <ndarray>[ 5.0, 5.0, 3.0, 0.0, 4.0, -6.0 ]
*/
gfillGreaterThan: typeof gfillGreaterThan;

/**
* Replaces elements in a one-dimensional ndarray greater than or equal to a provided search element with a specified scalar constant.
*
Expand Down Expand Up @@ -5413,6 +5585,44 @@ interface Namespace {
*/
sdiff: typeof sdiff;

/**
* Fills a one-dimensional single-precision 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 Float32Vector = require( '@stdlib/ndarray/vector/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float32Vector( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
*
* var alpha = scalar2ndarray( 5.0, {
* 'dtype': 'float32'
* });
*
* var start = scalar2ndarray( 0, {
* 'dtype': 'generic'
* });
*
* var end = scalar2ndarray( 2, {
* 'dtype': 'generic'
* });
*
* var out = ns.sfill( [ x, alpha, start, end ] );
* // returns <ndarray>[ 5.0, 5.0, 3.0, -4.0, 5.0, -6.0 ]
*/
sfill: typeof sfill;

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

/**
* Generates a single-precision floating-point Vandermonde matrix.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a two-dimensional output ndarray.
* - a zero-dimensional ndarray specifying the mode.
*
* @param arrays - array-like object containing ndarrays
* @returns output ndarray
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
* var zeros = require( '@stdlib/ndarray/zeros' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float32Vector( [ 1.0, 2.0, 3.0 ] );
* var out = zeros( [ 3, 3 ], {
* 'dtype': 'float32'
* });
*
* var mode = scalar2ndarray( 1, {
* 'dtype': 'float32'
* });
*
* var v = ns.svander( [ x, out, mode ] );
* // returns <ndarray>[ [ 1.0, 1.0, 1.0 ], [ 1.0, 2.0, 4.0 ], [ 1.0, 3.0, 9.0 ] ]
*
* var bool = ( v === out );
* // returns true
*/
svander: typeof svander;

/**
* Takes elements from one of two one-dimensional single-precision floating-point ndarrays depending on a condition.
*
Expand Down
Loading