Struct geo::MultiLineString

pub struct MultiLineString<T>(pub Vec<LineString<T>, Global>)
 where
    T: CoordNum;

A collection of LineStrings. Can be created from a Vec of LineStrings or from an Iterator which yields LineStrings. Iterating over this object yields the component LineStrings.

Semantics

The boundary of a MultiLineString is obtained by applying the “mod 2” union rule: A Point is in the boundary of a MultiLineString if it is in the boundaries of an odd number of elements of the MultiLineString.

The interior of a MultiLineString is the union of the interior, and boundary of the constituent LineStrings, except for the boundary as defined above. In other words, it is the set difference of the boundary from the union of the interior and boundary of the constituents.

A MultiLineString is simple if and only if all of its elements are simple and the only intersections between any two elements occur at Points that are on the boundaries of both elements. A MultiLineString is closed if all of its elements are closed. The boundary of a closed MultiLineString is always empty.

Implementations

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

pub fn is_closed(&self) -> bool

True if the MultiLineString is empty or if all of its LineStrings are closed - see LineString::is_closed.

Examples

use geo_types::{MultiLineString, LineString, line_string};

let open_line_string: LineString<f32> = line_string![(x: 0., y: 0.), (x: 5., y: 0.)];
assert!(!MultiLineString(vec![open_line_string.clone()]).is_closed());

let closed_line_string: LineString<f32> = line_string![(x: 0., y: 0.), (x: 5., y: 0.), (x: 0., y: 0.)];
assert!(MultiLineString(vec![closed_line_string.clone()]).is_closed());

// MultiLineString is not closed if *any* of it's LineStrings are not closed
assert!(!MultiLineString(vec![open_line_string, closed_line_string]).is_closed());

// An empty MultiLineString is closed
assert!(MultiLineString::<f32>(vec![]).is_closed());

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

pub fn iter(&self) -> impl Iterator<Item = &LineString<T>>

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut LineString<T>>

Trait Implementations

impl<T> AbsDiffEq<MultiLineString<T>> for MultiLineString<T> where
    T: AbsDiffEq<T, Epsilon = T> + CoordNum,
    <T as AbsDiffEq<T>>::Epsilon: Copy, 

type Epsilon = T

Used for specifying relative comparisons.

pub fn default_epsilon(
) -> <MultiLineString<T> as AbsDiffEq<MultiLineString<T>>>::Epsilon

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

pub fn abs_diff_eq(
    &self,
    other: &MultiLineString<T>,
    epsilon: <MultiLineString<T> as AbsDiffEq<MultiLineString<T>>>::Epsilon
) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::{MultiLineString, line_string};

let a = MultiLineString(vec![line_string![(x: 0., y: 0.), (x: 10., y: 10.)]]);
let b = MultiLineString(vec![line_string![(x: 0., y: 0.), (x: 10.01, y: 10.)]]);

approx::abs_diff_eq!(a, b, epsilon=0.1);
approx::abs_diff_ne!(a, b, epsilon=0.001);

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

The inverse of [AbsDiffEq::abs_diff_eq].

impl<T> Area<T> for MultiLineString<T> where
    T: CoordNum, 

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

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

type Output = Option<Rect<T>>

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

Return the BoundingRect for a MultiLineString

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

type Output = Option<Point<T>>

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

The Centroid of a MultiLineString is the mean of the centroids of all the constituent linestrings, weighted by the length of each linestring

impl<T> Clone for MultiLineString<T> where
    T: Clone + CoordNum, 

pub fn clone(&self) -> MultiLineString<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: GeoFloat> ClosestPoint<F, Point<F>> for MultiLineString<F>

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

Find the closest point between self and p.

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

type Scalar = T

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

impl<G, T> Contains<G> for MultiLineString<T> where
    T: CoordNum,
    LineString<T>: Contains<G>, 

fn contains(&self, rhs: &G) -> bool

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

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

impl<T> ConvexHull for MultiLineString<T> where
    T: GeoNum, 

type Scalar = T

fn convex_hull(&self) -> Polygon<T>

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

type Scalar = T

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

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

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

type Iter = Flatten<MapCoordsIter<'a, T, Iter<'a, LineString<T>>, LineString<T>>>

type ExteriorIter = Self::Iter

type Scalar = T

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

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

fn coords_count(&'a self) -> usize

Return the number of coordinates in the MultiLineString.

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

Iterate over all exterior coordinates of a geometry.

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

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

Formats the value using the given formatter.

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

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

fn euclidean_distance(&self, mls: &MultiLineString<T>) -> T

Minimum distance from a Point to a MultiLineString

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

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

Minimum distance from a MultiLineString to a Point

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

fn euclidean_length(&self) -> T

Calculation of the length of a Line

impl<T, ILS> From<ILS> for MultiLineString<T> where
    T: CoordNum,
    ILS: Into<LineString<T>>, 

pub fn from(ls: ILS) -> MultiLineString<T>

Performs the conversion.

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

pub fn from(x: MultiLineString<T>) -> Geometry<T>

Performs the conversion.

impl<T, ILS> FromIterator<ILS> for MultiLineString<T> where
    T: CoordNum,
    ILS: Into<LineString<T>>, 

pub fn from_iter<I>(iter: I) -> MultiLineString<T> where
    I: IntoIterator<Item = ILS>, 

Creates a value from an iterator.

impl GeodesicLength<f64, MultiLineString<f64>> for MultiLineString<f64>

fn geodesic_length(&self) -> f64

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

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

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.

fn boundary_dimensions(&self) -> Dimensions

The dimensions of the Geometry’s boundary, as used by OGC-SFA.

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

fn haversine_length(&self) -> T

Determine the length of a geometry using the haversine formula.

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

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

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

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

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

type Item = LineString<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Item = &'a mut LineString<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Item = &'a LineString<T>

The type of the elements being iterated over.

type IntoIter = Iter<'a, LineString<T>>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Output = MultiLineString<NT>

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

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

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

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

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

impl<T> PartialEq<MultiLineString<T>> for MultiLineString<T> where
    T: PartialEq<T> + CoordNum, 

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn default_max_relative(
) -> <MultiLineString<T> as AbsDiffEq<MultiLineString<T>>>::Epsilon

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

pub fn relative_eq(
    &self,
    other: &MultiLineString<T>,
    epsilon: <MultiLineString<T> as AbsDiffEq<MultiLineString<T>>>::Epsilon,
    max_relative: <MultiLineString<T> as AbsDiffEq<MultiLineString<T>>>::Epsilon
) -> bool

Equality assertion within a relative limit.

Examples

use geo_types::{MultiLineString, line_string};

let a = MultiLineString(vec![line_string![(x: 0., y: 0.), (x: 10., y: 10.)]]);
let b = MultiLineString(vec![line_string![(x: 0., y: 0.), (x: 10.01, y: 10.)]]);

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

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

The inverse of [RelativeEq::relative_eq].

impl<T> Rotate<T> for MultiLineString<T> where
    T: GeoFloat, 

fn rotate(&self, angle: T) -> Self

Rotate the contained LineStrings about their centroids by the given number of degrees

impl<T> Simplify<T, T> for MultiLineString<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> SimplifyVW<T, T> for MultiLineString<T> where
    T: CoordFloat, 

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

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

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

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

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

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

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

impl<T> TryFrom<Geometry<T>> for MultiLineString<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.

pub fn try_from(
    geom: Geometry<T>
) -> Result<MultiLineString<T>, <MultiLineString<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

impl<T: CoordNum, NT: CoordNum> TryMapCoords<T, NT> for MultiLineString<T>

type Output = MultiLineString<NT>

fn try_map_coords(
    &self,
    func: impl Fn(&(T, T)) -> Result<(NT, NT), Box<dyn Error + Send + Sync>> + Copy
) -> Result<Self::Output, Box<dyn Error + Send + Sync>>

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

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

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

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