Skip to content

Commit 278b4c0

Browse files
authored
feat: update stats/strided/distances TypeScript declarations
PR-URL: #10667 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 63d2333 commit 278b4c0

File tree

1 file changed

+63
-0
lines changed
  • lib/node_modules/@stdlib/stats/strided/distances/docs/types

1 file changed

+63
-0
lines changed

lib/node_modules/@stdlib/stats/strided/distances/docs/types/index.d.ts

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,48 @@
2020

2121
/* eslint-disable max-lines */
2222

23+
import dchebyshev = require( '@stdlib/stats/strided/distances/dchebyshev' );
2324
import dcityblock = require( '@stdlib/stats/strided/distances/dcityblock' );
2425
import dcosineDistance = require( '@stdlib/stats/strided/distances/dcosine-distance' );
2526
import dcosineSimilarity = require( '@stdlib/stats/strided/distances/dcosine-similarity' );
2627
import deuclidean = require( '@stdlib/stats/strided/distances/deuclidean' );
28+
import dminkowski = require( '@stdlib/stats/strided/distances/dminkowski' );
2729
import dsquaredEuclidean = require( '@stdlib/stats/strided/distances/dsquared-euclidean' );
2830

2931
/**
3032
* Interface describing the `distances` namespace.
3133
*/
3234
interface Namespace {
35+
/**
36+
* Computes the Chebyshev distance between two double-precision floating-point strided arrays.
37+
*
38+
* @param N - number of indexed elements
39+
* @param x - first input array
40+
* @param strideX - `x` stride length
41+
* @param y - second input array
42+
* @param strideY - `y` stride length
43+
* @returns Chebyshev distance
44+
*
45+
* @example
46+
* var Float64Array = require( '@stdlib/array/float64' );
47+
*
48+
* var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
49+
* var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
50+
*
51+
* var z = ns.dchebyshev( x.length, x, 1, y, 1 );
52+
* // returns 9.0
53+
*
54+
* @example
55+
* var Float64Array = require( '@stdlib/array/float64' );
56+
*
57+
* var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
58+
* var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
59+
*
60+
* var z = ns.dchebyshev.ndarray( x.length, x, 1, 0, y, 1, 0 );
61+
* // returns 9.0
62+
*/
63+
dchebyshev: typeof dchebyshev;
64+
3365
/**
3466
* Computes the city block (Manhattan) distance between two double-precision floating-point strided arrays.
3567
*
@@ -150,6 +182,37 @@ interface Namespace {
150182
*/
151183
deuclidean: typeof deuclidean;
152184

185+
/**
186+
* Computes the Minkowski distance between two double-precision floating-point strided arrays.
187+
*
188+
* @param N - number of indexed elements
189+
* @param p - order of the Minkowski norm
190+
* @param x - first input array
191+
* @param strideX - `x` stride length
192+
* @param y - second input array
193+
* @param strideY - `y` stride length
194+
* @returns Minkowski distance
195+
*
196+
* @example
197+
* var Float64Array = require( '@stdlib/array/float64' );
198+
*
199+
* var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
200+
* var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
201+
*
202+
* var z = ns.dminkowski( x.length, 3, x, 1, y, 1 );
203+
* // returns ~11.543
204+
*
205+
* @example
206+
* var Float64Array = require( '@stdlib/array/float64' );
207+
*
208+
* var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );
209+
* var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
210+
*
211+
* var z = ns.dminkowski.ndarray( x.length, 3, x, 1, 0, y, 1, 0 );
212+
* // returns ~11.543
213+
*/
214+
dminkowski: typeof dminkowski;
215+
153216
/**
154217
* Computes the squared Euclidean distance between two double-precision floating-point strided arrays.
155218
*

0 commit comments

Comments
 (0)