acap 0.4.0

As Close As Possible — nearest neighbor search in 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

//! [Chebyshev distance](https://en.wikipedia.org/wiki/Chebyshev_distance).

use crate::coords::Coordinates;
use crate::distance::{Metric, Proximity};
use crate::lp::Minkowski;

use num_traits::{zero, Signed};

/// A point in Chebyshev space.
///
/// This wrapper equips any [coordinate space] with the [Chebyshev distance] metric.
///
/// [coordinate space]: Coordinates
/// [Chebyshev distance]: chebyshev_distance
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct Chebyshev<T>(pub T);

impl<T> Chebyshev<T> {
    /// Wrap a point.
    pub fn new(point: T) -> Self {
        Self(point)
    }

    /// Unwrap a point.
    pub fn inner(&self) -> &T {
        &self.0
    }

    /// Unwrap a point.
    pub fn into_inner(self) -> T {
        self.0
    }
}

impl<T: Coordinates> Coordinates for Chebyshev<T> {
    type Value = T::Value;

    fn dims(&self) -> usize {
        self.0.dims()
    }

    fn coord(&self, i: usize) -> Self::Value {
        self.0.coord(i)
    }
}

/// Compute the [Chebyshev distance] between two points.
///
/// ```math
/// \begin{aligned}
/// \mathrm{chebyshev\_distance}(x, y) &= \|x - y\|_\infty \\
/// &= \max_i |x_i - y_i|
/// \end{aligned}
/// ```
///
/// [Chebyshev distance]: https://en.wikipedia.org/wiki/Chebyshev_distance
pub fn chebyshev_distance<T, U>(x: T, y: U) -> T::Value
where
    T: Coordinates,
    U: Coordinates<Value = T::Value>,
{
    debug_assert!(x.dims() == y.dims());

    let mut max = zero();

    for i in 0..x.dims() {
        let diff = (x.coord(i) - y.coord(i)).abs();
        if diff > max {
            max = diff;
        }
    }

    max
}

/// The Chebyshev distance function.
impl<T: Coordinates> Proximity for Chebyshev<T> {
    type Distance = T::Value;

    fn distance(&self, other: &Self) -> Self::Distance {
        chebyshev_distance(self, other)
    }
}

impl<T: Coordinates> Proximity<T> for Chebyshev<T> {
    type Distance = T::Value;

    fn distance(&self, other: &T) -> Self::Distance {
        chebyshev_distance(self, other)
    }
}

impl<T: Coordinates> Proximity<Chebyshev<T>> for T {
    type Distance = T::Value;

    fn distance(&self, other: &Chebyshev<T>) -> Self::Distance {
        chebyshev_distance(self, other)
    }
}

/// Chebyshev distance is a metric.
impl<T: Coordinates> Metric for Chebyshev<T> {}

impl<T: Coordinates> Metric<T> for Chebyshev<T> {}

impl<T: Coordinates> Metric<Chebyshev<T>> for T {}

/// Chebyshev distance is a [Minkowski] distance.
impl<T: Coordinates> Minkowski for Chebyshev<T> {}

impl<T: Coordinates> Minkowski<T> for Chebyshev<T> {}

impl<T: Coordinates> Minkowski<Chebyshev<T>> for T {}

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

    #[test]
    fn test_distance() {
        assert_eq!(chebyshev_distance(&[-3, 4], &[4, -3]), 7);

        assert_eq!(Chebyshev([-3, 4]).distance(&Chebyshev([4, -3])), 7);
        assert_eq!(Chebyshev([-3, 4]).distance(&[4, -3]), 7);
        assert_eq!([-3, 4].distance(&Chebyshev([4, -3])), 7);
    }
}