Struct geo::MultiPoint

pub struct MultiPoint<T>(pub Vec<Point<T>, Global>)
 where
    T: CoordNum;

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

Semantics

The interior and the boundary are the union of the interior and the boundary of the constituent points. In particular, the boundary of a MultiPoint is always empty.

Examples

Iterating over a MultiPoint yields the Points inside.

use geo_types::{MultiPoint, Point};
let points: MultiPoint<_> = vec![(0., 0.), (1., 2.)].into();
for point in points {
    println!("Point x = {}, y = {}", point.x(), point.y());
}

Implementations

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

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

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

Trait Implementations

impl<T> AbsDiffEq<MultiPoint<T>> for MultiPoint<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() -> <MultiPoint<T> as AbsDiffEq<MultiPoint<T>>>::Epsilon

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

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

Equality assertion with an absolute limit.

Examples

use geo_types::MultiPoint;
use geo_types::point;

let a = MultiPoint(vec![point![x: 0., y: 0.], point![x: 10., y: 10.]]);
let b = MultiPoint(vec![point![x: 0., y: 0.], point![x: 10.001, y: 10.]]);

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

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

The inverse of [AbsDiffEq::abs_diff_eq].

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

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

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

type Output = Option<Rect<T>>

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

Return the BoundingRect for a MultiPoint

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

use geo::algorithm::centroid::Centroid;
use geo::{MultiPoint, Point};

let empty: Vec<Point<f64>> = Vec::new();
let empty_multi_points: MultiPoint<_> = empty.into();
assert_eq!(empty_multi_points.centroid(), None);

let points: MultiPoint<_> = vec![(5., 1.), (1., 3.), (3., 2.)].into();
assert_eq!(points.centroid(), Some(Point::new(3., 2.)));

type Output = Option<Point<T>>

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

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

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

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

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

Find the closest point between self and p.

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

type Scalar = T

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

impl<G, T> Contains<G> for MultiPoint<T> where
    T: CoordNum,
    Point<T>: Contains<G>, 

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

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

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

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

type Scalar = T

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

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

type Iter = Flatten<MapCoordsIter<'a, T, Iter<'a, Point<T>>, Point<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 MultiPoint.

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

Iterate over all exterior coordinates of a geometry.

impl<T> Debug for MultiPoint<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 MultiPoint<T> where
    T: Eq + CoordNum, 

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

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

Minimum distance from a Point to a MultiPoint

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

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

Minimum distance from a MultiPoint to a Point

impl<T, IP> From<IP> for MultiPoint<T> where
    T: CoordNum,
    IP: Into<Point<T>>, 

pub fn from(x: IP) -> MultiPoint<T>

Convert a single Point (or something which can be converted to a Point) into a one-member MultiPoint

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

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

Performs the conversion.

impl<T, IP> From<Vec<IP, Global>> for MultiPoint<T> where
    T: CoordNum,
    IP: Into<Point<T>>, 

pub fn from(v: Vec<IP, Global>) -> MultiPoint<T>

Convert a Vec of Points (or Vec of things which can be converted to a Point) into a MultiPoint.

impl<T, IP> FromIterator<IP> for MultiPoint<T> where
    T: CoordNum,
    IP: Into<Point<T>>, 

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

Collect the results of a Point iterator into a MultiPoint

impl<C: CoordNum> HasDimensions for MultiPoint<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 MultiPoint<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, G> Intersects<G> for MultiPoint<T> where
    T: CoordNum,
    Point<T>: Intersects<G>, 

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

impl<T> Intersects<MultiPoint<T>> for Coordinate<T> where
    MultiPoint<T>: Intersects<Coordinate<T>>,
    T: CoordNum, 

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

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

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

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

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

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

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

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

type Item = &'a mut Point<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

Iterate over the Points in this MultiPoint.

type Item = Point<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Item = &'a Point<T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

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

type Output = MultiPoint<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 MultiPoint<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<MultiPoint<T>> for MultiPoint<T> where
    T: PartialEq<T> + CoordNum, 

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Equality assertion within a relative limit.

Examples

use geo_types::MultiPoint;
use geo_types::point;

let a = MultiPoint(vec![point![x: 0., y: 0.], point![x: 10., y: 10.]]);
let b = MultiPoint(vec![point![x: 0., y: 0.], point![x: 10.001, y: 10.]]);

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

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 MultiPoint<T> where
    T: CoordFloat, 

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

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

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

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

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

Performs the conversion.

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

type Output = MultiPoint<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