From 44a9b2dfc1bc3952b42d9a1a4a253c2b2e8acb05 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Wed, 26 Aug 2026 02:35:31 +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 | 216 +++++++++++++++++- 1 file changed, 214 insertions(+), 2 deletions(-) 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 ad9762242d6f..c9aba6ed9b0b 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 @@ -46,6 +46,8 @@ 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 dcuany = require( '@stdlib/blas/ext/base/ndarray/dcuany' ); +import dcuevery = require( '@stdlib/blas/ext/base/ndarray/dcuevery' ); 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' ); @@ -102,6 +104,8 @@ 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 gcuany = require( '@stdlib/blas/ext/base/ndarray/gcuany' ); +import gcuevery = require( '@stdlib/blas/ext/base/ndarray/gcuevery' ); 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' ); @@ -148,6 +152,7 @@ import gtril2triu = require( '@stdlib/blas/ext/base/ndarray/gtril2triu' ); import gtriu = require( '@stdlib/blas/ext/base/ndarray/gtriu' ); import gtriu2tril = require( '@stdlib/blas/ext/base/ndarray/gtriu2tril' ); import gunitspace = require( '@stdlib/blas/ext/base/ndarray/gunitspace' ); +import gwxpy = require( '@stdlib/blas/ext/base/ndarray/gwxpy' ); import gwxsa = require( '@stdlib/blas/ext/base/ndarray/gwxsa' ); import gxdy = require( '@stdlib/blas/ext/base/ndarray/gxdy' ); import gxmy = require( '@stdlib/blas/ext/base/ndarray/gxmy' ); @@ -160,6 +165,8 @@ import saxpb = require( '@stdlib/blas/ext/base/ndarray/saxpb' ); import saxpby = require( '@stdlib/blas/ext/base/ndarray/saxpby' ); import scircshift = require( '@stdlib/blas/ext/base/ndarray/scircshift' ); import scopyWithin = require( '@stdlib/blas/ext/base/ndarray/scopy-within' ); +import scuany = require( '@stdlib/blas/ext/base/ndarray/scuany' ); +import scuevery = require( '@stdlib/blas/ext/base/ndarray/scuevery' ); import scunone = require( '@stdlib/blas/ext/base/ndarray/scunone' ); import scusum = require( '@stdlib/blas/ext/base/ndarray/scusum' ); import scusumkbn = require( '@stdlib/blas/ext/base/ndarray/scusumkbn' ); @@ -1023,6 +1030,62 @@ interface Namespace { */ dcopyWithin: typeof dcopyWithin; + /** + * Cumulatively tests whether at least one element in a one-dimensional double-precision floating-point ndarray is truthy. + * + * ## 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, 0.0 ] ); + * var out = new BooleanVector( 4 ); + * + * var z = ns.dcuany( [ x, out ] ); + * // returns [ false, false, true, true ] + * + * var bool = ( z === out ); + * // returns true + */ + dcuany: typeof dcuany; + + /** + * Cumulatively tests whether every element in a one-dimensional double-precision floating-point ndarray is truthy. + * + * ## 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( [ 1.0, 1.0, 0.0, 1.0 ] ); + * var out = new BooleanVector( 4 ); + * + * var z = ns.dcuevery( [ x, out ] ); + * // returns [ true, true, false, false ] + * + * var bool = ( z === out ); + * // returns true + */ + dcuevery: typeof dcuevery; + /** * Cumulatively tests whether every element in a one-dimensional double-precision floating-point ndarray is falsy. * @@ -2645,6 +2708,62 @@ interface Namespace { */ gcopyWithin: typeof gcopyWithin; + /** + * Cumulatively tests whether at least one element in a one-dimensional ndarray is truthy. + * + * ## 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, 0.0 ], 'generic' ); + * var out = new BooleanVector( 4 ); + * + * var z = ns.gcuany( [ x, out ] ); + * // returns [ false, false, true, true ] + * + * var bool = ( z === out ); + * // returns true + */ + gcuany: typeof gcuany; + + /** + * Cumulatively tests whether every element in a one-dimensional ndarray is truthy. + * + * ## 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( [ 1.0, 1.0, 0.0, 1.0 ], 'generic' ); + * var out = new BooleanVector( 4 ); + * + * var z = ns.gcuevery( [ x, out ] ); + * // returns [ true, true, false, false ] + * + * var bool = ( z === out ); + * // returns true + */ + gcuevery: typeof gcuevery; + /** * Cumulatively tests whether every element in a one-dimensional ndarray is falsy. * @@ -3991,6 +4110,32 @@ interface Namespace { */ gunitspace: typeof gunitspace; + /** + * Adds elements of a one-dimensional ndarray to the corresponding elements of a second one-dimensional ndarray and assigns the results to elements in a third one-dimensional ndarray. + * + * ## Notes + * + * - The function expects the following ndarrays: + * + * - first one-dimensional input ndarray. + * - second 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 x = vector( [ 1.0, 2.0, 3.0, 4.0, 5.0 ], 'generic' ); + * var y = vector( [ 2.0, 3.0, 4.0, 5.0, 6.0 ], 'generic' ); + * var w = vector( [ 0.0, 0.0, 0.0, 0.0, 0.0 ], 'generic' ); + * + * var out = ns.gwxpy( [ x, y, w ] ); + * // returns [ 3.0, 5.0, 7.0, 9.0, 11.0 ] + */ + gwxpy: typeof gwxpy; + /** * Subtracts a scalar constant from each element in an input one-dimensional ndarray and assigns the results to elements in a one-dimensional output ndarray. * @@ -4329,6 +4474,62 @@ interface Namespace { */ scopyWithin: typeof scopyWithin; + /** + * Cumulatively tests whether at least one element in a one-dimensional single-precision floating-point ndarray is truthy. + * + * ## 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 Float32Vector = require( '@stdlib/ndarray/vector/float32' ); + * var BooleanVector = require( '@stdlib/ndarray/vector/bool' ); + * + * var x = new Float32Vector( [ 0.0, 0.0, 1.0, 0.0 ] ); + * var out = new BooleanVector( 4 ); + * + * var z = ns.scuany( [ x, out ] ); + * // returns [ false, false, true, true ] + * + * var bool = ( z === out ); + * // returns true + */ + scuany: typeof scuany; + + /** + * Cumulatively tests whether every element in a one-dimensional single-precision floating-point ndarray is truthy. + * + * ## 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 Float32Vector = require( '@stdlib/ndarray/vector/float32' ); + * var BooleanVector = require( '@stdlib/ndarray/vector/bool' ); + * + * var x = new Float32Vector( [ 1.0, 1.0, 0.0, 1.0 ] ); + * var out = new BooleanVector( 4 ); + * + * var z = ns.scuevery( [ x, out ] ); + * // returns [ true, true, false, false ] + * + * var bool = ( z === out ); + * // returns true + */ + scuevery: typeof scuevery; + /** * Cumulatively tests whether every element in a one-dimensional single-precision floating-point ndarray is falsy. * @@ -4663,6 +4864,7 @@ interface Namespace { * * - first one-dimensional input ndarray. * - second one-dimensional input ndarray. + * - a zero-dimensional ndarray containing the index from which to begin searching. * * - When comparing elements, the function checks whether an element in the first one-dimensional input ndarray is less than a corresponding element in the second one-dimensional input ndarray using the less-than operator `<`. As a consequence, comparisons involving `NaN` always evaluate to `false`. * @@ -4671,11 +4873,16 @@ interface Namespace { * * @example * var Float32Vector = require( '@stdlib/ndarray/vector/float32' ); + * var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' ); * * var x = new Float32Vector( [ 0.0, 0.0, 0.0, 0.0 ] ); * var y = new Float32Vector( [ 0.0, 0.0, 1.0, 0.0 ] ); * - * var idx = ns.sfirstIndexLessThan( [ x, y ] ); + * var fromIndex = scalar2ndarray( 0, { + * 'dtype': 'generic' + * }); + * + * var idx = ns.sfirstIndexLessThan( [ x, y, fromIndex ] ); * // returns 2 */ sfirstIndexLessThan: typeof sfirstIndexLessThan; @@ -4750,6 +4957,7 @@ interface Namespace { * * - a one-dimensional input ndarray. * - a zero-dimensional ndarray containing the search element. + * - a zero-dimensional ndarray containing the index from which to begin searching. * * @param arrays - array-like object containing ndarrays * @returns index @@ -4764,7 +4972,11 @@ interface Namespace { * 'dtype': 'float32' * }); * - * var v = ns.sindexOfNotEqual( [ x, searchElement ] ); + * var fromIndex = scalar2ndarray( 0, { + * 'dtype': 'generic' + * }); + * + * var v = ns.sindexOfNotEqual( [ x, searchElement, fromIndex ] ); * // returns 2 */ sindexOfNotEqual: typeof sindexOfNotEqual;