diff --git a/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts index 3a092f816748..a7e75245a216 100644 --- a/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/ops/docs/types/index.d.ts @@ -29,17 +29,17 @@ import cneg = require( '@stdlib/math/base/ops/cneg' ); import cnegf = require( '@stdlib/math/base/ops/cnegf' ); import csub = require( '@stdlib/math/base/ops/csub' ); import csubf = require( '@stdlib/math/base/ops/csubf' ); -import div = require( '@stdlib/number/float64/base/div' ); import divf = require( '@stdlib/math/base/ops/divf' ); import imul = require( '@stdlib/math/base/ops/imul' ); import imuldw = require( '@stdlib/math/base/ops/imuldw' ); -import mul = require( '@stdlib/number/float64/base/mul' ); import mulf = require( '@stdlib/math/base/ops/mulf' ); -import sub = require( '@stdlib/number/float64/base/sub' ); import subf = require( '@stdlib/math/base/ops/subf' ); import umul = require( '@stdlib/math/base/ops/umul' ); import umuldw = require( '@stdlib/math/base/ops/umuldw' ); import addf = require( '@stdlib/number/float32/base/add' ); +import div = require( '@stdlib/number/float64/base/div' ); +import mul = require( '@stdlib/number/float64/base/mul' ); +import sub = require( '@stdlib/number/float64/base/sub' ); /** * Interface describing the `ops` namespace. @@ -417,35 +417,6 @@ interface Namespace { */ csubf: typeof csubf; - /** - * Divides two double-precision floating-point numbers `x` and `y`. - * - * @param x - first input value (divided) - * @param y - second input value (divisor) - * @returns result - * - * @example - * var v = ns.div( -1.0, 5.0 ); - * // returns -0.2 - * - * @example - * var v = ns.div( 2.0, 5.0 ); - * // returns 0.4 - * - * @example - * var v = ns.div( 0.0, 5.0 ); - * // returns 0.0 - * - * @example - * var v = ns.div( -0.0, 5.0 ); - * // returns -0.0 - * - * @example - * var v = ns.div( NaN, NaN ); - * // returns NaN - */ - div: typeof div; - /** * Divides two single-precision floating-point numbers `x` and `y`. * @@ -505,35 +476,6 @@ interface Namespace { */ imuldw: typeof imuldw; - /** - * Multiplies two double-precision floating-point numbers `x` and `y`. - * - * @param x - first input value - * @param y - second input value - * @returns result - * - * @example - * var v = ns.mul( -1.0, 5.0 ); - * // returns -5.0 - * - * @example - * var v = ns.mul( 2.0, 5.0 ); - * // returns 10.0 - * - * @example - * var v = ns.mul( 0.0, 5.0 ); - * // returns 0.0 - * - * @example - * var v = ns.mul( -0.0, 0.0 ); - * // returns -0.0 - * - * @example - * var v = ns.mul( NaN, NaN ); - * // returns NaN - */ - mul: typeof mul; - /** * Multiplies two single-precision floating-point numbers `x` and `y`. * @@ -563,35 +505,6 @@ interface Namespace { */ mulf: typeof mulf; - /** - * Subtracts two double-precision floating-point numbers `x` and `y`. - * - * @param x - first input value - * @param y - second input value - * @returns result - * - * @example - * var v = ns.sub( -1.0, 5.0 ); - * // returns -6.0 - * - * @example - * var v = ns.sub( 2.0, 5.0 ); - * // returns -3.0 - * - * @example - * var v = ns.sub( 0.0, 5.0 ); - * // returns -5.0 - * - * @example - * var v = ns.sub( -0.0, 0.0 ); - * // returns -0.0 - * - * @example - * var v = ns.sub( NaN, NaN ); - * // returns NaN - */ - sub: typeof sub; - /** * Subtracts two single-precision floating-point numbers `x` and `y`. * @@ -679,6 +592,93 @@ interface Namespace { * // returns NaN */ addf: typeof addf; + + /** + * Divides two double-precision floating-point numbers `x` and `y`. + * + * @param x - first input value (divided) + * @param y - second input value (divisor) + * @returns result + * + * @example + * var v = ns.div( -1.0, 5.0 ); + * // returns -0.2 + * + * @example + * var v = ns.div( 2.0, 5.0 ); + * // returns 0.4 + * + * @example + * var v = ns.div( 0.0, 5.0 ); + * // returns 0.0 + * + * @example + * var v = ns.div( -0.0, 5.0 ); + * // returns -0.0 + * + * @example + * var v = ns.div( NaN, NaN ); + * // returns NaN + */ + div: typeof div; + + /** + * Multiplies two double-precision floating-point numbers `x` and `y`. + * + * @param x - first input value + * @param y - second input value + * @returns result + * + * @example + * var v = ns.mul( -1.0, 5.0 ); + * // returns -5.0 + * + * @example + * var v = ns.mul( 2.0, 5.0 ); + * // returns 10.0 + * + * @example + * var v = ns.mul( 0.0, 5.0 ); + * // returns 0.0 + * + * @example + * var v = ns.mul( -0.0, 0.0 ); + * // returns -0.0 + * + * @example + * var v = ns.mul( NaN, NaN ); + * // returns NaN + */ + mul: typeof mul; + + /** + * Subtracts two double-precision floating-point numbers `x` and `y`. + * + * @param x - first input value + * @param y - second input value + * @returns result + * + * @example + * var v = ns.sub( -1.0, 5.0 ); + * // returns -6.0 + * + * @example + * var v = ns.sub( 2.0, 5.0 ); + * // returns -3.0 + * + * @example + * var v = ns.sub( 0.0, 5.0 ); + * // returns -5.0 + * + * @example + * var v = ns.sub( -0.0, 0.0 ); + * // returns -0.0 + * + * @example + * var v = ns.sub( NaN, NaN ); + * // returns NaN + */ + sub: typeof sub; } /** 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 1f25b78941c5..61780d40bc40 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 @@ -32,12 +32,6 @@ import dmeanstdev = require( '@stdlib/stats/base/dmeanstdev' ); import dmeanstdevpn = require( '@stdlib/stats/base/dmeanstdevpn' ); import dmeanvar = require( '@stdlib/stats/base/dmeanvar' ); import dmeanvarpn = require( '@stdlib/stats/base/dmeanvarpn' ); -import dmeanwd = require( '@stdlib/stats/strided/dmeanwd' ); -import dmediansorted = require( '@stdlib/stats/strided/dmediansorted' ); -import dmidrange = require( '@stdlib/stats/strided/dmidrange' ); -import dmin = require( '@stdlib/stats/strided/dmin' ); -import dminabs = require( '@stdlib/stats/strided/dminabs' ); -import dminsorted = require( '@stdlib/stats/strided/dminsorted' ); import dmskmax = require( '@stdlib/stats/base/dmskmax' ); import dmskmin = require( '@stdlib/stats/base/dmskmin' ); import dmskrange = require( '@stdlib/stats/base/dmskrange' ); @@ -230,6 +224,12 @@ import dmeanli = require( '@stdlib/stats/strided/dmeanli' ); import dmeanlipw = require( '@stdlib/stats/strided/dmeanlipw' ); import dmeanors = require( '@stdlib/stats/strided/dmeanors' ); import dmeanpw = require( '@stdlib/stats/strided/dmeanpw' ); +import dmeanwd = require( '@stdlib/stats/strided/dmeanwd' ); +import dmediansorted = require( '@stdlib/stats/strided/dmediansorted' ); +import dmidrange = require( '@stdlib/stats/strided/dmidrange' ); +import dmin = require( '@stdlib/stats/strided/dmin' ); +import dminabs = require( '@stdlib/stats/strided/dminabs' ); +import dminsorted = require( '@stdlib/stats/strided/dminsorted' ); /** * Interface describing the `base` namespace. @@ -266,9 +266,9 @@ interface Namespace { * * @param N - number of indexed elements * @param x - input array - * @param strideX - `x` stride length + * @param strideX - stride length for `x` * @param y - output array - * @param strideY - `y` stride length + * @param strideY - stride length for `y` * @returns output array * * @example @@ -292,9 +292,9 @@ interface Namespace { * * @param N - number of indexed elements * @param x - input array - * @param strideX - `x` stride length + * @param strideX - stride length for `x` * @param y - output array - * @param strideY - `y` stride length + * @param strideY - stride length for `y` * @returns output array * * @example @@ -550,162 +550,6 @@ interface Namespace { */ dmeanvarpn: typeof dmeanvarpn; - /** - * Computes the arithmetic mean of a double-precision floating-point strided array using Welford's algorithm. - * - * @param N - number of indexed elements - * @param x - input array - * @param strideX - stride length - * @returns arithmetic mean - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); - * - * var v = ns.dmeanwd( x.length, x, 1 ); - * // returns ~0.3333 - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); - * - * var v = ns.dmeanwd.ndarray( x.length, x, 1, 0 ); - * // returns ~0.3333 - */ - dmeanwd: typeof dmeanwd; - - /** - * Computes the median value of a sorted double-precision floating-point strided array. - * - * @param N - number of indexed elements - * @param x - sorted input array - * @param strideX - stride length - * @returns median value - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); - * - * var v = ns.dmediansorted( x.length, x, 1 ); - * // returns 2.0 - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); - * - * var v = ns.dmediansorted.ndarray( x.length, x, 1, 0 ); - * // returns 2.0 - */ - dmediansorted: typeof dmediansorted; - - /** - * Computes the mid-range of a double-precision floating-point strided array. - * - * @param N - number of indexed elements - * @param x - input array - * @param strideX - stride length - * @returns mid-range - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); - * - * var v = ns.dmidrange( x.length, x, 1 ); - * // returns 0.0 - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); - * - * var v = ns.dmidrange.ndarray( x.length, x, 1, 0 ); - * // returns 0.0 - */ - dmidrange: typeof dmidrange; - - /** - * Computes the minimum value of a double-precision floating-point strided array. - * - * @param N - number of indexed elements - * @param x - input array - * @param strideX - stride length - * @returns minimum value - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); - * - * var v = ns.dmin( x.length, x, 1 ); - * // returns -2.0 - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); - * - * var v = ns.dmin.ndarray( x.length, x, 1, 0 ); - * // returns -2.0 - */ - dmin: typeof dmin; - - /** - * Computes the minimum absolute value of a double-precision floating-point strided array. - * - * @param N - number of indexed elements - * @param x - input array - * @param strideX - stride length - * @returns minimum absolute value - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); - * - * var v = ns.dminabs( x.length, x, 1 ); - * // returns 1.0 - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); - * - * var v = ns.dminabs.ndarray( x.length, x, 1, 0 ); - * // returns 1.0 - */ - dminabs: typeof dminabs; - - /** - * Computes the minimum value of a sorted double-precision floating-point strided array. - * - * @param N - number of indexed elements - * @param x - sorted input array - * @param strideX - stride length - * @returns minimum value - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); - * - * var v = ns.dminsorted( x.length, x, 1 ); - * // returns 1.0 - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); - * - * var v = ns.dminsorted.ndarray( x.length, x, 1, 0 ); - * // returns 1.0 - */ - dminsorted: typeof dminsorted; - /** * Computes the maximum value of a double-precision floating-point strided array according to a mask. * @@ -859,7 +703,7 @@ interface Namespace { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns arithmetic mean * * @example @@ -1407,7 +1251,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 @@ -5793,6 +5637,162 @@ interface Namespace { * // returns ~0.3333 */ dmeanpw: typeof dmeanpw; + + /** + * Computes the arithmetic mean of a double-precision floating-point strided array using Welford's algorithm. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length + * @returns arithmetic mean + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dmeanwd( x.length, x, 1 ); + * // returns ~0.3333 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dmeanwd.ndarray( x.length, x, 1, 0 ); + * // returns ~0.3333 + */ + dmeanwd: typeof dmeanwd; + + /** + * Computes the median value of a sorted double-precision floating-point strided array. + * + * @param N - number of indexed elements + * @param x - sorted input array + * @param strideX - stride length + * @returns median value + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + * + * var v = ns.dmediansorted( x.length, x, 1 ); + * // returns 2.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + * + * var v = ns.dmediansorted.ndarray( x.length, x, 1, 0 ); + * // returns 2.0 + */ + dmediansorted: typeof dmediansorted; + + /** + * Computes the mid-range of a double-precision floating-point strided array. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length + * @returns mid-range + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dmidrange( x.length, x, 1 ); + * // returns 0.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dmidrange.ndarray( x.length, x, 1, 0 ); + * // returns 0.0 + */ + dmidrange: typeof dmidrange; + + /** + * Computes the minimum value of a double-precision floating-point strided array. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length + * @returns minimum value + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dmin( x.length, x, 1 ); + * // returns -2.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dmin.ndarray( x.length, x, 1, 0 ); + * // returns -2.0 + */ + dmin: typeof dmin; + + /** + * Computes the minimum absolute value of a double-precision floating-point strided array. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length + * @returns minimum absolute value + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dminabs( x.length, x, 1 ); + * // returns 1.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); + * + * var v = ns.dminabs.ndarray( x.length, x, 1, 0 ); + * // returns 1.0 + */ + dminabs: typeof dminabs; + + /** + * Computes the minimum value of a sorted double-precision floating-point strided array. + * + * @param N - number of indexed elements + * @param x - sorted input array + * @param strideX - stride length + * @returns minimum value + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + * + * var v = ns.dminsorted( x.length, x, 1 ); + * // returns 1.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + * + * var v = ns.dminsorted.ndarray( x.length, x, 1, 0 ); + * // returns 1.0 + */ + dminsorted: typeof dminsorted; } /**