Struct geo_types::MultiPolygon

pub struct MultiPolygon<T>(pub Vec<Polygon<T>>)
 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>>

Implementations

impl<T: CoordNum> MultiPolygon<T>

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<Epsilon = T> + CoordNum,
    T::Epsilon: Copy, 

fn abs_diff_eq(&self, other: &Self, epsilon: Self::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(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(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() -> 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 MultiPolygon<T> where
    T: 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<T: Debug> Debug for MultiPolygon<T> where
    T: CoordNum, 

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

Formats the value using the given formatter.

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

fn from(x: IP) -> Self

Performs the conversion.

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

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

Performs the conversion.

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

fn from(x: Vec<IP>) -> Self

Performs the conversion.

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

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

Creates a value from an iterator.

impl<T: Hash> Hash for MultiPolygon<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> IntoIterator for MultiPolygon<T>

type Item = Polygon<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Polygon<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 MultiPolygon<T>

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) -> Self::IntoIter

Creates an iterator from a value.

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

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) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq<MultiPolygon<T>> for MultiPolygon<T> where
    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<T> RelativeEq<MultiPolygon<T>> for MultiPolygon<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::{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(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(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() -> 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 MultiPolygon<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 MultiPolygon<T> where
    T: CoordNum, 

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

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