tang 0.1.0

Math library for physical reality — geometry, spatial algebra, autodiff
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

use crate::{Scalar, Vec2};
use core::ops::{Add, AddAssign, Sub, SubAssign};

/// A point in 2D space (distinct from Vec2 — points have position, vectors have direction).
#[derive(Clone, Copy, Debug, PartialEq)]
#[repr(C)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Point2<S> {
    pub x: S,
    pub y: S,
}

impl<S: Scalar> Point2<S> {
    #[inline]
    pub fn new(x: S, y: S) -> Self {
        Self { x, y }
    }

    #[inline]
    pub fn origin() -> Self {
        Self::new(S::ZERO, S::ZERO)
    }

    #[inline]
    pub fn to_vec(self) -> Vec2<S> {
        Vec2::new(self.x, self.y)
    }

    #[inline]
    pub fn from_vec(v: Vec2<S>) -> Self {
        Self::new(v.x, v.y)
    }

    #[inline]
    pub fn distance(self, other: Self) -> S {
        (other - self).norm()
    }

    #[inline]
    pub fn distance_sq(self, other: Self) -> S {
        (other - self).norm_sq()
    }

    #[inline]
    pub fn lerp(self, other: Self, t: S) -> Self {
        Self::from_vec(self.to_vec().lerp(other.to_vec(), t))
    }

    #[inline]
    pub fn midpoint(self, other: Self) -> Self {
        self.lerp(other, S::HALF)
    }
}

impl<S: Scalar> Default for Point2<S> {
    fn default() -> Self {
        Self::origin()
    }
}

// Point - Point = Vec
impl<S: Scalar> Sub for Point2<S> {
    type Output = Vec2<S>;
    #[inline]
    fn sub(self, rhs: Self) -> Vec2<S> {
        Vec2::new(self.x - rhs.x, self.y - rhs.y)
    }
}

// Point + Vec = Point
impl<S: Scalar> Add<Vec2<S>> for Point2<S> {
    type Output = Self;
    #[inline]
    fn add(self, rhs: Vec2<S>) -> Self {
        Self::new(self.x + rhs.x, self.y + rhs.y)
    }
}

// Point - Vec = Point
impl<S: Scalar> Sub<Vec2<S>> for Point2<S> {
    type Output = Self;
    #[inline]
    fn sub(self, rhs: Vec2<S>) -> Self {
        Self::new(self.x - rhs.x, self.y - rhs.y)
    }
}

impl<S: Scalar> AddAssign<Vec2<S>> for Point2<S> {
    #[inline]
    fn add_assign(&mut self, rhs: Vec2<S>) {
        self.x += rhs.x;
        self.y += rhs.y;
    }
}

impl<S: Scalar> SubAssign<Vec2<S>> for Point2<S> {
    #[inline]
    fn sub_assign(&mut self, rhs: Vec2<S>) {
        self.x -= rhs.x;
        self.y -= rhs.y;
    }
}

// nalgebra compatibility: reference-based operators.
impl<S: Scalar> Sub for &Point2<S> {
    type Output = Vec2<S>;
    #[inline]
    fn sub(self, rhs: &Point2<S>) -> Vec2<S> {
        *self - *rhs
    }
}

impl<S: Scalar> Add<&Vec2<S>> for &Point2<S> {
    type Output = Point2<S>;
    #[inline]
    fn add(self, rhs: &Vec2<S>) -> Point2<S> {
        *self + *rhs
    }
}

impl<S: Scalar> Sub<&Vec2<S>> for &Point2<S> {
    type Output = Point2<S>;
    #[inline]
    fn sub(self, rhs: &Vec2<S>) -> Point2<S> {
        *self - *rhs
    }
}

// Mixed ref/value: &Point2 - Point2
impl<S: Scalar> Sub<Point2<S>> for &Point2<S> {
    type Output = Vec2<S>;
    #[inline]
    fn sub(self, rhs: Point2<S>) -> Vec2<S> {
        *self - rhs
    }
}

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

    #[test]
    fn distance() {
        let a = Point2::new(0.0, 0.0);
        let b = Point2::new(3.0, 4.0);
        assert!((a.distance(b) - 5.0).abs() < 1e-10);
    }

    #[test]
    fn midpoint() {
        let a = Point2::new(0.0, 0.0);
        let b = Point2::new(10.0, 20.0);
        assert_eq!(a.midpoint(b), Point2::new(5.0, 10.0));
    }

    #[test]
    fn point_vec_arithmetic() {
        let p = Point2::new(1.0, 2.0);
        let v = Vec2::new(10.0, 20.0);
        assert_eq!(p + v, Point2::new(11.0, 22.0));
        assert_eq!(p - v, Point2::new(-9.0, -18.0));
    }

    #[test]
    fn point_diff() {
        let a = Point2::new(1.0, 2.0);
        let b = Point2::new(4.0, 6.0);
        assert_eq!(b - a, Vec2::new(3.0, 4.0));
    }

    #[test]
    fn add_assign() {
        let mut p = Point2::new(1.0, 2.0);
        p += Vec2::new(10.0, 20.0);
        assert_eq!(p, Point2::new(11.0, 22.0));
    }
}