Struct geo::MultiPoint

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

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: CoordinateType, 

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> Area<T> for MultiPoint<T> where
    T: CoordinateType, 

pub fn signed_area(&self) -> T

pub fn unsigned_area(&self) -> T

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

type Output = Option<Rect<T>>

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

Return the BoundingRect for a MultiPoint

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

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

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

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

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

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: Float> ClosestPoint<F, Point<F>> for MultiPoint<F>

pub 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: Float + RTreeNum + HasKernel, 

type Scalar = T

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

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

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

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

type Scalar = T

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

impl<T> CoordinatePosition for MultiPoint<T> where
    T: HasKernel, 

type Scalar = T

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

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

impl<'a, T: CoordinateType + 'a> CoordsIter<'a, T> for MultiPoint<T>

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

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

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

impl<T> Debug for MultiPoint<T> where
    T: Debug + CoordinateType, 

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 + CoordinateType, 

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

pub 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: Float, 

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

Minimum distance from a MultiPoint to a Point

impl<T> ExtremeIndices for MultiPoint<T> where
    T: Signed + HasKernel, 

pub fn extreme_indices(&self) -> Result<Extremes, ()>

Find the extreme x and y indices of a convex Polygon

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

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: CoordinateType, 

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

Performs the conversion.

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

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
    IP: Into<Point<T>>,
    T: CoordinateType, 

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: CoordinateType> HasDimensions for MultiPoint<C>

pub fn is_empty(&self) -> bool

Some geometries, like a MultiPoint, can have zero coordinates - we call these empty.

pub 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.

pub 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 + CoordinateType, 

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: CoordinateType,
    Point<T>: Intersects<G>, 

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

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

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

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

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

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

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

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

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

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

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: CoordinateType, 

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: CoordinateType, 

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: CoordinateType, NT: CoordinateType> MapCoords<T, NT> for MultiPoint<T>

type Output = MultiPoint<NT>

pub 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: CoordinateType> MapCoordsInplace<T> for MultiPoint<T>

pub 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> + CoordinateType, 

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<T> Rotate<T> for MultiPoint<T> where
    T: Float + FromPrimitive, 

pub 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: CoordinateType, 

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

impl<T> TryFrom<Geometry<T>> for MultiPoint<T> where
    T: Float, 

type Error = FailedToConvertError

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: CoordinateType, NT: CoordinateType> TryMapCoords<T, NT> for MultiPoint<T>

type Output = MultiPoint<NT>

pub 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