ml-distance 0.2.3

Distance-based methods for vector comparison and analysis. (Porting of the JS/TS pkg `ml-distance` to Rust)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# ML Distance

This Rust crate is based on the paper [Comprehensive Survey on Distance/Similarity Measures between Probability Density Functions](https://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) and implemented to port the [ml-distance](https://www.npmjs.com/package/ml-distance) pkg from js/ts to rust.

## Usage

Run the following Cargo command in your project directory:

```bash
cargo add ml-distance
```

Or add the following line to your Cargo.toml:

```toml
ml-distance = "0.2.1"
```

And then use it in your code like this:

> Note: The distances and similarities are implemented for all types that implement the `Into\<f64\>` trait. (e.g. `f64`, `i32`, `u32`, `i64`, ...)

```rust
use ml_distance::distance;

let p: [f64; 3] = [0.000, 1.700, 2.350];
let q: [f64; 3] = [0.300, 1.700, 1.001];

let dist = distance::euclidean(&p, &q);
assert_eq!(dist, 1.3819554985599212);
```

Or for similarityies

```rust
use ml_distance::similarity;

let p = vec![0, 1, 2, 1, 1, 3];
let q = vec![0, 1, 1, 5, 9, 3];

let dist = similarity::cosine(&p, &q);
assert_eq!(dist, 0.6009252125773316);
```

## Distances Implemented

| Name                   | Formula Link                                                                       | Status |
| ---------------------- | ---------------------------------------------------------------------------------- | ------ |
| euclidean              | [Link](http://en.wikipedia.org/wiki/Euclidean_distance#n_dimensions)               | ✅     |
| manhattan              | [Link](http://en.wikipedia.org/wiki/Taxicab_geometry)                              | ✅     |
| minkowski              | [Link](http://en.wikipedia.org/wiki/Minkowski_distance)                            | ✅     |
| chebyshev              | [Link](http://en.wikipedia.org/wiki/Chebyshev_distance)                            | ✅     |
| sorensen               | [Link](http://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient)        | ✅     |
| gower                  | [Link](https://stat.ethz.ch/education/semesters/ss2012/ams/slides/v4.2.pdf)        | ✅     |
| soergel                | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| kulczynski             | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| canberra               | [Link](http://en.wikipedia.org/wiki/Canberra_distance)                             | ✅     |
| lorentzian             | [Link](https://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                         | ✅     |
| intersection           | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| waveHedges             | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| czekanowski            | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| motyka                 | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| ruzicka                | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| tanimoto               | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| innerProduct           | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| harmonicMean           | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| kumarHassebrook        | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| jaccard                | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| dice                   | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| bhattacharyya          | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| hellinger              | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| matusita               | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| squaredChord           | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| squaredEuclidean       | [Link](http://en.wikipedia.org/wiki/Euclidean_distance#Squared_Euclidean_distance) | ✅     |
| pearson                | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| neyman                 | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| squared                | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| probabilisticSymmetric | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| divergence             | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | ✅     |
| clark                  | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| additiveSymmetric      | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| kullbackLeibler        | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| jeffreys               | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| kdivergence            | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| topsoe                 | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| jensenShannon          | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| jensenDifference       | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| taneja                 | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| kumarJohnson           | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |
| avg                    | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf)                          | 🔜     |

## Similarities Implemented

| Name         | Formula Link                                              | Status |
| ------------ | --------------------------------------------------------- | ------ |
| cosine       | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | ✅     |
| dice         | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | ✅     |
| fidelity     | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | ✅     |
| kulczynski   | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | ✅     |
| czekanowski  | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | 🔜     |
| intersection | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | 🔜     |
| jaccard      | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | 🔜     |
| motyka       | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | 🔜     |
| squaredChord | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | 🔜     |
| tanimoto     | [Link](http://www.naun.org/main/NAUN/ijmmas/mmmas-49.pdf) | 🔜     |