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
//! # Euclidian Metric Distance
//!
//! The Euclidean distance (L2) between two points \\( x \\) and \\( y \\) in n-space is defined as
//!
//! \\[ d(x, y) = \sqrt{\sum_{i=1}^n (x-y)^2} \\]
//!
//! Example:
//!
//! ```
//! use smartcore::math::distance::Distance;
//! use smartcore::math::distance::euclidian::Euclidian;
//!
//! let x = vec![1., 1.];
//! let y = vec![2., 2.];
//!
//! let l2: f64 = Euclidian{}.distance(&x, &y);
//! ```
//!
//! <script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
//! <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
use serde::{Deserialize, Serialize};

use crate::math::num::RealNumber;

use super::Distance;

/// Euclidean distance is a measure of the true straight line distance between two points in Euclidean n-space.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Euclidian {}

impl Euclidian {
    #[inline]
    pub(crate) fn squared_distance<T: RealNumber>(x: &[T], y: &[T]) -> T {
        if x.len() != y.len() {
            panic!("Input vector sizes are different.");
        }

        let mut sum = T::zero();
        for i in 0..x.len() {
            let d = x[i] - y[i];
            sum += d * d;
        }

        sum
    }
}

impl<T: RealNumber> Distance<Vec<T>, T> for Euclidian {
    fn distance(&self, x: &Vec<T>, y: &Vec<T>) -> T {
        Euclidian::squared_distance(x, y).sqrt()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn squared_distance() {
        let a = vec![1., 2., 3.];
        let b = vec![4., 5., 6.];

        let l2: f64 = Euclidian {}.distance(&a, &b);

        assert!((l2 - 5.19615242).abs() < 1e-8);
    }
}