geo 0.33.0

Geospatial primitives and algorithms
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

use num_traits::FromPrimitive;

use crate::{CoordFloat, Length, Line, LineString, MultiLineString, Rhumb};

#[deprecated(
    since = "0.29.0",
    note = "Please use the `Rhumb.length(&line)` via the `Length` trait instead."
)]
/// Determine the length of a geometry assuming each segment is a [rhumb line].
///
/// [rhumb line]: https://en.wikipedia.org/wiki/Rhumb_line
///
/// *Note*: this implementation uses a mean earth radius of 6371.088 km, based on the [recommendation of
/// the IUGG](ftp://athena.fsv.cvut.cz/ZFG/grs80-Moritz.pdf)
pub trait RhumbLength<T, RHS = Self> {
    /// Determine the length of a geometry assuming each segment is a [rhumb line].
    ///
    /// # Units
    ///
    /// - return value: meters
    ///
    /// # Examples
    ///
    /// ```
    /// use geo::prelude::*;
    /// use geo::LineString;
    ///
    /// let linestring = LineString::<f64>::from(vec![
    ///     // New York City
    ///     (-74.006, 40.7128),
    ///     // London
    ///     (-0.1278, 51.5074),
    /// ]);
    ///
    /// let length = linestring.rhumb_length();
    ///
    /// assert_eq!(
    ///     5_794_129., // meters
    ///     length.round()
    /// );
    /// ```
    ///
    /// [rhumb line]: https://en.wikipedia.org/wiki/Rhumb_line
    fn rhumb_length(&self) -> T;
}

#[allow(deprecated)]
impl<T> RhumbLength<T> for Line<T>
where
    T: CoordFloat + FromPrimitive,
{
    fn rhumb_length(&self) -> T {
        Rhumb.length(self)
    }
}

#[allow(deprecated)]
impl<T> RhumbLength<T> for LineString<T>
where
    T: CoordFloat + FromPrimitive,
{
    fn rhumb_length(&self) -> T {
        Rhumb.length(self)
    }
}

#[allow(deprecated)]
impl<T> RhumbLength<T> for MultiLineString<T>
where
    T: CoordFloat + FromPrimitive,
{
    fn rhumb_length(&self) -> T {
        Rhumb.length(self)
    }
}