|
20 | 20 |
|
21 | 21 | /* eslint-disable max-lines */ |
22 | 22 |
|
| 23 | +import dchebychev = require( '@stdlib/stats/strided/distances/dchebychev' ); |
23 | 24 | import dcityblock = require( '@stdlib/stats/strided/distances/dcityblock' ); |
| 25 | +import dcosineDistance = require( '@stdlib/stats/strided/distances/dcosine-distance' ); |
| 26 | +import dcosineSimilarity = require( '@stdlib/stats/strided/distances/dcosine-similarity' ); |
| 27 | +import deuclidean = require( '@stdlib/stats/strided/distances/deuclidean' ); |
| 28 | +import dsquaredEuclidean = require( '@stdlib/stats/strided/distances/dsquared-euclidean' ); |
24 | 29 |
|
25 | 30 | /** |
26 | | -* Interface describing a namespace. |
| 31 | +* Interface describing the `distances` namespace. |
27 | 32 | */ |
28 | 33 | interface Namespace { |
29 | 34 | /** |
30 | | - * TODO |
| 35 | + * Computes the Chebychev distance between two double-precision floating-point strided arrays. |
| 36 | + * |
| 37 | + * @param N - number of indexed elements |
| 38 | + * @param x - first input array |
| 39 | + * @param strideX - `x` stride length |
| 40 | + * @param y - second input array |
| 41 | + * @param strideY - `y` stride length |
| 42 | + * @returns Chebychev distance |
| 43 | + * |
| 44 | + * @example |
| 45 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 46 | + * |
| 47 | + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); |
| 48 | + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); |
| 49 | + * |
| 50 | + * var z = ns.dchebychev( x.length, x, 1, y, 1 ); |
| 51 | + * // returns 9.0 |
| 52 | + * |
| 53 | + * @example |
| 54 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 55 | + * |
| 56 | + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); |
| 57 | + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); |
| 58 | + * |
| 59 | + * var z = ns.dchebychev.ndarray( x.length, x, 1, 0, y, 1, 0 ); |
| 60 | + * // returns 9.0 |
| 61 | + */ |
| 62 | + dchebychev: typeof dchebychev; |
| 63 | + |
| 64 | + /** |
| 65 | + * Computes the city block (Manhattan) distance between two double-precision floating-point strided arrays. |
| 66 | + * |
| 67 | + * @param N - number of indexed elements |
| 68 | + * @param x - first input array |
| 69 | + * @param strideX - `x` stride length |
| 70 | + * @param y - second input array |
| 71 | + * @param strideY - `y` stride length |
| 72 | + * @returns city block (Manhattan) distance |
| 73 | + * |
| 74 | + * @example |
| 75 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 76 | + * |
| 77 | + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); |
| 78 | + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); |
| 79 | + * |
| 80 | + * var z = ns.dcityblock( x.length, x, 1, y, 1 ); |
| 81 | + * // returns 26.0 |
| 82 | + * |
| 83 | + * @example |
| 84 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 85 | + * |
| 86 | + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); |
| 87 | + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); |
| 88 | + * |
| 89 | + * var z = ns.dcityblock.ndarray( x.length, x, 1, 0, y, 1, 0 ); |
| 90 | + * // returns 26.0 |
31 | 91 | */ |
32 | 92 | dcityblock: typeof dcityblock; |
| 93 | + |
| 94 | + /** |
| 95 | + * Computes the cosine distance between two double-precision floating-point strided arrays. |
| 96 | + * |
| 97 | + * @param N - number of indexed elements |
| 98 | + * @param x - first input array |
| 99 | + * @param strideX - `x` stride length |
| 100 | + * @param y - second input array |
| 101 | + * @param strideY - `y` stride length |
| 102 | + * @returns cosine distance |
| 103 | + * |
| 104 | + * @example |
| 105 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 106 | + * |
| 107 | + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); |
| 108 | + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); |
| 109 | + * |
| 110 | + * var z = ns.dcosineDistance( x.length, x, 1, y, 1 ); |
| 111 | + * // returns ~1.061 |
| 112 | + * |
| 113 | + * @example |
| 114 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 115 | + * |
| 116 | + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); |
| 117 | + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); |
| 118 | + * |
| 119 | + * var z = ns.dcosineDistance.ndarray( x.length, x, 1, 0, y, 1, 0 ); |
| 120 | + * // returns ~1.061 |
| 121 | + */ |
| 122 | + dcosineDistance: typeof dcosineDistance; |
| 123 | + |
| 124 | + /** |
| 125 | + * Computes the cosine similarity of two double-precision floating-point strided arrays. |
| 126 | + * |
| 127 | + * @param N - number of indexed elements |
| 128 | + * @param x - first input array |
| 129 | + * @param strideX - `x` stride length |
| 130 | + * @param y - second input array |
| 131 | + * @param strideY - `y` stride length |
| 132 | + * @returns cosine similarity |
| 133 | + * |
| 134 | + * @example |
| 135 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 136 | + * |
| 137 | + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); |
| 138 | + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); |
| 139 | + * |
| 140 | + * var z = ns.dcosineSimilarity( x.length, x, 1, y, 1 ); |
| 141 | + * // returns ~-0.061 |
| 142 | + * |
| 143 | + * @example |
| 144 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 145 | + * |
| 146 | + * var x = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); |
| 147 | + * var y = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); |
| 148 | + * |
| 149 | + * var z = ns.dcosineSimilarity.ndarray( x.length, x, 1, 0, y, 1, 0 ); |
| 150 | + * // returns ~-0.061 |
| 151 | + */ |
| 152 | + dcosineSimilarity: typeof dcosineSimilarity; |
| 153 | + |
| 154 | + /** |
| 155 | + * Computes the Euclidean distance between two double-precision floating-point strided arrays. |
| 156 | + * |
| 157 | + * @param N - number of indexed elements |
| 158 | + * @param x - first input array |
| 159 | + * @param strideX - `x` stride length |
| 160 | + * @param y - second input array |
| 161 | + * @param strideY - `y` stride length |
| 162 | + * @returns Euclidean distance |
| 163 | + * |
| 164 | + * @example |
| 165 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 166 | + * |
| 167 | + * var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); |
| 168 | + * var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); |
| 169 | + * |
| 170 | + * var z = ns.deuclidean( x.length, x, 1, y, 1 ); |
| 171 | + * // returns ~8.485 |
| 172 | + * |
| 173 | + * @example |
| 174 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 175 | + * |
| 176 | + * var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); |
| 177 | + * var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); |
| 178 | + * |
| 179 | + * var z = ns.deuclidean.ndarray( x.length, x, 1, 0, y, 1, 0 ); |
| 180 | + * // returns ~8.485 |
| 181 | + */ |
| 182 | + deuclidean: typeof deuclidean; |
| 183 | + |
| 184 | + /** |
| 185 | + * Computes the squared Euclidean distance between two double-precision floating-point strided arrays. |
| 186 | + * |
| 187 | + * @param N - number of indexed elements |
| 188 | + * @param x - first input array |
| 189 | + * @param strideX - `x` stride length |
| 190 | + * @param y - second input array |
| 191 | + * @param strideY - `y` stride length |
| 192 | + * @returns squared Euclidean distance |
| 193 | + * |
| 194 | + * @example |
| 195 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 196 | + * |
| 197 | + * var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); |
| 198 | + * var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); |
| 199 | + * |
| 200 | + * var z = ns.dsquaredEuclidean( x.length, x, 1, y, 1 ); |
| 201 | + * // returns 72.0 |
| 202 | + * |
| 203 | + * @example |
| 204 | + * var Float64Array = require( '@stdlib/array/float64' ); |
| 205 | + * |
| 206 | + * var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); |
| 207 | + * var y = new Float64Array( [ 2.0, 1.0, 2.0, 1.0, -2.0, 2.0, 3.0, 4.0 ] ); |
| 208 | + * |
| 209 | + * var z = ns.dsquaredEuclidean.ndarray( x.length, x, 1, 0, y, 1, 0 ); |
| 210 | + * // returns 72.0 |
| 211 | + */ |
| 212 | + dsquaredEuclidean: typeof dsquaredEuclidean; |
33 | 213 | } |
34 | 214 |
|
35 | 215 | /** |
|
0 commit comments