Struct geo::MultiPoint

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

A collection of Points.

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());
}

Trait Implementations

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

fn signed_area(&self) -> T

fn unsigned_area(&self) -> T

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

type Output = Option<Rect<T>>

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

Return the BoundingRect for a MultiPoint

impl<T> Centroid<T> 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>>

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

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

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

fn clone(&self) -> MultiPoint<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F: Float> 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> Contains<Coordinate<T>> for MultiPoint<T> where
    T: Float, 

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

Checks if rhs is completely contained within self.

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

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

Checks if rhs is completely contained within self.

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

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

Returns the convex hull of a Polygon. The hull is always oriented counter-clockwise.

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

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, 

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, 

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

Minimum distance from a MultiPoint to a Point

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

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, 

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, 

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

Performs the conversion.

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

fn from(v: Vec<IP>) -> 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, 

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

Collect the results of a Point iterator into a MultiPoint

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

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <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>

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>

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, 

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

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

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

This method tests for !=.

impl<T> Rotate<T> for MultiPoint<T> where
    T: Float + FromPrimitive, 

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

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

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

type Error = FailedToConvertError

The type returned in the event of a conversion error.

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>

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