From 08241ab23d5719b04b964b74465405bbaa2b7a0b Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Mon, 17 Aug 2026 02:33:11 +0000 Subject: [PATCH] feat: update `blas/ext/base/ndarray` TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../ext/base/ndarray/docs/types/index.d.ts | 271 ++++++++++++++++++ 1 file changed, 271 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts index bc990c402bf4..875ad84adc4a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/docs/types/index.d.ts @@ -23,6 +23,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 cfillEqual = require( '@stdlib/blas/ext/base/ndarray/cfill-equal' ); import cindexOf = require( '@stdlib/blas/ext/base/ndarray/cindex-of' ); import cindexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/cindex-of-truthy' ); @@ -44,6 +45,7 @@ import daxpb = require( '@stdlib/blas/ext/base/ndarray/daxpb' ); import daxpby = require( '@stdlib/blas/ext/base/ndarray/daxpby' ); import dcircshift = require( '@stdlib/blas/ext/base/ndarray/dcircshift' ); import dcopyWithin = require( '@stdlib/blas/ext/base/ndarray/dcopy-within' ); +import dcunone = require( '@stdlib/blas/ext/base/ndarray/dcunone' ); import dcusum = require( '@stdlib/blas/ext/base/ndarray/dcusum' ); import dcusumkbn = require( '@stdlib/blas/ext/base/ndarray/dcusumkbn' ); import dcusumkbn2 = require( '@stdlib/blas/ext/base/ndarray/dcusumkbn2' ); @@ -63,6 +65,7 @@ import dindexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/dindex-of-truthy import dlastIndexEqual = require( '@stdlib/blas/ext/base/ndarray/dlast-index-equal' ); import dlastIndexOf = require( '@stdlib/blas/ext/base/ndarray/dlast-index-of' ); import dlastIndexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/dlast-index-of-falsy' ); +import dlastIndexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/dlast-index-of-truthy' ); import dlinspace = require( '@stdlib/blas/ext/base/ndarray/dlinspace' ); import dlogspace = require( '@stdlib/blas/ext/base/ndarray/dlogspace' ); import dnansum = require( '@stdlib/blas/ext/base/ndarray/dnansum' ); @@ -97,11 +100,13 @@ import gaxpb = require( '@stdlib/blas/ext/base/ndarray/gaxpb' ); import gaxpby = require( '@stdlib/blas/ext/base/ndarray/gaxpby' ); import gcircshift = require( '@stdlib/blas/ext/base/ndarray/gcircshift' ); import gcopyWithin = require( '@stdlib/blas/ext/base/ndarray/gcopy-within' ); +import gcunone = require( '@stdlib/blas/ext/base/ndarray/gcunone' ); import gcusum = require( '@stdlib/blas/ext/base/ndarray/gcusum' ); import gcusumkbn = require( '@stdlib/blas/ext/base/ndarray/gcusumkbn' ); 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 gfillEqual = require( '@stdlib/blas/ext/base/ndarray/gfill-equal' ); import gfillNaN = require( '@stdlib/blas/ext/base/ndarray/gfill-nan' ); import gfillNotEqual = require( '@stdlib/blas/ext/base/ndarray/gfill-not-equal' ); @@ -119,6 +124,7 @@ import gjoinBetween = require( '@stdlib/blas/ext/base/ndarray/gjoin-between' ); import glastIndexEqual = require( '@stdlib/blas/ext/base/ndarray/glast-index-equal' ); import glastIndexOf = require( '@stdlib/blas/ext/base/ndarray/glast-index-of' ); import glastIndexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/glast-index-of-falsy' ); +import glastIndexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/glast-index-of-truthy' ); import glinspace = require( '@stdlib/blas/ext/base/ndarray/glinspace' ); import glogspace = require( '@stdlib/blas/ext/base/ndarray/glogspace' ); import gnansum = require( '@stdlib/blas/ext/base/ndarray/gnansum' ); @@ -156,6 +162,7 @@ import scusum = require( '@stdlib/blas/ext/base/ndarray/scusum' ); 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 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' ); @@ -166,6 +173,7 @@ import sindexOfNotEqual = require( '@stdlib/blas/ext/base/ndarray/sindex-of-not- import sindexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/sindex-of-truthy' ); import slastIndexOf = require( '@stdlib/blas/ext/base/ndarray/slast-index-of' ); import slastIndexOfFalsy = require( '@stdlib/blas/ext/base/ndarray/slast-index-of-falsy' ); +import slastIndexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/slast-index-of-truthy' ); import slinspace = require( '@stdlib/blas/ext/base/ndarray/slinspace' ); import slogspace = require( '@stdlib/blas/ext/base/ndarray/slogspace' ); import snansum = require( '@stdlib/blas/ext/base/ndarray/snansum' ); @@ -195,6 +203,7 @@ import szeroTo = require( '@stdlib/blas/ext/base/ndarray/szero-to' ); 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 zindexOf = require( '@stdlib/blas/ext/base/ndarray/zindex-of' ); import zindexOfTruthy = require( '@stdlib/blas/ext/base/ndarray/zindex-of-truthy' ); import zlogspace = require( '@stdlib/blas/ext/base/ndarray/zlogspace' ); @@ -327,6 +336,41 @@ interface Namespace { */ ccopyWithin: typeof ccopyWithin; + /** + * Calculates the k-th discrete forward difference of a one-dimensional single-precision complex floating-point ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional ndarray containing values to prepend. + * - a one-dimensional ndarray containing values to append. + * - a one-dimensional output ndarray. + * - a one-dimensional workspace ndarray. + * - a zero-dimensional ndarray specifying the number of times to recursively compute differences. + * + * @param arrays - array-like object containing ndarrays + * @returns output ndarray + * + * @example + * var Complex64Vector = require( '@stdlib/ndarray/vector/complex64' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = new Complex64Vector( [ 2.0, -2.0, 4.0, -4.0 ] ); + * var prepend = new Complex64Vector( [ 1.0, -1.0 ] ); + * var append = new Complex64Vector( [ 7.0, -7.0 ] ); + * var out = new Complex64Vector( 3 ); + * var workspace = new Complex64Vector( 3 ); + * var k = scalar2ndarray( 1, { + * 'dtype': 'generic' + * }); + * + * var y = ns.cdiff( [ x, prepend, append, out, workspace, k ] ); + * // returns [ [ 1.0, -1.0 ], [ 2.0, -2.0 ], [ 3.0, -3.0 ] ] + */ + cdiff: typeof cdiff; + /** * Replaces elements in a one-dimensional single-precision complex floating-point ndarray equal to a provided search element with a specified scalar constant. * @@ -939,6 +983,34 @@ interface Namespace { */ dcopyWithin: typeof dcopyWithin; + /** + * Cumulatively tests whether every element in a one-dimensional double-precision floating-point ndarray is falsy. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * + * @param arrays - array-like object containing ndarrays + * @returns output ndarray + * + * @example + * var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); + * var BooleanVector = require( '@stdlib/ndarray/vector/bool' ); + * + * var x = new Float64Vector( [ 0.0, 0.0, 1.0, 1.0 ] ); + * var out = new BooleanVector( 4 ); + * + * var z = ns.dcunone( [ x, out ] ); + * // returns [ true, true, false, false ] + * + * var bool = ( z === out ); + * // returns true + */ + dcunone: typeof dcunone; + /** * Computes the cumulative sum of a one-dimensional double-precision floating-point ndarray. * @@ -1501,6 +1573,28 @@ interface Namespace { */ dlastIndexOfFalsy: typeof dlastIndexOfFalsy; + /** + * Returns the index of the last truthy element in a one-dimensional double-precision floating-point ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays + * @returns index + * + * @example + * var Float64Vector = require( '@stdlib/ndarray/vector/float64' ); + * + * var x = new Float64Vector( [ 0.0, 1.0, 0.0, 2.0 ] ); + * + * var v = ns.dlastIndexOfTruthy( [ x ] ); + * // returns 3 + */ + dlastIndexOfTruthy: typeof dlastIndexOfTruthy; + /** * Fills a one-dimensional double-precision floating-point ndarray with linearly spaced values over a specified interval. * @@ -2434,6 +2528,34 @@ interface Namespace { */ gcopyWithin: typeof gcopyWithin; + /** + * Cumulatively tests whether every element in a one-dimensional ndarray is falsy. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional output ndarray. + * + * @param arrays - array-like object containing ndarrays + * @returns output ndarray + * + * @example + * var vector = require( '@stdlib/ndarray/vector/ctor' ); + * var BooleanVector = require( '@stdlib/ndarray/vector/bool' ); + * + * var x = vector( [ 0.0, 0.0, 1.0, 1.0 ], 'generic' ); + * var out = new BooleanVector( 4 ); + * + * var z = ns.gcunone( [ x, out ] ); + * // returns [ true, true, false, false ] + * + * var bool = ( z === out ); + * // returns true + */ + gcunone: typeof gcunone; + /** * Computes the cumulative sum of a one-dimensional ndarray. * @@ -2599,6 +2721,41 @@ interface Namespace { */ gcusumpw: typeof gcusumpw; + /** + * Calculates the k-th discrete forward difference of a one-dimensional ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional ndarray containing values to prepend. + * - a one-dimensional ndarray containing values to append. + * - a one-dimensional output ndarray. + * - a one-dimensional workspace ndarray. + * - a zero-dimensional ndarray specifying the number of times to recursively compute differences. + * + * @param arrays - array-like object containing ndarrays + * @returns output ndarray + * + * @example + * var vector = require( '@stdlib/ndarray/vector/ctor' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = vector( [ 2.0, 4.0, 6.0, 8.0, 10.0 ], 'generic' ); + * var prepend = vector( [ 1.0 ], 'generic' ); + * var append = vector( [ 11.0 ], 'generic' ); + * var out = vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' ); + * var workspace = vector( [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' ); + * var k = scalar2ndarray( 1, { + * 'dtype': 'generic' + * }); + * + * var y = ns.gdiff( [ x, prepend, append, out, workspace, k ] ); + * // returns [ 1.0, 2.0, 2.0, 2.0, 2.0, 1.0 ] + */ + gdiff: typeof gdiff; + /** * Replaces elements in a one-dimensional ndarray equal to a provided search element with a specified scalar constant. * @@ -3079,6 +3236,28 @@ interface Namespace { */ glastIndexOfFalsy: typeof glastIndexOfFalsy; + /** + * Returns the index of the last truthy element in a one-dimensional ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays + * @returns index + * + * @example + * var vector = require( '@stdlib/ndarray/vector/ctor' ); + * + * var x = vector( [ 0.0, 3.0, 0.0, 2.0 ], 'generic' ); + * + * var v = ns.glastIndexOfTruthy( [ x ] ); + * // returns 3 + */ + glastIndexOfTruthy: typeof glastIndexOfTruthy; + /** * Fills a one-dimensional ndarray with linearly spaced values over a specified interval. * @@ -4122,6 +4301,41 @@ interface Namespace { */ scusumors: typeof scusumors; + /** + * Calculates the k-th discrete forward difference of a one-dimensional single-precision floating-point ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional ndarray containing values to prepend. + * - a one-dimensional ndarray containing values to append. + * - a one-dimensional output ndarray. + * - a one-dimensional workspace ndarray. + * - a zero-dimensional ndarray specifying the number of times to recursively compute differences. + * + * @param arrays - array-like object containing ndarrays + * @returns output ndarray + * + * @example + * var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = new Float32Vector( [ 2.0, 4.0, 6.0, 8.0, 10.0 ] ); + * var prepend = new Float32Vector( [ 1.0 ] ); + * var append = new Float32Vector( [ 11.0 ] ); + * var out = new Float32Vector( 6 ); + * var workspace = new Float32Vector( 6 ); + * var k = scalar2ndarray( 1, { + * 'dtype': 'generic' + * }); + * + * var y = ns.sdiff( [ x, prepend, append, out, workspace, k ] ); + * // returns [ 1.0, 2.0, 2.0, 2.0, 2.0, 1.0 ] + */ + sdiff: typeof sdiff; + /** * Replaces elements in a one-dimensional single-precision floating-point ndarray equal to a provided search element with a specified scalar constant. * @@ -4410,6 +4624,28 @@ interface Namespace { */ slastIndexOfFalsy: typeof slastIndexOfFalsy; + /** + * Returns the index of the last truthy element in a one-dimensional single-precision floating-point ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * + * @param arrays - array-like object containing ndarrays + * @returns index + * + * @example + * var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); + * + * var x = new Float32Vector( [ 0.0, 1.0, 0.0, 2.0 ] ); + * + * var v = ns.slastIndexOfTruthy( [ x ] ); + * // returns 3 + */ + slastIndexOfTruthy: typeof slastIndexOfTruthy; + /** * Fills a one-dimensional single-precision floating-point ndarray with linearly spaced values over a specified interval. * @@ -5213,6 +5449,41 @@ interface Namespace { */ zcopyWithin: typeof zcopyWithin; + /** + * Calculates the k-th discrete forward difference of a one-dimensional double-precision complex floating-point ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - a one-dimensional input ndarray. + * - a one-dimensional ndarray containing values to prepend. + * - a one-dimensional ndarray containing values to append. + * - a one-dimensional output ndarray. + * - a one-dimensional workspace ndarray. + * - a zero-dimensional ndarray specifying the number of times to recursively compute differences. + * + * @param arrays - array-like object containing ndarrays + * @returns output ndarray + * + * @example + * var Complex128Vector = require( '@stdlib/ndarray/vector/complex128' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); + * + * var x = new Complex128Vector( [ 2.0, 2.0, 4.0, 4.0 ] ); + * var prepend = new Complex128Vector( [ 1.0, 1.0 ] ); + * var append = new Complex128Vector( [ 7.0, 7.0 ] ); + * var out = new Complex128Vector( 3 ); + * var workspace = new Complex128Vector( 3 ); + * var k = scalar2ndarray( 1, { + * 'dtype': 'generic' + * }); + * + * var y = ns.zdiff( [ x, prepend, append, out, workspace, k ] ); + * // returns [ [ 1.0, 1.0 ], [ 2.0, 2.0 ], [ 3.0, 3.0 ] ] + */ + zdiff: typeof zdiff; + /** * Returns the first index of a search element in a one-dimensional double-precision complex floating-point ndarray. *