Skip to content

feat: update stats/strided/distances TypeScript declarations #10667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Mar 3, 2026
Merged

feat: update stats/strided/distances TypeScript declarations #10667

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
63 changes: 63 additions & 0 deletions lib/node_modules/@stdlib/stats/strided/distances/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down Expand Up @@ -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.
*
Expand Down