From 0882189999784bd0c3afd832843564460e0fa1b6 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Mon, 17 Feb 2025 02:30:58 +0000 Subject: [PATCH] feat: update namespace TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/blas/base/docs/types/index.d.ts | 22 +++++++-------- .../float32/base/docs/types/index.d.ts | 19 +++++++++++++ .../math/base/ops/docs/types/index.d.ts | 19 +++++++++++++ .../@stdlib/stats/base/docs/types/index.d.ts | 27 ------------------- 4 files changed, 49 insertions(+), 38 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts index 622315a785d2..df9be155398a 100644 --- a/lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/docs/types/index.d.ts @@ -2126,30 +2126,30 @@ interface Namespace { * Scales a double-precision complex floating-point vector by a double-precision complex floating-point constant. * * @param N - number of indexed elements - * @param za - scalar constant - * @param zx - input array - * @param strideX - `zx` stride length + * @param alpha - scalar constant + * @param x - input array + * @param strideX - `x` stride length * @returns input array * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * - * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); - * var za = new Complex128( 2.0, 2.0 ); + * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * var alpha = new Complex128( 2.0, 2.0 ); * - * ns.zscal( 3, za, zx, 1 ); - * // zx => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ] + * ns.zscal( 3, alpha, x, 1 ); + * // x => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ] * * @example * var Complex128Array = require( '@stdlib/array/complex128' ); * var Complex128 = require( '@stdlib/complex/float64/ctor' ); * - * var zx = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); - * var za = new Complex128( 2.0, 2.0 ); + * var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * var alpha = new Complex128( 2.0, 2.0 ); * - * ns.zscal.ndarray( 2, za, zx, 1, 1 ); - * // zx => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ] + * ns.zscal.ndarray( 2, alpha, x, 1, 1 ); + * // x => [ -2.0, 6.0, -2.0, 14.0, -2.0, 22.0 ] */ zscal: typeof zscal; diff --git a/lib/node_modules/@stdlib/complex/float32/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/complex/float32/base/docs/types/index.d.ts index e99b622a3aa0..bc18e77a9aaf 100644 --- a/lib/node_modules/@stdlib/complex/float32/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/complex/float32/base/docs/types/index.d.ts @@ -85,6 +85,25 @@ interface Namespace { * * var im = imagf( out ); * // returns -1.0 + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var out = new Float32Array( 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 Float32Array = require( '@stdlib/array/float32' ); + * + * var z1 = new Float32Array( [ 5.0, 3.0 ] ); + * var z2 = new Float32Array( [ -2.0, 1.0 ] ); + * + * var out = ns.mul.strided( z1, 1, 0, z2, 1, 0, new Float32Array( 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 001f03935832..7cb8a7e8ea23 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 @@ -97,6 +97,25 @@ interface Namespace { * * var im = imagf( out ); * // returns -1.0 + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var out = new Float32Array( 2 ); + * var v = ns.cmulf.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 Float32Array = require( '@stdlib/array/float32' ); + * + * var z1 = new Float32Array( [ 5.0, 3.0 ] ); + * var z2 = new Float32Array( [ -2.0, 1.0 ] ); + * + * var out = ns.cmulf.strided( z1, 1, 0, z2, 1, 0, new Float32Array( 2 ), 1, 0 ); + * // returns [ -13.0, -1.0 ] */ cmulf: typeof cmulf; 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 867da9fae754..09ae47acdda5 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 @@ -26,7 +26,6 @@ import cumin = require( '@stdlib/stats/base/cumin' ); import cuminabs = require( '@stdlib/stats/base/cuminabs' ); import dcumin = require( '@stdlib/stats/base/dcumin' ); import dists = require( '@stdlib/stats/base/dists' ); -import dmaxabs = require( '@stdlib/stats/strided/dmaxabs' ); import dmaxabssorted = require( '@stdlib/stats/base/dmaxabssorted' ); import dmaxsorted = require( '@stdlib/stats/base/dmaxsorted' ); import dmean = require( '@stdlib/stats/base/dmean' ); @@ -378,32 +377,6 @@ interface Namespace { */ dists: typeof dists; - /** - * Computes the maximum 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 maximum absolute value - * - * @example - * var Float64Array = require( '@stdlib/array/float64' ); - * - * var x = new Float64Array( [ 1.0, -2.0, 2.0 ] ); - * - * var v = ns.dmaxabs( 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.dmaxabs.ndarray( x.length, x, 1, 0 ); - * // returns 2.0 - */ - dmaxabs: typeof dmaxabs; - /** * Computes the maximum absolute value of a sorted double-precision floating-point strided array. *