Struct geo_types::Coordinate
source · [−]pub struct Coordinate<T: CoordNum> {
pub x: T,
pub y: T,
}
Expand description
A lightweight struct used to store coordinates on the 2-dimensional Cartesian plane.
Unlike Point
(which in the future may contain additional information such
as an envelope, a precision model, and spatial reference system
information), a Coordinate
only contains ordinate values and accessor
methods.
This type implements the vector space operations:
Add
, Sub
, Neg
, Zero
,
Mul<T>
, and Div<T>
traits.
Semantics
This type does not represent any geospatial primitive,
but is used in their definitions. The only requirement
is that the coordinates it contains are valid numbers
(for eg. not f64::NAN
).
Fields
x: T
y: T
Implementations
sourceimpl<T: CoordNum> Coordinate<T>
impl<T: CoordNum> Coordinate<T>
Trait Implementations
sourceimpl<T: CoordNum> Add<Coordinate<T>> for Coordinate<T>
impl<T: CoordNum> Add<Coordinate<T>> for Coordinate<T>
Add two coordinates.
Examples
use geo_types::coord;
let p = coord! { x: 1.25, y: 2.5 };
let q = coord! { x: 1.5, y: 2.5 };
let sum = p + q;
assert_eq!(sum.x, 2.75);
assert_eq!(sum.y, 5.0);
sourceimpl<T: Clone + CoordNum> Clone for Coordinate<T>
impl<T: Clone + CoordNum> Clone for Coordinate<T>
sourcefn clone(&self) -> Coordinate<T>
fn clone(&self) -> Coordinate<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<T: Debug + CoordNum> Debug for Coordinate<T>
impl<T: Debug + CoordNum> Debug for Coordinate<T>
sourceimpl<T: Default + CoordNum> Default for Coordinate<T>
impl<T: Default + CoordNum> Default for Coordinate<T>
sourcefn default() -> Coordinate<T>
fn default() -> Coordinate<T>
Returns the “default value” for a type. Read more
sourceimpl<T: CoordNum> Div<T> for Coordinate<T>
impl<T: CoordNum> Div<T> for Coordinate<T>
Divide coordinate wise by a scalar.
Examples
use geo_types::coord;
let p = coord! { x: 5., y: 10. };
let q = p / 4.;
assert_eq!(q.x, 1.25);
assert_eq!(q.y, 2.5);
sourceimpl<T: CoordNum> From<Coordinate<T>> for (T, T)
impl<T: CoordNum> From<Coordinate<T>> for (T, T)
sourcefn from(coord: Coordinate<T>) -> Self
fn from(coord: Coordinate<T>) -> Self
Converts to this type from the input type.
sourceimpl<T: CoordNum> From<Coordinate<T>> for [T; 2]
impl<T: CoordNum> From<Coordinate<T>> for [T; 2]
sourcefn from(coord: Coordinate<T>) -> Self
fn from(coord: Coordinate<T>) -> Self
Converts to this type from the input type.
sourceimpl<T: CoordNum> From<Coordinate<T>> for Point<T>
impl<T: CoordNum> From<Coordinate<T>> for Point<T>
sourcefn from(x: Coordinate<T>) -> Self
fn from(x: Coordinate<T>) -> Self
Converts to this type from the input type.
sourceimpl<T: CoordNum> From<Point<T>> for Coordinate<T>
impl<T: CoordNum> From<Point<T>> for Coordinate<T>
sourceimpl<T: Hash + CoordNum> Hash for Coordinate<T>
impl<T: Hash + CoordNum> Hash for Coordinate<T>
sourceimpl<T: CoordNum> Mul<T> for Coordinate<T>
impl<T: CoordNum> Mul<T> for Coordinate<T>
Multiply coordinate wise by a scalar.
Examples
use geo_types::coord;
let p = coord! { x: 1.25, y: 2.5 };
let q = p * 4.;
assert_eq!(q.x, 5.0);
assert_eq!(q.y, 10.0);
sourceimpl<T> Neg for Coordinate<T> where
T: CoordNum + Neg<Output = T>,
impl<T> Neg for Coordinate<T> where
T: CoordNum + Neg<Output = T>,
Negate a coordinate.
Examples
use geo_types::coord;
let p = coord! { x: 1.25, y: 2.5 };
let q = -p;
assert_eq!(q.x, -p.x);
assert_eq!(q.y, -p.y);
sourceimpl<T: PartialEq + CoordNum> PartialEq<Coordinate<T>> for Coordinate<T>
impl<T: PartialEq + CoordNum> PartialEq<Coordinate<T>> for Coordinate<T>
sourcefn eq(&self, other: &Coordinate<T>) -> bool
fn eq(&self, other: &Coordinate<T>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &Coordinate<T>) -> bool
fn ne(&self, other: &Coordinate<T>) -> bool
This method tests for !=
.
sourceimpl<T: CoordNum> Sub<Coordinate<T>> for Coordinate<T>
impl<T: CoordNum> Sub<Coordinate<T>> for Coordinate<T>
Subtract a coordinate from another.
Examples
use geo_types::coord;
let p = coord! { x: 1.5, y: 2.5 };
let q = coord! { x: 1.25, y: 2.5 };
let diff = p - q;
assert_eq!(diff.x, 0.25);
assert_eq!(diff.y, 0.);
sourceimpl<T: CoordNum> Zero for Coordinate<T>
impl<T: CoordNum> Zero for Coordinate<T>
impl<T: Copy + CoordNum> Copy for Coordinate<T>
impl<T: Eq + CoordNum> Eq for Coordinate<T>
impl<T: CoordNum> StructuralEq for Coordinate<T>
impl<T: CoordNum> StructuralPartialEq for Coordinate<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for Coordinate<T> where
T: RefUnwindSafe,
impl<T> Send for Coordinate<T> where
T: Send,
impl<T> Sync for Coordinate<T> where
T: Sync,
impl<T> Unpin for Coordinate<T> where
T: Unpin,
impl<T> UnwindSafe for Coordinate<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more