Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
83 changes: 83 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/wasm/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand All @@ -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;
}

/**
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/stats/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down