Struct geo::geometry::MultiPolygon

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

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

Semantics

The interior and the boundary are the union of the interior and the boundary of the constituent polygons.

Validity

• The interiors of no two constituent polygons may intersect.

• The boundaries of two (distinct) constituent polygons may only intersect at finitely many points.

Refer to section 6.1.14 of the OGC-SFA for a formal definition of validity. Note that the validity is not enforced, but expected by the operations and predicates that operate on it.

Tuple Fields

0: Vec<Polygon<T>, Global>

Implementations

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

pub fn new(value: Vec<Polygon<T>, Global>) -> MultiPolygon<T>

Instantiate Self from the raw content value

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

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

Trait Implementations

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

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

Equality assertion with an absolute limit.

Examples

use geo_types::{polygon, Polygon, MultiPolygon};

let a_el: Polygon<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7., y: 9.), (x: 0., y: 0.)];
let a = MultiPolygon::new(vec![a_el]);
let b_el: Polygon<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7.01, y: 9.), (x: 0., y: 0.)];
let b = MultiPolygon::new(vec![b_el]);

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

type Epsilon = T

Used for specifying relative comparisons.

fn default_epsilon() -> <MultiPolygon<T> as AbsDiffEq<MultiPolygon<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 MultiPolygon<T> where
    T: CoordFloat, 

Note. The implementation is a straight-forward summation of the signed areas of the individual polygons. In particular, unsigned_area is not necessarily the sum of the unsigned_area of the constituent polygons unless they are all oriented the same.

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

impl<T: GeoFloat> BooleanOps for MultiPolygon<T>

type Scalar = T

fn boolean_op(&self, other: &Self, op: OpType) -> MultiPolygon<Self::Scalar>

fn intersection(&self, other: &Self) -> MultiPolygon<Self::Scalar>

fn union(&self, other: &Self) -> MultiPolygon<Self::Scalar>

fn xor(&self, other: &Self) -> MultiPolygon<Self::Scalar>

fn difference(&self, other: &Self) -> MultiPolygon<Self::Scalar>

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

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

Return the BoundingRect for a MultiPolygon

type Output = Option<Rect<T>>

impl<T> Centroid for MultiPolygon<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 MultiPolygon<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 MultiPolygon<T> where
    T: CoordFloat, 

fn chamberlain_duquette_signed_area(&self) -> T

fn chamberlain_duquette_unsigned_area(&self) -> T

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

fn clone(&self) -> MultiPolygon<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 MultiPolygon<F>

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

Find the closest point between self and p.

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

type Scalar = T

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

impl<T> Contains<Coordinate<T>> for MultiPolygon<T> where
    T: GeoNum, 

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

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

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

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

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

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

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

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

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

impl<T: GeoNum> Contains<MultiPoint<T>> for MultiPolygon<T>

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

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

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

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

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

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

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

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

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

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

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

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

type Scalar = T

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

impl<T> CoordinatePosition for MultiPolygon<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 MultiPolygon<T>

fn coords_count(&'a self) -> usize

Return the number of coordinates in the MultiPolygon.

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

type ExteriorIter = Flatten<MapExteriorCoordsIter<'a, T, Iter<'a, Polygon<T>>, Polygon<T>>>

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 MultiPolygon<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 MultiPolygon<T> where
    T: CoordFloat,
    Line<T>: EuclideanLength<T>,
    LineString<T>: EuclideanLength<T>, 

type Output = MultiPolygon<T>

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

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

MultiPolygon to Line distance

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

Returns the distance between two geometries

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

fn euclidean_distance(&self, mpolygon: &MultiPolygon<T>) -> T

Minimum distance from a Point to a MultiPolygon

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

Line to MultiPolygon distance

fn euclidean_distance(&self, mpolygon: &MultiPolygon<T>) -> T

Returns the distance between two geometries

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

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

Minimum distance from a MultiPolygon to a Point

impl<T, IP> From<IP> for MultiPolygon<T> where
    T: CoordNum,
    IP: Into<Polygon<T>>, 

fn from(x: IP) -> MultiPolygon<T>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<T, IP> From<Vec<IP, Global>> for MultiPolygon<T> where
    T: CoordNum,
    IP: Into<Polygon<T>>, 

fn from(x: Vec<IP, Global>) -> MultiPolygon<T>

Converts to this type from the input type.

impl<T, IP> FromIterator<IP> for MultiPolygon<T> where
    T: CoordNum,
    IP: Into<Polygon<T>>, 

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

Creates a value from an iterator.

impl<C: CoordNum> HasDimensions for MultiPolygon<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 MultiPolygon<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, 

Feeds a slice of this type into the given Hasher.

impl<G, T> Intersects<G> for MultiPolygon<T> where
    T: GeoNum,
    Polygon<T>: Intersects<G>,
    G: BoundingRect<T>, 

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

impl<T> Intersects<MultiPolygon<T>> for Point<T> where
    MultiPolygon<T>: Intersects<Point<T>>,
    T: CoordNum, 

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

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

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

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

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

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

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

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

type Item = &'a mut Polygon<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Item = &'a Polygon<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Item = Polygon<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Scalar = T

type Iter = Flatten<MapLinesIter<'a, Iter<'a, Polygon<<MultiPolygon<T> as LinesIter<'a>>::Scalar>>, Polygon<<MultiPolygon<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 MultiPolygon<T>

type Output = MultiPolygon<NT>

fn map_coords(
    &self,
    func: impl Fn(Coordinate<T>) -> Coordinate<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(Coordinate<T>) -> Result<Coordinate<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 MultiPolygon<T>

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

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(Coordinate<T>) -> Result<Coordinate<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 MultiPolygon<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 Coordinate 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> Orient for MultiPolygon<T> where
    T: GeoNum, 

fn orient(&self, direction: Direction) -> MultiPolygon<T>

Orients a Polygon’s exterior and interior rings according to convention

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

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Equality assertion within a relative limit.

Examples

use geo_types::{polygon, Polygon, MultiPolygon};

let a_el: Polygon<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7., y: 9.), (x: 0., y: 0.)];
let a = MultiPolygon::new(vec![a_el]);
let b_el: Polygon<f32> = polygon![(x: 0., y: 0.), (x: 5., y: 0.), (x: 7.01, y: 9.), (x: 0., y: 0.)];
let b = MultiPolygon::new(vec![b_el]);

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

fn default_max_relative(
) -> <MultiPolygon<T> as AbsDiffEq<MultiPolygon<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> Rotate<T> for MultiPolygon<T> where
    T: GeoFloat, 

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

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

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

Rotate the MultiPolygon about the center of its bounding rectangle by the given number of degrees

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

👎 Deprecated:

Equivalent to rotate_around_centroid except for Polygon<T>, where it is equivalent to rotating around the polygon’s outer ring. Call that instead, or rotate_around_center if you’d like to rotate around the geometry’s bounding box center.

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

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

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

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

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

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

impl<T> TryFrom<Geometry<T>> for MultiPolygon<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<MultiPolygon<T>, <MultiPolygon<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

type Output = MultiPolygon<NT>

👎 Deprecated since 0.21.0:

use MapCoords::try_map_coords which takes a Coordinate 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 Coordinate 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 MultiPolygon<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 Coordinate instead of an (x,y) tuple

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

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

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

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