Struct MultiPolygon

pub struct MultiPolygon<T = f64>(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> MultiPolygon<T>

where T: CoordNum,

pub fn new(value: Vec<Polygon<T>>) -> 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 for MultiPolygon<T>

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

fn abs_diff_eq( &self, other: &MultiPolygon<T>, epsilon: <MultiPolygon<T> as AbsDiffEq>::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>::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: BoolOpsNum> BooleanOps for MultiPolygon<T>

type Scalar = T

fn rings(&self) -> impl Iterator<Item = &LineString<Self::Scalar>>

The exterior and interior rings of the geometry.

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

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

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

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

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

fn clip( &self, multi_line_string: &MultiLineString<Self::Scalar>, invert: bool, ) -> MultiLineString<Self::Scalar>

Clip a 1-D geometry with self.

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,

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

The Centroid of a MultiPolygon is the mean of the centroids of its polygons, weighted by the area of the polygons

Examples

use geo::Centroid;
use geo::{MultiPolygon, polygon, point};

let multi_polygon = MultiPolygon::new(vec![
  // centroid (1.0, 0.5)
  polygon![
    (x: 0.0f32, y: 0.0),
    (x: 2.0, y: 0.0),
    (x: 2.0, y: 1.0),
    (x: 0.0, y: 1.0),
  ],
  // centroid (-0.5, 0.0)
  polygon![
    (x: 1.0, y: 1.0),
    (x: -2.0, y: 1.0),
    (x: -2.0, y: -1.0),
    (x: 1.0, y: -1.0),
  ]
]);

assert_eq!(
    // ( 2.0 * (1.0, 0.5) + 6.0 * (-0.5, 0.0) ) / 8.0
    Some(point!(x: -0.125, y: 0.125)),
    multi_polygon.centroid(),
);

type Output = Option<Point<T>>

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> 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<Coord<T>> for MultiPolygon<T>

where T: GeoNum,

fn contains(&self, coord: &Coord<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<T> Contains<MultiPolygon<T>> for Geometry<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPolygon<T>> for GeometryCollection<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPolygon<T>> for Line<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPolygon<T>> for LineString<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPolygon<T>> for MultiLineString<T>

where T: GeoFloat,

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

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

where T: GeoFloat,

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

impl<T> Contains<MultiPolygon<T>> for Point<T>

where T: CoordNum,

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

impl<T> Contains<MultiPolygon<T>> for Polygon<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPolygon<T>> for Rect<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPolygon<T>> for Triangle<T>

where T: GeoFloat,

fn contains(&self, target: &MultiPolygon<T>) -> 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<F> Contains for MultiPolygon<F>

where F: GeoFloat,

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

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

fn coords_count(&self) -> usize

Return the number of coordinates in the MultiPolygon.

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

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

type Scalar = T

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

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

fn exterior_coords_iter(&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<F: CoordFloat + FromPrimitive> Densify<F> for MultiPolygon<F>

type Output = MultiPolygon<F>

fn densify<MetricSpace>(&self, max_segment_length: F) -> Self::Output

where MetricSpace: Distance<F, Point<F>, Point<F>> + InterpolatePoint<F>,

impl<T> DensifyHaversine<T> for MultiPolygon<T>

where T: CoordFloat + FromPrimitive, Line<T>: HaversineLength<T>, LineString<T>: HaversineLength<T>,

type Output = MultiPolygon<T>

👎Deprecated since 0.29.0: Please use the line.densify::<Haversine>() via the Densify trait instead.

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

👎Deprecated since 0.29.0: Please use the line.densify::<Haversine>() via the Densify trait instead.

impl<F> Distance<F, &Geometry<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Geometry<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &GeometryCollection<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &GeometryCollection<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Line<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Line<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &LineString<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &LineString<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiLineString<F>, &MultiPolygon<F>> for Euclidean

fn distance( iter_geometry: &MultiLineString<F>, to_geometry: &MultiPolygon<F>, ) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPoint<F>, &MultiPolygon<F>> for Euclidean

fn distance(iter_geometry: &MultiPoint<F>, to_geometry: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &Geometry<F>> for Euclidean

fn distance(origin: &MultiPolygon<F>, destination: &Geometry<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &GeometryCollection<F>> for Euclidean

fn distance( iter_geometry: &MultiPolygon<F>, to_geometry: &GeometryCollection<F>, ) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &Line<F>> for Euclidean

fn distance(iter_geometry: &MultiPolygon<F>, to_geometry: &Line<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &LineString<F>> for Euclidean

fn distance(iter_geometry: &MultiPolygon<F>, to_geometry: &LineString<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &MultiPolygon<F>, &MultiLineString<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &MultiPolygon<F>, b: &MultiLineString<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &MultiPolygon<F>, &MultiPoint<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &MultiPolygon<F>, b: &MultiPoint<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &MultiPolygon<F>> for Euclidean

fn distance(origin: &MultiPolygon<F>, destination: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &Point<F>> for Euclidean

fn distance(iter_geometry: &MultiPolygon<F>, to_geometry: &Point<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &Polygon<F>> for Euclidean

fn distance(iter_geometry: &MultiPolygon<F>, to_geometry: &Polygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &Rect<F>> for Euclidean

fn distance(iter_geometry: &MultiPolygon<F>, to_geometry: &Rect<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F: GeoFloat> Distance<F, &MultiPolygon<F>, &Triangle<F>> for Euclidean

fn distance(iter_geometry: &MultiPolygon<F>, to_geometry: &Triangle<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Point<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Point<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Polygon<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Polygon<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Rect<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Rect<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<F> Distance<F, &Triangle<F>, &MultiPolygon<F>> for Euclidean

where F: GeoFloat,

fn distance(a: &Triangle<F>, b: &MultiPolygon<F>) -> F

Note that not all implementations support all geometry combinations, but at least Point to Point is supported. See specific implementations for details.

impl<T> EuclideanDistance<T> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Geometry<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

fn euclidean_distance(&self, geom: &Geometry<T>) -> T

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, GeometryCollection<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Line<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, LineString<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiLineString<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPoint<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Geometry<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for GeometryCollection<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Line<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for LineString<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for MultiLineString<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for MultiPoint<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Point<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Polygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Rect<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, MultiPolygon<T>> for Triangle<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Point<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Polygon<T>> for MultiPolygon<T>

where T: GeoFloat + FloatConst + RTreeNum,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Rect<T>> for MultiPolygon<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<T> EuclideanDistance<T, Triangle<T>> for MultiPolygon<T>

where T: GeoFloat + Signed + RTreeNum + FloatConst,

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

👎Deprecated since 0.29.0: Please use the Euclidean::distance method from the Distance trait instead

Returns the distance between two geometries

impl<'a, F: GeoFloat> From<&'a MultiPolygon<F>> for PreparedGeometry<'a, F>

fn from(multi_polygon: &'a MultiPolygon<F>) -> Self

Converts to this type from the input type.

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<'a, F: GeoFloat> From<MultiPolygon<F>> for PreparedGeometry<'a, F>

fn from(multi_polygon: MultiPolygon<F>) -> Self

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: GeoNum> From<MultiPolygon<T>> for MonotonicPolygons<T>

fn from(mp: MultiPolygon<T>) -> Self

Converts to this type from the input type.

impl<T, IP> From<Vec<IP>> for MultiPolygon<T>

where T: CoordNum, IP: Into<Polygon<T>>,

fn from(x: Vec<IP>) -> 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 GeodesicArea<f64> for MultiPolygon

fn geodesic_perimeter(&self) -> f64

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

fn geodesic_area_signed(&self) -> f64

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

fn geodesic_area_unsigned(&self) -> f64

Determine the area of a geometry on an ellipsoidal model of the earth. Supports very large geometries that cover a significant portion of the earth.

fn geodesic_perimeter_area_signed(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation.

fn geodesic_perimeter_area_unsigned(&self) -> (f64, f64)

Determine the perimeter and area of a geometry on an ellipsoidal model of the earth, all in one operation. Supports very large geometries that cover a significant portion of the earth.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> HaversineClosestPoint<T> for MultiPolygon<T>

where T: GeoFloat + FromPrimitive,

fn haversine_closest_point(&self, from: &Point<T>) -> Closest<T>

impl<T> InteriorPoint for MultiPolygon<T>

where T: GeoFloat,

type Output = Option<Point<T>>

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

Calculates a representative point inside the Geometry

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 Line<T>

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

fn intersects(&self, rhs: &MultiPolygon<T>) -> 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 Polygon<T>

where MultiPolygon<T>: Intersects<Polygon<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 Triangle<T>

where MultiPolygon<T>: Intersects<Triangle<T>>, T: CoordNum,

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

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<'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<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>>

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> IntoParallelIterator for &'a MultiPolygon<T>

where T: CoordNum + Sync,

type Item = &'a Polygon<T>

The type of item that the parallel iterator will produce.

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

The parallel iterator type that will be created.

fn into_par_iter(self) -> <&'a MultiPolygon<T> as IntoParallelIterator>::Iter

Converts self into a parallel iterator.

impl<'a, T> IntoParallelIterator for &'a mut MultiPolygon<T>

where T: CoordNum + Send + Sync,

type Item = &'a mut Polygon<T>

The type of item that the parallel iterator will produce.

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

The parallel iterator type that will be created.

fn into_par_iter( self, ) -> <&'a mut MultiPolygon<T> as IntoParallelIterator>::Iter

Converts self into a parallel iterator.

impl<T> IntoParallelIterator for MultiPolygon<T>

where T: CoordNum + Send,

type Item = Polygon<T>

The type of item that the parallel iterator will produce.

type Iter = IntoIter<Polygon<T>>

The parallel iterator type that will be created.

fn into_par_iter(self) -> <MultiPolygon<T> as IntoParallelIterator>::Iter

Converts self into a parallel iterator.

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(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 MultiPolygon<T>

fn map_coords_in_place(&mut self, func: impl Fn(Coord<T>) -> Coord<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(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> 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 for MultiPolygon<T>

where T: PartialEq + CoordNum,

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

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

impl<T> RTreeObject for MultiPolygon<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) -> <MultiPolygon<T> as RTreeObject>::Envelope

Returns the object’s envelope.

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

fn geometry_graph(&self, arg_index: usize) -> GeometryGraph<'_, F>

Construct a GeometryGraph

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

impl<T> RelativeEq for MultiPolygon<T>

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

fn relative_eq( &self, other: &MultiPolygon<T>, epsilon: <MultiPolygon<T> as AbsDiffEq>::Epsilon, max_relative: <MultiPolygon<T> as AbsDiffEq>::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>::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 MultiPolygon<T>

where T: CoordNum + FromPrimitive,

fn remove_repeated_points(&self) -> Self

Create a MultiPolygon with consecutive repeated points removed.

fn remove_repeated_points_mut(&mut self)

Remove consecutive repeated points from a MultiPolygon inplace.

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

where T: CoordFloat,

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

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

impl<T> SimplifyVwPreserve<T> for MultiPolygon<T>

where T: GeoFloat + RTreeNum,

fn simplify_vw_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> Eq for MultiPolygon<T>

where T: Eq + CoordNum,

impl<T> StructuralPartialEq for MultiPolygon<T>

where T: CoordNum,