Merge #812

812: Inline coords to boost perf improvements r=michaelkirk a=nyurik * Inline all simple coordinate methods * use `new()` method in some macros # Performance improvements test | improvement ---|--- concave hull f32 | -1.8840% point outside polygon | -4.9574% Polygon Euclidean distance rotating calipers f64 | -1.6313% simplify vwp f32 | -7.0465% the rest were statistically unchanged - [x] I agree to follow the project's [code of conduct](https://github.com/georust/geo/blob/main/CODE_OF_CONDUCT.md). - ~[ ] I added an entry to `CHANGES.md` if knowledge of this change could be valuable to users.~ --- Co-authored-by: Yuri Astrakhan <[email protected]>
georust · Apr 23, 2022 · 68f6e84 · 68f6e84
2 parents 84af61f + fa11f57
commit 68f6e84
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/geo-types/src/coordinate.rs b/geo-types/src/coordinate.rs
@@ -31,6 +31,7 @@ pub struct Coordinate<T: CoordNum> {
 }
 
 impl<T: CoordNum> From<(T, T)> for Coordinate<T> {
+    #[inline]
     fn from(coords: (T, T)) -> Self {
         coord! {
             x: coords.0,
@@ -40,6 +41,7 @@ impl<T: CoordNum> From<(T, T)> for Coordinate<T> {
 }
 
 impl<T: CoordNum> From<[T; 2]> for Coordinate<T> {
+    #[inline]
     fn from(coords: [T; 2]) -> Self {
         coord! {
             x: coords[0],
@@ -49,6 +51,7 @@ impl<T: CoordNum> From<[T; 2]> for Coordinate<T> {
 }
 
 impl<T: CoordNum> From<Point<T>> for Coordinate<T> {
+    #[inline]
     fn from(point: Point<T>) -> Self {
         coord! {
             x: point.x(),
@@ -58,12 +61,14 @@ impl<T: CoordNum> From<Point<T>> for Coordinate<T> {
 }
 
 impl<T: CoordNum> From<Coordinate<T>> for (T, T) {
+    #[inline]
     fn from(coord: Coordinate<T>) -> Self {
         (coord.x, coord.y)
     }
 }
 
 impl<T: CoordNum> From<Coordinate<T>> for [T; 2] {
+    #[inline]
     fn from(coord: Coordinate<T>) -> Self {
         [coord.x, coord.y]
     }
@@ -86,6 +91,7 @@ impl<T: CoordNum> Coordinate<T> {
     /// assert_eq!(y, 116.34);
     /// assert_eq!(x, 40.02f64);
     /// ```
+    #[inline]
     pub fn x_y(&self) -> (T, T) {
         (self.x, self.y)
     }
@@ -112,6 +118,7 @@ where
 {
     type Output = Self;
 
+    #[inline]
     fn neg(self) -> Self {
         coord! {
             x: -self.x,
@@ -137,6 +144,7 @@ where
 impl<T: CoordNum> Add for Coordinate<T> {
     type Output = Self;
 
+    #[inline]
     fn add(self, rhs: Self) -> Self {
         coord! {
             x: self.x + rhs.x,
@@ -162,6 +170,7 @@ impl<T: CoordNum> Add for Coordinate<T> {
 impl<T: CoordNum> Sub for Coordinate<T> {
     type Output = Self;
 
+    #[inline]
     fn sub(self, rhs: Self) -> Self {
         coord! {
             x: self.x - rhs.x,
@@ -186,6 +195,7 @@ impl<T: CoordNum> Sub for Coordinate<T> {
 impl<T: CoordNum> Mul<T> for Coordinate<T> {
     type Output = Self;
 
+    #[inline]
     fn mul(self, rhs: T) -> Self {
         coord! {
             x: self.x * rhs,
@@ -210,6 +220,7 @@ impl<T: CoordNum> Mul<T> for Coordinate<T> {
 impl<T: CoordNum> Div<T> for Coordinate<T> {
     type Output = Self;
 
+    #[inline]
     fn div(self, rhs: T) -> Self {
         coord! {
             x: self.x / rhs,
@@ -233,6 +244,7 @@ use num_traits::Zero;
 /// assert_eq!(p.y, 0.);
 /// ```
 impl<T: CoordNum> Coordinate<T> {
+    #[inline]
     pub fn zero() -> Self {
         coord! {
             x: T::zero(),
@@ -242,9 +254,11 @@ impl<T: CoordNum> Coordinate<T> {
 }
 
 impl<T: CoordNum> Zero for Coordinate<T> {
+    #[inline]
     fn zero() -> Self {
         Self::zero()
     }
+    #[inline]
     fn is_zero(&self) -> bool {
         self.x.is_zero() && self.y.is_zero()
     }
@@ -290,10 +304,12 @@ impl<T: CoordNum + UlpsEq> UlpsEq for Coordinate<T>
 where
     T::Epsilon: Copy,
 {
+    #[inline]
     fn default_max_ulps() -> u32 {
         T::default_max_ulps()
     }
 
+    #[inline]
     fn ulps_eq(&self, other: &Self, epsilon: T::Epsilon, max_ulps: u32) -> bool {
         T::ulps_eq(&self.x, &other.x, epsilon, max_ulps)
             && T::ulps_eq(&self.y, &other.y, epsilon, max_ulps)
@@ -309,13 +325,15 @@ where
 
     const DIMENSIONS: usize = 2;
 
+    #[inline]
     fn generate(generator: impl Fn(usize) -> Self::Scalar) -> Self {
         coord! {
             x: generator(0),
             y: generator(1),
         }
     }
 
+    #[inline]
     fn nth(&self, index: usize) -> Self::Scalar {
         match index {
             0 => self.x,
@@ -324,6 +342,7 @@ where
         }
     }
 
+    #[inline]
     fn nth_mut(&mut self, index: usize) -> &mut Self::Scalar {
         match index {
             0 => &mut self.x,
@@ -342,13 +361,15 @@ where
 
     const DIMENSIONS: usize = 2;
 
+    #[inline]
     fn generate(mut generator: impl FnMut(usize) -> Self::Scalar) -> Self {
         coord! {
             x: generator(0),
             y: generator(1),
         }
     }
 
+    #[inline]
     fn nth(&self, index: usize) -> Self::Scalar {
         match index {
             0 => self.x,
@@ -357,6 +378,7 @@ where
         }
     }
 
+    #[inline]
     fn nth_mut(&mut self, index: usize) -> &mut Self::Scalar {
         match index {
             0 => &mut self.x,

diff --git a/geo-types/src/macros.rs b/geo-types/src/macros.rs
@@ -55,7 +55,7 @@ macro_rules! point {
 /// [`Coordinate`]: ./struct.Point.html
 #[macro_export]
 macro_rules! coord {
-    (x: $x:expr, y: $y:expr $(,)?) => {
+    (x: $x:expr, y: $y:expr $(,)* ) => {
         $crate::Coordinate { x: $x, y: $y }
     };
 }
@@ -123,7 +123,7 @@ macro_rules! coord {
 /// [`LineString`]: ./line_string/struct.LineString.html
 #[macro_export]
 macro_rules! line_string {
-    () => { $crate::LineString(vec![]) };
+    () => { $crate::LineString::new(vec![]) };
     (
         $(( $($tag:tt : $val:expr),* $(,)? )),*
         $(,)?
@@ -138,7 +138,7 @@ macro_rules! line_string {
         $($coord:expr),*
         $(,)?
     ) => {
-        $crate::LineString(
+        $crate::LineString::new(
             <[_]>::into_vec(
                 ::std::boxed::Box::new(
                     [$($coord), *]
@@ -296,7 +296,7 @@ macro_rules! polygon {
 mod test {
     #[test]
     fn test_point() {
-        let p = point!(x: 1.2, y: 3.4);
+        let p = point! { x: 1.2, y: 3.4 };
         assert_eq!(p.x(), 1.2);
         assert_eq!(p.y(), 3.4);