diff --git a/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts index 07616c453b62..6ecd89fdf24a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts @@ -2334,12 +2334,12 @@ interface Namespace { sapxsumkbn: typeof sapxsumkbn; /** - * Adds a constant to each single-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm. + * Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using a second-order iterative Kahan–Babuška algorithm. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns sum * * @example @@ -2388,12 +2388,12 @@ interface Namespace { sapxsumors: typeof sapxsumors; /** - * Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation. + * Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using pairwise summation. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns sum * * @example @@ -2419,7 +2419,7 @@ interface Namespace { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns sum * * @example @@ -2477,9 +2477,9 @@ interface Namespace { * @param N - number of indexed elements * @param sum - initial sum * @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 @@ -2508,9 +2508,9 @@ interface Namespace { * @param N - number of indexed elements * @param sum - initial sum * @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 diff --git a/lib/node_modules/@stdlib/complex/float64/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float64/base/docs/types/index.d.ts index f2865d3cdf6b..b6e35e32732f 100644 --- a/lib/node_modules/@stdlib/complex/float64/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float64/base/docs/types/index.d.ts @@ -85,6 +85,25 @@ interface Namespace { * * var im = imag( out ); * // returns -1.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var out = new Float64Array( 2 ); + * var v = ns.mul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 ); + * // returns [ -13.0, -1.0 ] + * + * var bool = ( out === v ); + * // returns true + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var z1 = new Float64Array( [ 5.0, 3.0 ] ); + * var z2 = new Float64Array( [ -2.0, 1.0 ] ); + * + * var out = ns.mul.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 ); + * // returns [ -13.0, -1.0 ] */ mul: typeof mul; } 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 7cb29ee23301..dc947fe0f75f 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 @@ -156,6 +156,25 @@ interface Namespace { * * var im = imag( out ); * // returns -1.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var out = new Float64Array( 2 ); + * var v = ns.cmul.assign( 5.0, 3.0, -2.0, 1.0, out, 1, 0 ); + * // returns [ -13.0, -1.0 ] + * + * var bool = ( out === v ); + * // returns true + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var z1 = new Float64Array( [ 5.0, 3.0 ] ); + * var z2 = new Float64Array( [ -2.0, 1.0 ] ); + * + * var out = ns.cmul.strided( z1, 1, 0, z2, 1, 0, new Float64Array( 2 ), 1, 0 ); + * // returns [ -13.0, -1.0 ] */ cmul: typeof cmul; 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 96140e16165b..635e20d1a1fe 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 @@ -607,7 +607,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 @@ -659,7 +659,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 @@ -711,7 +711,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 @@ -763,7 +763,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 @@ -1899,7 +1899,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 error of the mean * * @example @@ -1953,7 +1953,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 error of the mean * * @example @@ -2007,7 +2007,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 error of the mean * * @example @@ -4105,7 +4105,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 @@ -5863,7 +5863,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