Struct geo::geometry::LineString

pub struct LineString<T = f64>(pub Vec<Coord<T>, Global>)
where
    T: CoordNum;

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

Semantics

1. A LineString is closed if it is empty, or if the first and last coordinates are the same.
2. The boundary of a LineString is either:
   • empty if it is closed (see 1) or
   • contains the start and end coordinates.
3. The interior is the (infinite) set of all coordinates along the LineString, not including the boundary.
4. A LineString is simple if it does not intersect except optionally at the first and last coordinates (in which case it is also closed, see 1).
5. A simple and closed LineString is a LinearRing as defined in the OGC-SFA (but is not defined as a separate type in this crate).

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 its validity is not enforced, and operations and predicates are undefined on invalid LineStrings.

Examples

Creation

Create a LineString by calling it directly:

use geo_types::{coord, LineString};

let line_string = LineString::new(vec![
    coord! { x: 0., y: 0. },
    coord! { 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.),
];

By converting from 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 = vec![[0., 0.], [10., 0.]].into();

Or by collecting from a Coord iterator

use geo_types::{coord, LineString};

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

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

Iteration

LineString provides five iterators: coords, coords_mut, points, lines, and triangles:

use geo_types::{coord, LineString};

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

line_string.coords().for_each(|coord| println!("{:?}", coord));

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

Note that its IntoIterator impl yields Coords when looping:

use geo_types::{coord, LineString};

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

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

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

Decomposition

You can decompose a LineString into a Vec of Coords or Points:

use geo_types::{coord, LineString, Point};

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

let coordinate_vec = line_string.clone().into_inner();
let point_vec = line_string.clone().into_points();

Tuple Fields

0: Vec<Coord<T>, Global>

Implementations

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

pub fn new(value: Vec<Coord<T>, Global>) -> LineString<T>

Instantiate Self from the raw content value

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

👎Deprecated: Use points() instead

Return an iterator yielding the coordinates of a LineString as Points

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

Return an iterator yielding the coordinates of a LineString as Points

pub fn coords(&self) -> impl Iterator<Item = &Coord<T>>

Return an iterator yielding the members of a LineString as Coords

pub fn coords_mut(&mut self) -> impl Iterator<Item = &mut Coord<T>>

Return an iterator yielding the coordinates of a LineString as mutable Coords

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

Return the coordinates of a LineString as a Vec of Points

pub fn into_inner(self) -> Vec<Coord<T>, Global>

Return the coordinates of a LineString as a Vec of Coords

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::{coord, 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(
        coord! { x: 0., y: 0. },
        coord! { x: 5., y: 0. }
    )),
    lines.next()
);
assert_eq!(
    Some(Line::new(
        coord! { x: 5., y: 0. },
        coord! { 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 Coord, and the value of the first Coord does not equal the value of the last Coord, then a new Coord is added to the end with the value of the first Coord.

pub fn num_coords(&self) -> usize

👎Deprecated: Use geo::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 elsewhere; And there seems to be no reason to maintain the separate behavior for LineStrings used in non-LinearRing contexts.

Trait Implementations

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

fn abs_diff_eq(
    &self,
    other: &LineString<T>,
    epsilon: <LineString<T> as AbsDiffEq<LineString<T>>>::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() -> <LineString<T> as AbsDiffEq<LineString<T>>>::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> Area<T> for LineString<T>where
    T: CoordNum,

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

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

fn bounding_rect(&self) -> Self::Output

Return the BoundingRect for a LineString

type Output = Option<Rect<T>>

impl<T> Centroid for LineString<T>where
    T: GeoFloat,

type Output = Option<Point<T>>

fn centroid(&self) -> Self::Output

See: https://en.wikipedia.org/wiki/Centroid

impl<T> ChaikinSmoothing<T> for LineString<T>where
    T: CoordFloat + FromPrimitive,

fn chaikin_smoothing(&self, n_iterations: usize) -> Self

create a new geometry with the Chaikin smoothing being applied n_iterations times.

impl<T> ChamberlainDuquetteArea<T> for LineString<T>where
    T: CoordFloat,

fn chamberlain_duquette_signed_area(&self) -> T

fn chamberlain_duquette_unsigned_area(&self) -> T

impl<T> Clone for LineString<T>where
    T: Clone + 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<F: GeoFloat> ClosestPoint<F, Point<F>> for LineString<F>

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<T> ConcaveHull for LineString<T>where
    T: GeoFloat + RTreeNum,

type Scalar = T

fn concave_hull(&self, concavity: Self::Scalar) -> Polygon<Self::Scalar>

impl<T> Contains<Coord<T>> for LineString<T>where
    T: GeoNum,

fn contains(&self, coord: &Coord<T>) -> bool

impl<T> Contains<Geometry<T>> for LineString<T>where
    T: GeoFloat,

fn contains(&self, geometry: &Geometry<T>) -> bool

impl<T> Contains<GeometryCollection<T>> for LineString<T>where
    T: GeoFloat,

fn contains(&self, target: &GeometryCollection<T>) -> bool

impl<T> Contains<Line<T>> for LineString<T>where
    T: GeoNum,

fn contains(&self, line: &Line<T>) -> bool

impl<F> Contains<LineString<F>> for MultiPolygon<F>where
    F: GeoFloat,

fn contains(&self, rhs: &LineString<F>) -> bool

impl<T> Contains<LineString<T>> for Geometry<T>where
    T: GeoFloat,

fn contains(&self, line_string: &LineString<T>) -> bool

impl<T> Contains<LineString<T>> for GeometryCollection<T>where
    T: GeoFloat,

fn contains(&self, target: &LineString<T>) -> bool

impl<T> Contains<LineString<T>> for Line<T>where
    T: GeoNum,

fn contains(&self, linestring: &LineString<T>) -> bool

impl<T> Contains<LineString<T>> for LineString<T>where
    T: GeoNum,

fn contains(&self, rhs: &LineString<T>) -> bool

impl<T> Contains<LineString<T>> for MultiLineString<T>where
    T: GeoFloat,

fn contains(&self, target: &LineString<T>) -> bool

impl<T> Contains<LineString<T>> for MultiPoint<T>where
    T: GeoFloat,

fn contains(&self, target: &LineString<T>) -> bool

impl<T> Contains<LineString<T>> for Point<T>where
    T: CoordNum,

fn contains(&self, line_string: &LineString<T>) -> bool

impl<T> Contains<LineString<T>> for Polygon<T>where
    T: GeoFloat,

fn contains(&self, target: &LineString<T>) -> bool

impl<T> Contains<LineString<T>> for Rect<T>where
    T: GeoFloat,

fn contains(&self, target: &LineString<T>) -> bool

impl<T> Contains<LineString<T>> for Triangle<T>where
    T: GeoFloat,

fn contains(&self, target: &LineString<T>) -> bool

impl<T> Contains<MultiLineString<T>> for LineString<T>where
    T: GeoFloat,

fn contains(&self, target: &MultiLineString<T>) -> bool

impl<T> Contains<MultiPoint<T>> for LineString<T>where
    T: GeoFloat,

fn contains(&self, target: &MultiPoint<T>) -> bool

impl<T> Contains<MultiPolygon<T>> for LineString<T>where
    T: GeoFloat,

fn contains(&self, target: &MultiPolygon<T>) -> bool

impl<T> Contains<Point<T>> for LineString<T>where
    T: GeoNum,

fn contains(&self, p: &Point<T>) -> bool

impl<T> Contains<Polygon<T>> for LineString<T>where
    T: GeoFloat,

fn contains(&self, target: &Polygon<T>) -> bool

impl<T> Contains<Rect<T>> for LineString<T>where
    T: GeoFloat,

fn contains(&self, target: &Rect<T>) -> bool

impl<T> Contains<Triangle<T>> for LineString<T>where
    T: GeoFloat,

fn contains(&self, target: &Triangle<T>) -> bool

impl<T> CoordinatePosition for LineString<T>where
    T: GeoNum,

type Scalar = T

fn calculate_coordinate_position(
    &self,
    coord: &Coord<T>,
    is_inside: &mut bool,
    boundary_count: &mut usize
)

fn coordinate_position(&self, coord: &Coord<Self::Scalar>) -> CoordPos

impl<'a, T: CoordNum + 'a> CoordsIter<'a> for LineString<T>

fn coords_count(&'a self) -> usize

Return the number of coordinates in the LineString.

type Iter = Copied<Iter<'a, Coord<T>>>

type ExteriorIter = <LineString<T> as CoordsIter<'a>>::Iter

type Scalar = T

fn coords_iter(&'a self) -> Self::Iter

Iterate over all exterior and (if any) interior coordinates of a geometry.

fn exterior_coords_iter(&'a self) -> Self::ExteriorIter

Iterate over all exterior coordinates of a geometry.

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

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

Formats the value using the given formatter.

impl<T> Densify<T> for LineString<T>where
    T: CoordFloat,
    Line<T>: EuclideanLength<T>,
    LineString<T>: EuclideanLength<T>,

type Output = LineString<T>

fn densify(&self, max_distance: T) -> Self::Output

impl<'de, T> Deserialize<'de> for LineString<T>where
    T: CoordNum + Deserialize<'de>,

fn deserialize<__D>(
    __deserializer: __D
) -> Result<LineString<T>, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> EuclideanDistance<T, Line<T>> for LineString<T>where
    T: GeoFloat + FloatConst + Signed + RTreeNum,

LineString to Line

fn euclidean_distance(&self, other: &Line<T>) -> T

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for Line<T>where
    T: GeoFloat + FloatConst + Signed + RTreeNum,

Line to LineString

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for LineString<T>where
    T: GeoFloat + Signed + RTreeNum,

LineString-LineString distance

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for Point<T>where
    T: GeoFloat,

fn euclidean_distance(&self, linestring: &LineString<T>) -> T

Minimum distance from a Point to a LineString

impl<T> EuclideanDistance<T, LineString<T>> for Polygon<T>where
    T: GeoFloat + FloatConst + Signed + RTreeNum,

Polygon to LineString distance

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

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Point<T>> for LineString<T>where
    T: GeoFloat,

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

Minimum distance from a LineString to a Point

impl<T> EuclideanDistance<T, Polygon<T>> for LineString<T>where
    T: GeoFloat + FloatConst + Signed + RTreeNum,

LineString to Polygon

fn euclidean_distance(&self, other: &Polygon<T>) -> T

Returns the distance between two geometries

impl<T> EuclideanLength<T, LineString<T>> for LineString<T>where
    T: CoordFloat + Sum,

fn euclidean_length(&self) -> T

Calculation of the length of a Line

impl<T> FrechetDistance<T, LineString<T>> for LineString<T>where
    T: GeoFloat + FromPrimitive,

fn frechet_distance(&self, ls: &LineString<T>) -> T

Determine the similarity between two LineStrings using the Frechet distance.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

fn from(v: Vec<IC, Global>) -> LineString<T>

Converts to this type from the input type.

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

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

fn from_iter<I>(iter: I) -> LineString<T>where
    I: IntoIterator<Item = IC>,

Creates a value from an iterator.

impl GeodesicLength<f64, LineString<f64>> for LineString

fn geodesic_length(&self) -> f64

Determine the length of a geometry on an ellipsoidal model of the earth.

impl<C: CoordNum> HasDimensions for LineString<C>

fn boundary_dimensions(&self) -> Dimensions

use geo_types::line_string;
use geo::dimensions::{HasDimensions, Dimensions};

let ls = line_string![(x: 0.,  y: 0.), (x: 0., y: 1.), (x: 1., y: 1.)];
assert_eq!(Dimensions::ZeroDimensional, ls.boundary_dimensions());

let ls = line_string![(x: 0.,  y: 0.), (x: 0., y: 1.), (x: 1., y: 1.), (x: 0., y: 0.)];
assert_eq!(Dimensions::Empty, ls.boundary_dimensions());

fn is_empty(&self) -> bool

Some geometries, like a MultiPoint, can have zero coordinates - we call these empty.

fn dimensions(&self) -> Dimensions

The dimensions of some geometries are fixed, e.g. a Point always has 0 dimensions. However for others, the dimensionality depends on the specific geometry instance - for example typical Rects are 2-dimensional, but it’s possible to create degenerate Rects which have either 1 or 0 dimensions.

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T> HaversineLength<T, LineString<T>> for LineString<T>where
    T: CoordFloat + FromPrimitive,

fn haversine_length(&self) -> T

Determine the length of a geometry using the haversine formula.

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

type Output = Coord<T>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

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

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

impl<T> InteriorPoint for LineString<T>where
    T: GeoFloat,

type Output = Option<Point<T>>

fn interior_point(&self) -> Self::Output

Calculates a representative point inside the Geometry

impl<T, G> Intersects<G> for LineString<T>where
    T: CoordNum,
    Line<T>: Intersects<G>,
    G: BoundingRect<T>,

fn intersects(&self, geom: &G) -> bool

impl<T> Intersects<LineString<T>> for Coord<T>where
    LineString<T>: Intersects<Coord<T>>,
    T: CoordNum,

fn intersects(&self, rhs: &LineString<T>) -> bool

impl<T> Intersects<LineString<T>> for Line<T>where
    LineString<T>: Intersects<Line<T>>,
    T: CoordNum,

fn intersects(&self, rhs: &LineString<T>) -> bool

impl<T> Intersects<LineString<T>> for Polygon<T>where
    LineString<T>: Intersects<Polygon<T>>,
    T: CoordNum,

fn intersects(&self, rhs: &LineString<T>) -> bool

impl<T> Intersects<LineString<T>> for Rect<T>where
    LineString<T>: Intersects<Rect<T>>,
    T: CoordNum,

fn intersects(&self, rhs: &LineString<T>) -> bool

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

type Item = &'a Coord<T>

The type of the elements being iterated over.

type IntoIter = CoordinatesIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a LineString<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

Mutably iterate over all the [Coordinate]s in this LineString

type Item = &'a mut Coord<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

Iterate over all the Coords in this LineString.

type Item = Coord<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Coord<T>, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <LineString<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T: HasKernel> IsConvex for LineString<T>

fn convex_orientation(
    &self,
    allow_collinear: bool,
    specific_orientation: Option<Orientation>
) -> Option<Orientation>

Test and get the orientation if the shape is convex. Tests for strict convexity if allow_collinear, and only accepts a specific orientation if provided.

fn is_collinear(&self) -> bool

Test if the shape lies on a line.

fn is_convex(&self) -> bool

Test if the shape is convex.

fn is_ccw_convex(&self) -> bool

Test if the shape is convex, and oriented counter-clockwise.

fn is_cw_convex(&self) -> bool

Test if the shape is convex, and oriented clockwise.

fn is_strictly_convex(&self) -> bool

Test if the shape is strictly convex.

fn is_strictly_ccw_convex(&self) -> bool

Test if the shape is strictly convex, and oriented counter-clockwise.

fn is_strictly_cw_convex(&self) -> bool

Test if the shape is strictly convex, and oriented clockwise.

impl<T> LineInterpolatePoint<T> for LineString<T>where
    T: CoordFloat + AddAssign + Debug,
    Line<T>: EuclideanLength<T>,
    LineString<T>: EuclideanLength<T>,

type Output = Option<Point<T>>

fn line_interpolate_point(&self, fraction: T) -> Self::Output

impl<T> LineLocatePoint<T, Point<T>> for LineString<T>where
    T: CoordFloat + AddAssign,
    Line<T>: EuclideanDistance<T, Point<T>> + EuclideanLength<T>,
    LineString<T>: EuclideanLength<T>,

type Output = Option<T>

type Rhs = Point<T>

fn line_locate_point(&self, p: &Self::Rhs) -> Self::Output

impl<'a, T: CoordNum + 'a> LinesIter<'a> for LineString<T>

type Scalar = T

type Iter = LineStringIter<'a, <LineString<T> as LinesIter<'a>>::Scalar>

fn lines_iter(&'a self) -> Self::Iter

Iterate over all exterior and (if any) interior lines of a geometry.

impl<T: CoordNum, NT: CoordNum> MapCoords<T, NT> for LineString<T>

type Output = LineString<NT>

fn map_coords(&self, func: impl Fn(Coord<T>) -> Coord<NT> + Copy) -> Self::Output

Apply a function to all the coordinates in a geometric object, returning a new object.

fn try_map_coords<E>(
    &self,
    func: impl Fn(Coord<T>) -> Result<Coord<NT>, E> + Copy
) -> Result<Self::Output, E>

Map a fallible function over all the coordinates in a geometry, returning a Result

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

fn map_coords_in_place(&mut self, func: impl Fn(Coord<T>) -> Coord<T>)

Apply a function to all the coordinates in a geometric object, in place

fn try_map_coords_in_place<E>(
    &mut self,
    func: impl Fn(Coord<T>) -> Result<Coord<T>, E>
) -> Result<(), E>

Map a fallible function over all the coordinates in a geometry, in place, returning a Result.

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

fn map_coords_inplace(&mut self, func: impl Fn((T, T)) -> (T, T) + Copy)where
    T: CoordNum,

👎Deprecated since 0.21.0: use MapCoordsInPlace::map_coords_in_place instead which takes a Coord instead of an (x,y) tuple

Apply a function to all the coordinates in a geometric object, in place

Examples

#[allow(deprecated)]
use geo::MapCoordsInplace;
use geo::Point;
use approx::assert_relative_eq;

let mut p = Point::new(10., 20.);
#[allow(deprecated)]
p.map_coords_inplace(|(x, y)| (x + 1000., y * 2.));

assert_relative_eq!(p, Point::new(1010., 40.), epsilon = 1e-6);

impl<T> PartialEq<LineString<T>> for LineString<T>where
    T: PartialEq<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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

Returns the squared euclidean distance between 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 object’s dimensionality.

fn envelope(&self) -> <LineString<T> as RTreeObject>::Envelope

Returns the object’s envelope.

impl<F: GeoFloat> Relate<F, GeometryCollection<F>> for LineString<F>

fn relate(&self, other: &GeometryCollection<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Line<F>> for LineString<F>

fn relate(&self, other: &Line<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for GeometryCollection<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for Line<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for LineString<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for MultiLineString<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for MultiPoint<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for MultiPolygon<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for Point<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for Polygon<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for Rect<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, LineString<F>> for Triangle<F>

fn relate(&self, other: &LineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, MultiLineString<F>> for LineString<F>

fn relate(&self, other: &MultiLineString<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, MultiPoint<F>> for LineString<F>

fn relate(&self, other: &MultiPoint<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, MultiPolygon<F>> for LineString<F>

fn relate(&self, other: &MultiPolygon<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Point<F>> for LineString<F>

fn relate(&self, other: &Point<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Polygon<F>> for LineString<F>

fn relate(&self, other: &Polygon<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Rect<F>> for LineString<F>

fn relate(&self, other: &Rect<F>) -> IntersectionMatrix

impl<F: GeoFloat> Relate<F, Triangle<F>> for LineString<F>

fn relate(&self, other: &Triangle<F>) -> IntersectionMatrix

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

fn relative_eq(
    &self,
    other: &LineString<T>,
    epsilon: <LineString<T> as AbsDiffEq<LineString<T>>>::Epsilon,
    max_relative: <LineString<T> as AbsDiffEq<LineString<T>>>::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(
) -> <LineString<T> as AbsDiffEq<LineString<T>>>::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> RemoveRepeatedPoints<T> for LineString<T>where
    T: CoordNum + FromPrimitive,

fn remove_repeated_points(&self) -> Self

Create a LineString with consecutive repeated points removed.

fn remove_repeated_points_mut(&mut self)

Remove consecutive repeated points from a LineString inplace.

impl<T> Serialize for LineString<T>where
    T: CoordNum + Serialize,

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Simplify<T, T> for LineString<T>where
    T: GeoFloat,

fn simplify(&self, epsilon: &T) -> Self

Returns the simplified representation of a geometry, using the Ramer–Douglas–Peucker algorithm

impl<T> SimplifyIdx<T, T> for LineString<T>where
    T: GeoFloat,

fn simplify_idx(&self, epsilon: &T) -> Vec<usize>

Returns the simplified indices of a geometry, using the Ramer–Douglas–Peucker algorithm

impl<T> SimplifyVW<T, T> for LineString<T>where
    T: CoordFloat,

fn simplifyvw(&self, epsilon: &T) -> LineString<T>

Returns the simplified representation of a geometry, using the Visvalingam-Whyatt algorithm

impl<T> SimplifyVWPreserve<T, T> for LineString<T>where
    T: CoordFloat + RTreeNum + HasKernel,

fn simplifyvw_preserve(&self, epsilon: &T) -> LineString<T>

Returns the simplified representation of a geometry, using a topology-preserving variant of the Visvalingam-Whyatt algorithm.

impl<T> SimplifyVwIdx<T, T> for LineString<T>where
    T: CoordFloat,

fn simplifyvw_idx(&self, epsilon: &T) -> Vec<usize>

Returns the simplified representation of a geometry, using the Visvalingam-Whyatt algorithm

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

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<LineString<T>, <LineString<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

impl<T: CoordNum, NT: CoordNum, E> TryMapCoords<T, NT, E> for LineString<T>

type Output = LineString<NT>

👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple

fn try_map_coords(
    &self,
    func: impl Fn((T, T)) -> Result<(NT, NT), E> + Copy
) -> Result<Self::Output, E>

👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple

Map a fallible function over all the coordinates in a geometry, returning a Result

impl<T: CoordNum, E> TryMapCoordsInplace<T, E> for LineString<T>

fn try_map_coords_inplace(
    &mut self,
    func: impl Fn((T, T)) -> Result<(T, T), E>
) -> Result<(), E>

👎Deprecated since 0.21.0: use MapCoordsInPlace::try_map_coords_in_place which takes a Coord instead of an (x,y) tuple

Map a fallible function over all the coordinates in a geometry, in place, returning a Result.

impl<T> VincentyLength<T, LineString<T>> for LineString<T>where
    T: CoordFloat + FromPrimitive,

fn vincenty_length(&self) -> Result<T, FailedToConvergeError>

Determine the length of a geometry using Vincenty’s formulae.

impl<T, K> Winding for LineString<T>where
    T: HasKernel<Ker = K>,
    K: Kernel<T>,

fn points_cw(&self) -> Points<'_, Self::Scalar>

Iterate over the points in a clockwise order

The Linestring isn’t changed, and the points are returned either in order, or in reverse order, so that the resultant order makes it appear clockwise

fn points_ccw(&self) -> Points<'_, Self::Scalar>

Iterate over the points in a counter-clockwise order

The Linestring isn’t changed, and the points are returned either in order, or in reverse order, so that the resultant order makes it appear counter-clockwise

fn make_cw_winding(&mut self)

Change this line’s points so they are in clockwise winding order

fn make_ccw_winding(&mut self)

Change this line’s points so they are in counterclockwise winding order

type Scalar = T

fn winding_order(&self) -> Option<WindingOrder>

Return the winding order of this object if it contains at least three distinct coordinates, and None otherwise.

fn is_cw(&self) -> bool

True iff this is wound clockwise

fn is_ccw(&self) -> bool

True iff this is wound counterclockwise

fn clone_to_winding_order(&self, winding_order: WindingOrder) -> Selfwhere
    Self: Sized + Clone,

Return a clone of this object, but in the specified winding order

fn make_winding_order(&mut self, winding_order: WindingOrder)

Change the winding order so that it is in this winding order

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

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

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