From f60867988b9b56da4c8829557a5ef69186b2dc8e Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 3 Mar 2026 03:12:51 +0000 Subject: [PATCH] feat: update `stats/strided/distances` TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../strided/distances/docs/types/index.d.ts | 63 +++++++++++++++++++ 1 file changed, 63 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/strided/distances/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/strided/distances/docs/types/index.d.ts index 5c322c98975f..4dce176d96ad 100644 --- a/lib/node_modules/@stdlib/stats/strided/distances/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/strided/distances/docs/types/index.d.ts @@ -20,16 +20,48 @@ /* eslint-disable max-lines */ +import dchebyshev = require( '@stdlib/stats/strided/distances/dchebyshev' ); import dcityblock = require( '@stdlib/stats/strided/distances/dcityblock' ); import dcosineDistance = require( '@stdlib/stats/strided/distances/dcosine-distance' ); import dcosineSimilarity = require( '@stdlib/stats/strided/distances/dcosine-similarity' ); import deuclidean = require( '@stdlib/stats/strided/distances/deuclidean' ); +import dminkowski = require( '@stdlib/stats/strided/distances/dminkowski' ); import dsquaredEuclidean = require( '@stdlib/stats/strided/distances/dsquared-euclidean' ); /** * Interface describing the `distances` namespace. */ interface Namespace { + /** + * Computes the Chebyshev distance between two double-precision floating-point strided arrays. + * + * @param N - number of indexed elements + * @param x - first input array + * @param strideX - `x` stride length + * @param y - second input array + * @param strideY - `y` stride length + * @returns Chebyshev distance + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + * + * var z = ns.dchebyshev( x.length, x, 1, y, 1 ); + * // returns 9.0 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + * + * var z = ns.dchebyshev.ndarray( x.length, x, 1, 0, y, 1, 0 ); + * // returns 9.0 + */ + dchebyshev: typeof dchebyshev; + /** * Computes the city block (Manhattan) distance between two double-precision floating-point strided arrays. * @@ -150,6 +182,37 @@ interface Namespace { */ deuclidean: typeof deuclidean; + /** + * Computes the Minkowski distance between two double-precision floating-point strided arrays. + * + * @param N - number of indexed elements + * @param p - order of the Minkowski norm + * @param x - first input array + * @param strideX - `x` stride length + * @param y - second input array + * @param strideY - `y` stride length + * @returns Minkowski distance + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + * + * var z = ns.dminkowski( x.length, 3, x, 1, y, 1 ); + * // returns ~11.543 + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); + * + * var z = ns.dminkowski.ndarray( x.length, 3, x, 1, 0, y, 1, 0 ); + * // returns ~11.543 + */ + dminkowski: typeof dminkowski; + /** * Computes the squared Euclidean distance between two double-precision floating-point strided arrays. *