Skip to content

Commit fa775c5

Browse files
committed
fix: register dcorrelation in stats/strided/distances namespace types
https://claude.ai/code/session_01PYMuhnRSCirT5T3Bn4o4Lj
1 parent 4c10a06 commit fa775c5

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/stats/strided/distances/docs/types

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
import dchebyshev = require( '@stdlib/stats/strided/distances/dchebyshev' );
2424
import dcityblock = require( '@stdlib/stats/strided/distances/dcityblock' );
25+
import dcorrelation = require( '@stdlib/stats/strided/distances/dcorrelation' );
2526
import dcosineDistance = require( '@stdlib/stats/strided/distances/dcosine-distance' );
2627
import dcosineSimilarity = require( '@stdlib/stats/strided/distances/dcosine-similarity' );
2728
import deuclidean = require( '@stdlib/stats/strided/distances/deuclidean' );
@@ -92,6 +93,36 @@ interface Namespace {
9293
*/
9394
dcityblock: typeof dcityblock;
9495

96+
/**
97+
* Computes the correlation distance between two double-precision floating-point strided arrays.
98+
*
99+
* @param N - number of indexed elements
100+
* @param x - first input array
101+
* @param strideX - `x` stride length
102+
* @param y - second input array
103+
* @param strideY - `y` stride length
104+
* @returns correlation distance
105+
*
106+
* @example
107+
* var Float64Array = require( '@stdlib/array/float64' );
108+
*
109+
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
110+
* var y = new Float64Array( [ 2.0, -2.0, 1.0 ] );
111+
*
112+
* var z = ns.dcorrelation( x.length, x, 1, y, 1 );
113+
* // returns ~0.115
114+
*
115+
* @example
116+
* var Float64Array = require( '@stdlib/array/float64' );
117+
*
118+
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
119+
* var y = new Float64Array( [ 2.0, -2.0, 1.0 ] );
120+
*
121+
* var z = ns.dcorrelation.ndarray( x.length, x, 1, 0, y, 1, 0 );
122+
* // returns ~0.115
123+
*/
124+
dcorrelation: typeof dcorrelation;
125+
95126
/**
96127
* Computes the cosine distance between two double-precision floating-point strided arrays.
97128
*

0 commit comments

Comments
 (0)