use-geometry 0.0.6

Utility-first 2D geometry primitives for RustUse
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

//! Distance and interpolation helpers for 2D points.

use crate::point::Point2;

/// Returns the Euclidean distance between two 2D points.
///
/// # Examples
///
/// ```
/// use use_geometry::{Point2, distance_2d};
///
/// let left = Point2::new(0.0, 0.0);
/// let right = Point2::new(3.0, 4.0);
///
/// assert_eq!(distance_2d(left, right), 5.0);
/// ```
#[must_use]
pub fn distance_2d(left: Point2, right: Point2) -> f64 {
    left.distance_to(right)
}

/// Returns the squared Euclidean distance between two 2D points.
///
/// # Examples
///
/// ```
/// use use_geometry::{Point2, distance_squared_2d};
///
/// let left = Point2::new(0.0, 0.0);
/// let right = Point2::new(3.0, 4.0);
///
/// assert_eq!(distance_squared_2d(left, right), 25.0);
/// ```
#[must_use]
pub fn distance_squared_2d(left: Point2, right: Point2) -> f64 {
    left.distance_squared_to(right)
}

/// Returns the midpoint between two 2D points.
///
/// # Examples
///
/// ```
/// use use_geometry::{Point2, midpoint_2d};
///
/// let left = Point2::new(-2.0, 1.0);
/// let right = Point2::new(4.0, 5.0);
///
/// assert_eq!(midpoint_2d(left, right), Point2::new(1.0, 3.0));
/// ```
#[must_use]
pub const fn midpoint_2d(left: Point2, right: Point2) -> Point2 {
    left.midpoint(right)
}

#[cfg(test)]
mod tests {
    use super::{distance_2d, distance_squared_2d, midpoint_2d};
    use crate::point::Point2;

    fn approx_eq(left: f64, right: f64) -> bool {
        (left - right).abs() < 1.0e-10
    }

    #[test]
    fn computes_distance() {
        let left = Point2::new(0.0, 0.0);
        let right = Point2::new(3.0, 4.0);

        assert!(approx_eq(distance_2d(left, right), 5.0));
    }

    #[test]
    fn computes_squared_distance() {
        let left = Point2::new(-1.0, 2.0);
        let right = Point2::new(2.0, 6.0);

        assert!(approx_eq(distance_squared_2d(left, right), 25.0));
    }

    #[test]
    fn computes_midpoints() {
        let left = Point2::new(0.0, 0.0);
        let right = Point2::new(4.0, 2.0);

        assert_eq!(midpoint_2d(left, right), Point2::new(2.0, 1.0));
    }
}