From 9a9b7cf99a9e6316a3163c5540734594fe82105a Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Thu, 13 Mar 2025 02:32:49 +0000 Subject: [PATCH] feat: update namespace TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../blas/ext/base/wasm/docs/types/index.d.ts | 83 +++++++++++++++++++ .../@stdlib/stats/base/docs/types/index.d.ts | 6 +- 2 files changed, 86 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/wasm/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/wasm/docs/types/index.d.ts index 192d310237e8..1cc4c098dc5c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/wasm/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/wasm/docs/types/index.d.ts @@ -20,12 +20,42 @@ /* eslint-disable max-lines */ +import dapxsum = require( '@stdlib/blas/ext/base/dapxsum' ); import dapxsumkbn = require( '@stdlib/blas/ext/base/dapxsumkbn' ); +import dapxsumpw = require( '@stdlib/blas/ext/base/dapxsumpw' ); +import dnansumpw = require( '@stdlib/blas/ext/base/dnansumpw' ); /** * Interface describing the `wasm` namespace. */ interface Namespace { + /** + * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum. + * + * @param N - number of indexed elements + * @param alpha - scalar constant + * @param x - input array + * @param strideX - stride length + * @returns sum + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dapxsum( x.length, 5.0, x, 1 ); + * // returns 16.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dapxsum.ndarray( x.length, 5.0, x, 1, 0 ); + * // returns 16.0 + */ + dapxsum: typeof dapxsum; + /** * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm. * @@ -52,6 +82,59 @@ interface Namespace { * // returns 16.0 */ dapxsumkbn: typeof dapxsumkbn; + + /** + * Adds a scalar constant to each double-precision floating-point strided array element and computes the sum using pairwise summation. + * + * @param N - number of indexed elements + * @param alpha - scalar constant + * @param x - input array + * @param strideX - stride length + * @returns sum + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dapxsumpw( x.length, 5.0, x, 1 ); + * // returns 16.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dapxsumpw.ndarray( x.length, 5.0, x, 1, 0 ); + * // returns 16.0 + */ + dapxsumpw: typeof dapxsumpw; + + /** + * Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length + * @returns sum + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); + * + * var v = ns.dnansumpw( x.length, x, 1 ); + * // returns 1.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); + * + * var v = ns.dnansumpw.ndarray( x.length, x, 1, 0 ); + * // returns 1.0 + */ + dnansumpw: typeof dnansumpw; } /** diff --git a/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts index e9da376d08d8..8943d5acd7eb 100644 --- a/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts @@ -1037,7 +1037,7 @@ interface Namespace { * @param N - number of indexed elements * @param correction - degrees of freedom adjustment * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns standard deviation * * @example @@ -1702,7 +1702,7 @@ interface Namespace { * @param N - number of indexed elements * @param correction - degrees of freedom adjustment * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns standard deviation * * @example @@ -5162,7 +5162,7 @@ interface Namespace { * @param N - number of indexed elements * @param correction - degrees of freedom adjustment * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns variance * * @example