Struct geo_types::LineString

pub struct LineString<T>(pub Vec<Coordinate<T>>)
 where
    T: CoordNum;

An ordered collection of two or more Coordinates, representing a path between locations.

Semantics

A LineString is closed if it is empty, or if the first and last coordinates are the same. The boundary of a LineString is empty if closed, and otherwise the end points. The interior is the (infinite) set of all points along the linestring not including the boundary. A LineString is simple if it does not intersect except possibly at the first and last coordinates. A simple and closed LineString is a LinearRing as defined in the OGC-SFA (but is not a separate type here).

Validity

A LineString is valid if it is either empty or contains 2 or more coordinates. Further, a closed LineString must not self intersect. Note that the validity is not enforced, and the operations and predicates are undefined on invalid linestrings.

Examples

Create a LineString by calling it directly:

use geo_types::{Coordinate, LineString};

let line_string = LineString(vec![
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 10., y: 0. },
]);

Create a LineString with the line_string! macro:

use geo_types::line_string;

let line_string = line_string![
    (x: 0., y: 0.),
    (x: 10., y: 0.),
];

Converting a Vec of Coordinate-like things:

use geo_types::LineString;

let line_string: LineString<f32> = vec![(0., 0.), (10., 0.)].into();

use geo_types::LineString;

let line_string: LineString<f64> = vec![[0., 0.], [10., 0.]].into();

Or collecting from a Coordinate iterator

use geo_types::{Coordinate, LineString};

let mut coords_iter =
    vec![Coordinate { x: 0., y: 0. }, Coordinate { x: 10., y: 0. }].into_iter();

let line_string: LineString<f32> = coords_iter.collect();

You can iterate over the coordinates in the LineString:

use geo_types::{Coordinate, LineString};

let line_string = LineString(vec![
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 10., y: 0. },
]);

for coord in line_string {
    println!("Coordinate x = {}, y = {}", coord.x, coord.y);
}

You can also iterate over the coordinates in the LineString as Points:

use geo_types::{Coordinate, LineString};

let line_string = LineString(vec![
    Coordinate { x: 0., y: 0. },
    Coordinate { x: 10., y: 0. },
]);

for point in line_string.points_iter() {
    println!("Point x = {}, y = {}", point.x(), point.y());
}

Tuple Fields

0: Vec<Coordinate<T>>

Implementations

impl<T: CoordNum> LineString<T>

pub fn points_iter(&self) -> PointsIter<'_, T>

Return an iterator yielding the coordinates of a LineString as Points

pub fn into_points(self) -> Vec<Point<T>>

Return the coordinates of a LineString as a Vec of Points

pub fn lines(&self) -> impl ExactSizeIterator + Iterator<Item = Line<T>> + '_

Return an iterator yielding one Line for each line segment in the LineString.

Examples

use geo_types::{Coordinate, Line, LineString};

let mut coords = vec![(0., 0.), (5., 0.), (7., 9.)];
let line_string: LineString<f32> = coords.into_iter().collect();

let mut lines = line_string.lines();
assert_eq!(
    Some(Line::new(
        Coordinate { x: 0., y: 0. },
        Coordinate { x: 5., y: 0. }
    )),
    lines.next()
);
assert_eq!(
    Some(Line::new(
        Coordinate { x: 5., y: 0. },
        Coordinate { x: 7., y: 9. }
    )),
    lines.next()
);
assert!(lines.next().is_none());

pub fn triangles(
    &self
) -> impl ExactSizeIterator + Iterator<Item = Triangle<T>> + '_

An iterator which yields the coordinates of a LineString as Triangles

pub fn close(&mut self)

Close the LineString. Specifically, if the LineString has at least one coordinate, and the value of the first coordinate does not equal the value of the last coordinate, then a new coordinate is added to the end with the value of the first coordinate.

pub fn num_coords(&self) -> usize

👎 Deprecated:

Use geo::algorithm::coords_iter::CoordsIter::coords_count instead

Return the number of coordinates in the LineString.

Examples

use geo_types::LineString;

let mut coords = vec![(0., 0.), (5., 0.), (7., 9.)];
let line_string: LineString<f32> = coords.into_iter().collect();
assert_eq!(3, line_string.num_coords());

pub fn is_closed(&self) -> bool

Checks if the linestring is closed; i.e. it is either empty or, the first and last points are the same.

Examples

use geo_types::LineString;

let mut coords = vec![(0., 0.), (5., 0.), (0., 0.)];
let line_string: LineString<f32> = coords.into_iter().collect();
assert!(line_string.is_closed());

Note that we diverge from some libraries (JTS et al), which have a LinearRing type, separate from LineString. Those libraries treat an empty LinearRing as closed, by definition, while treating an empty LineString as open. Since we don’t have a separate LinearRing type, and use a LineString in its place, we adopt the JTS LinearRing is_closed behavior in all places, that is, we consider an empty LineString as closed.

This is expected when used in the context of a Polygon.exterior and elswhere; And there seems to be no reason to maintain the separate behavior for LineStrings used in non-LinearRing contexts.

Trait Implementations

impl<T: AbsDiffEq<Epsilon = T> + CoordNum> AbsDiffEq<LineString<T>> for LineString<T>

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::LineString;

let mut coords_a = vec![(0., 0.), (5., 0.), (7., 9.)];
let a: LineString<f32> = coords_a.into_iter().collect();

let mut coords_b = vec![(0., 0.), (5., 0.), (7.001, 9.)];
let b: LineString<f32> = coords_b.into_iter().collect();

approx::assert_relative_eq!(a, b, epsilon=0.1)

type Epsilon = T

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T: Clone> Clone for LineString<T> where
    T: CoordNum, 

fn clone(&self) -> LineString<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for LineString<T> where
    T: CoordNum, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: CoordNum> From<Line<T>> for LineString<T>

fn from(line: Line<T>) -> Self

Performs the conversion.

impl<T: CoordNum> From<LineString<T>> for Geometry<T>

fn from(x: LineString<T>) -> Geometry<T>

Performs the conversion.

impl<T: CoordNum, IC: Into<Coordinate<T>>> From<Vec<IC, Global>> for LineString<T>

Turn a Vec of Point-like objects into a LineString.

fn from(v: Vec<IC>) -> Self

Performs the conversion.

impl<T: CoordNum, IC: Into<Coordinate<T>>> FromIterator<IC> for LineString<T>

Turn an iterator of Point-like objects into a LineString.

fn from_iter<I: IntoIterator<Item = IC>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash> Hash for LineString<T> where
    T: CoordNum, 

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: CoordNum> Index<usize> for LineString<T>

type Output = Coordinate<T>

The returned type after indexing.

fn index(&self, index: usize) -> &Coordinate<T>

Performs the indexing (container[index]) operation.

impl<T: CoordNum> IndexMut<usize> for LineString<T>

fn index_mut(&mut self, index: usize) -> &mut Coordinate<T>

Performs the mutable indexing (container[index]) operation.

impl<T: CoordNum> IntoIterator for LineString<T>

Iterate over all the Coordinates in this LineString.

type Item = Coordinate<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Coordinate<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: CoordNum> IntoIterator for &'a mut LineString<T>

Mutably iterate over all the Coordinates in this LineString.

type Item = &'a mut Coordinate<T>

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Coordinate<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, Coordinate<T>>

Creates an iterator from a value.

impl<T: PartialEq> PartialEq<LineString<T>> for LineString<T> where
    T: CoordNum, 

fn eq(&self, other: &LineString<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LineString<T>) -> bool

This method tests for !=.

impl<T> PointDistance for LineString<T> where
    T: Float + RTreeNum, 

fn distance_2(&self, point: &Point<T>) -> T

Returns the squared euclidean distance of an object to a point.

fn contains_point(&self, point: &<Self::Envelope as Envelope>::Point) -> bool

Returns true if a point is contained within this object.

fn distance_2_if_less_or_equal(
    &self,
    point: &<Self::Envelope as Envelope>::Point,
    max_distance_2: <<Self::Envelope as Envelope>::Point as Point>::Scalar
) -> Option<<<Self::Envelope as Envelope>::Point as Point>::Scalar>

Returns the squared distance to this object or None if the distance is larger than a given maximum value.

impl<T> RTreeObject for LineString<T> where
    T: Float + RTreeNum, 

type Envelope = AABB<Point<T>>

The object’s envelope type. Usually, AABB will be the right choice. This type also defines the objects dimensionality.

fn envelope(&self) -> Self::Envelope

Returns the object’s envelope.

impl<T> RelativeEq<LineString<T>> for LineString<T> where
    T: AbsDiffEq<Epsilon = T> + CoordNum + RelativeEq, 

fn relative_eq(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

Equality assertion within a relative limit.

Examples

use geo_types::LineString;

let mut coords_a = vec![(0., 0.), (5., 0.), (7., 9.)];
let a: LineString<f32> = coords_a.into_iter().collect();

let mut coords_b = vec![(0., 0.), (5., 0.), (7.001, 9.)];
let b: LineString<f32> = coords_b.into_iter().collect();

approx::assert_relative_eq!(a, b, max_relative=0.1)

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of RelativeEq::relative_eq.

impl<T: CoordNum> TryFrom<Geometry<T>> for LineString<T>

Convert a Geometry enum into its inner type.

Fails if the enum case does not match the type you are trying to convert it to.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(geom: Geometry<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Eq> Eq for LineString<T> where
    T: CoordNum, 

impl<T> StructuralEq for LineString<T> where
    T: CoordNum, 

impl<T> StructuralPartialEq for LineString<T> where
    T: CoordNum,