use-polyline 0.0.6

Polyline primitives for the RustUse geometry workspace
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

use use_distance::distance_2d;
use use_point::Point2;

/// An ordered 2D polyline.
#[derive(Debug, Clone, PartialEq)]
pub struct Polyline2 {
    vertices: Vec<Point2>,
}

impl Polyline2 {
    /// Creates a polyline from ordered vertices.
    #[must_use]
    pub const fn new(vertices: Vec<Point2>) -> Self {
        Self { vertices }
    }

    /// Returns the vertices.
    #[must_use]
    pub fn vertices(&self) -> &[Point2] {
        &self.vertices
    }

    /// Returns the number of vertices.
    #[must_use]
    pub fn len(&self) -> usize {
        self.vertices.len()
    }

    /// Returns `true` when there are no vertices.
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.vertices.is_empty()
    }

    /// Returns the total segment length.
    #[must_use]
    pub fn length(&self) -> f64 {
        self.vertices
            .windows(2)
            .map(|pair| distance_2d(pair[0], pair[1]))
            .sum()
    }
}

#[cfg(test)]
mod tests {
    use super::Polyline2;
    use use_point::Point2;

    #[test]
    fn computes_polyline_lengths() {
        let polyline = Polyline2::new(vec![Point2::new(0.0, 0.0), Point2::new(3.0, 4.0)]);

        assert_eq!(polyline.len(), 2);
        assert!(!polyline.is_empty());
        assert_eq!(polyline.length(), 5.0);
    }
}