Struct SweepPoint

pub struct SweepPoint<T: GeoNum>(/* private fields */);

A lexicographically ordered point.

A wrapper around Coord to order the point by x, and then by y. Implements Ord and Eq, allowing usage in ordered collections such as BinaryHeap.

Note that the scalar type T is only required to implement PartialOrd. Thus, it is a logical error to construct this struct unless the coords are guaranteed to be orderable.

Methods from Deref<Target = Coord<T>>

pub fn x_y(&self) -> (T, T)

Returns a tuple that contains the x/horizontal & y/vertical component of the coordinate.

Examples

use geo_types::coord;

let c = coord! {
    x: 40.02f64,
    y: 116.34,
};
let (x, y) = c.x_y();

assert_eq!(y, 116.34);
assert_eq!(x, 40.02f64);

Trait Implementations

impl<T: Clone + GeoNum> Clone for SweepPoint<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: GeoNum> Debug for SweepPoint<T>

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

Formats the value using the given formatter.

impl<T: GeoNum> Deref for SweepPoint<T>

type Target = Coord<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: GeoNum> From<SweepPoint<T>> for LineOrPoint<T>

fn from(pt: SweepPoint<T>) -> Self

Converts to this type from the input type.

impl<T: GeoNum, X: Into<Coord<T>>> From<X> for SweepPoint<T>

Conversion from type that can be converted to a Coord.

fn from(pt: X) -> Self

Converts to this type from the input type.

impl<T: GeoNum> Ord for SweepPoint<T>

Derive Ord from PartialOrd and expect to not fail.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + GeoNum> PartialEq for SweepPoint<T>

fn eq(&self, other: &SweepPoint<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<T: GeoNum> PartialOrd for SweepPoint<T>

Implement lexicographic ordering by x and then by y coordinate.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy + GeoNum> Copy for SweepPoint<T>

impl<T: GeoNum> Eq for SweepPoint<T>

We derive Eq manually to not require T: Eq.

impl<T: GeoNum> StructuralPartialEq for SweepPoint<T>