Struct MultiPoint

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

where T: CoordNum,

pub fn new(value: Vec<Point<T>>) -> MultiPoint<T>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

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

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

Equality assertion with an absolute limit.

Examples

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

let a = MultiPoint::new(vec![point![x: 0., y: 0.], point![x: 10., y: 10.]]);
let b = MultiPoint::new(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() -> <MultiPoint<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 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,

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

Return the BoundingRect for a MultiPoint

type Output = Option<Rect<T>>

impl<T> Centroid for MultiPoint<T>

where T: GeoFloat,

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

The Centroid of a MultiPoint is the mean of all Points

Example

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

let empty: Vec<Point> = 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>>

impl<T> ChamberlainDuquetteArea<T> for MultiPoint<T>

where T: CoordFloat,

fn chamberlain_duquette_signed_area(&self) -> T

fn chamberlain_duquette_unsigned_area(&self) -> T

impl<T> Clone for MultiPoint<T>

where T: Clone + 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<F: GeoFloat> ClosestPoint<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<T> Contains<Coord<T>> for MultiPoint<T>

where T: CoordNum,

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

impl<T> Contains<GeometryCollection<T>> for MultiPoint<T>

where T: GeoFloat,

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

impl<T> Contains<Line<T>> for MultiPoint<T>

where T: GeoFloat,

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

impl<T> Contains<LineString<T>> for MultiPoint<T>

where T: GeoFloat,

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

impl<T> Contains<MultiLineString<T>> for MultiPoint<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPoint<T>> for Geometry<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPoint<T>> for GeometryCollection<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPoint<T>> for Line<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPoint<T>> for LineString<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPoint<T>> for MultiLineString<T>

where T: GeoFloat,

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

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

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

impl<T> Contains<MultiPoint<T>> for Point<T>

where T: CoordNum,

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

impl<T> Contains<MultiPoint<T>> for Polygon<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPoint<T>> for Rect<T>

where T: GeoFloat,

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

impl<T> Contains<MultiPoint<T>> for Triangle<T>

where T: GeoFloat,

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

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

where T: GeoFloat,

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

impl<T> Contains<Point<T>> for MultiPoint<T>

where T: CoordNum,

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

impl<T> Contains<Polygon<T>> for MultiPoint<T>

where T: GeoFloat,

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

impl<T> Contains<Rect<T>> for MultiPoint<T>

where T: GeoFloat,

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

impl<T> Contains<Triangle<T>> for MultiPoint<T>

where T: GeoFloat,

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

impl<T> Contains for MultiPoint<T>

where T: GeoFloat,

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

impl<T> CoordinatePosition for MultiPoint<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<'a, T: CoordNum + 'a> CoordsIter<'a> for MultiPoint<T>

fn coords_count(&'a self) -> usize

Return the number of coordinates in the MultiPoint.

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

type ExteriorIter = <MultiPoint<T> as CoordsIter<'a>>::Iter

type Scalar = T

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

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

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

Iterate over all exterior coordinates of a geometry.

impl<T> Debug for MultiPoint<T>

where T: CoordNum,

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

Formats the value using the given formatter.

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

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,

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

Converts to this type from the input type.

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

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

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

fn from_iter<I>(iter: I) -> MultiPoint<T>

where I: IntoIterator<Item = IP>,

Collect the results of a Point iterator into a MultiPoint

impl GeodesicArea<f64> for MultiPoint

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

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> InteriorPoint for MultiPoint<T>

where T: GeoFloat,

use geo::InteriorPoint;
use geo::{MultiPoint, Point};

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

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

type Output = Option<Point<T>>

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

Calculates a representative point inside the Geometry

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

where MultiPoint<T>: Intersects<Coord<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 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?

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

Creates an iterator from a value.

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?

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

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> KNearestConcaveHull for MultiPoint<T>

where T: GeoFloat + RTreeNum,

type Scalar = T

fn k_nearest_concave_hull(&self, k: u32) -> Polygon<Self::Scalar>

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

type Output = MultiPoint<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 MultiPoint<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: CoordNum> MapCoordsInplace<T> for MultiPoint<T>

fn map_coords_inplace(&mut self, func: impl Fn((T, T)) -> (T, T) + Copy)

where T: CoordNum,

👎Deprecated since 0.21.0: use MapCoordsInPlace::map_coords_in_place instead which takes a Coord instead of an (x,y) tuple

Apply a function to all the coordinates in a geometric object, in place

Examples

#[allow(deprecated)]
use geo::MapCoordsInplace;
use geo::Point;
use approx::assert_relative_eq;

let mut p = Point::new(10., 20.);
#[allow(deprecated)]
p.map_coords_inplace(|(x, y)| (x + 1000., y * 2.));

assert_relative_eq!(p, Point::new(1010., 40.), epsilon = 1e-6);

impl<T> OutlierDetection<T> for MultiPoint<T>

where T: GeoFloat + Sum,

fn outliers(&self, k_neighbours: usize) -> Vec<T>

The LOF algorithm. k_neighbours specifies the number of neighbours to use for local outlier classification. The paper linked above (see p. 100) suggests a k_neighbours value of 10 - 20 as a lower bound for “real-world” data.

fn prepared_detector(&self) -> PreparedDetector<'_, T>

Create a prepared outlier detector allowing multiple runs to retain the spatial index in use. A PreparedDetector can efficiently recompute outliers with different k_neigbhours values.

fn generate_ensemble(&self, bounds: RangeInclusive<usize>) -> Vec<Vec<T>>

Perform successive runs with k_neighbours values between bounds, generating an ensemble of LOF scores, which may be aggregated using e.g. min, max, or mean

fn ensemble_min(&self, bounds: RangeInclusive<usize>) -> Vec<T>

Convenience method to efficiently calculate the minimum values of an LOF ensemble

fn ensemble_max(&self, bounds: RangeInclusive<usize>) -> Vec<T>

Convenience method to efficiently calculate the maximum values of an LOF ensemble

impl<T> PartialEq for MultiPoint<T>

where T: PartialEq + CoordNum,

fn eq(&self, other: &MultiPoint<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<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 GeometryCollection<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 MultiLineString<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 MultiPolygon<F>

fn relate(&self, other: &MultiPoint<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 Polygon<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, 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 for MultiPoint<T>

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

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

Equality assertion within a relative limit.

Examples

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

let a = MultiPoint::new(vec![point![x: 0., y: 0.], point![x: 10., y: 10.]]);
let b = MultiPoint::new(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() -> <MultiPoint<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 MultiPoint<T>

where T: CoordNum + FromPrimitive,

fn remove_repeated_points(&self) -> Self

Create a MultiPoint with repeated points removed.

fn remove_repeated_points_mut(&mut self)

Remove repeated points from a MultiPoint inplace.

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.

fn try_from( geom: Geometry<T>, ) -> Result<MultiPoint<T>, <MultiPoint<T> as TryFrom<Geometry<T>>>::Error>

Performs the conversion.

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

type Output = MultiPoint<NT>

👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple

fn try_map_coords( &self, func: impl Fn((T, T)) -> Result<(NT, NT), E> + Copy, ) -> Result<Self::Output, E>

👎Deprecated since 0.21.0: use MapCoords::try_map_coords which takes a Coord instead of an (x,y) tuple

Map a fallible function over all the coordinates in a geometry, returning a Result

impl<T: CoordNum, E> TryMapCoordsInplace<T, E> for MultiPoint<T>

fn try_map_coords_inplace( &mut self, func: impl Fn((T, T)) -> Result<(T, T), E>, ) -> Result<(), E>

👎Deprecated since 0.21.0: use MapCoordsInPlace::try_map_coords_in_place which takes a Coord instead of an (x,y) tuple

Map a fallible function over all the coordinates in a geometry, in place, returning a Result.

impl<T> UlpsEq for MultiPoint<T>

where T: CoordNum + UlpsEq<Epsilon = T>,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq( &self, other: &MultiPoint<T>, epsilon: <MultiPoint<T> as AbsDiffEq>::Epsilon, max_ulps: u32, ) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<T> Eq for MultiPoint<T>

where T: Eq + CoordNum,

impl<T> StructuralPartialEq for MultiPoint<T>

where T: CoordNum,