Struct geo_types::MultiPoint

pub struct MultiPoint<T>(pub Vec<Point<T>>)
 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());
}

Tuple Fields

0: Vec<Point<T>>

Implementations

impl<T: CoordNum> MultiPoint<T>

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<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::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);

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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: CoordNum> From<MultiPoint<T>> for Geometry<T>

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

Performs the conversion.

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

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: CoordNum, IP: Into<Point<T>>> FromIterator<IP> for MultiPoint<T>

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

Collect the results of a Point iterator into a MultiPoint

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

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

Creates an iterator from a value.

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

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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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> RelativeEq<MultiPoint<T>> for MultiPoint<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::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)

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

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

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