Type Alias Coordinate

pub type Coordinate<T = f64> = Coord<T>;

👎Deprecated: Renamed to geo_types::Coord (or geo::Coord)

Aliased Type

struct Coordinate<T = f64> {
    pub x: T,
    pub y: T,
}

Fields

x: T

y: T

Implementations

impl<T: CoordNum> Coord<T>

Create a coordinate at the origin.

Examples

use geo_types::Coord;
use num_traits::Zero;

let p: Coord = Zero::zero();

assert_eq!(p.x, 0.);
assert_eq!(p.y, 0.);

pub fn zero() -> Self

impl<T: CoordNum> 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: CoordNum> Add for Coord<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);

type Output = Coord<T>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl<T: CoordNum> AsRef<Coord<T>> for Coord<T>

fn as_ref(&self) -> &Coord<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone + CoordNum> Clone for Coord<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: CoordNum> Debug for Coord<T>

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

Formats the value using the given formatter.

impl<T: Default + CoordNum> Default for Coord<T>

fn default() -> Coord<T>

Returns the “default value” for a type.

impl<T: CoordNum> Div<T> for Coord<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);

type Output = Coord<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self

Performs the / operation.

impl<T: CoordNum> From<[T; 2]> for Coord<T>

fn from(coords: [T; 2]) -> Self

Converts to this type from the input type.

impl<T: CoordNum> From<(T, T)> for Coord<T>

fn from(coords: (T, T)) -> Self

Converts to this type from the input type.

impl<T: CoordNum> From<Point<T>> for Coord<T>

fn from(point: Point<T>) -> Self

Converts to this type from the input type.

impl<T: Hash + CoordNum> Hash for Coord<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: CoordNum> Mul<T> for Coord<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);

type Output = Coord<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self

Performs the * operation.

impl<T> Neg for Coord<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);

type Output = Coord<T>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: PartialEq + CoordNum> PartialEq for Coord<T>

fn eq(&self, other: &Coord<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: CoordNum> Sub for Coord<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.);

type Output = Coord<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl<T: CoordNum> Zero for Coord<T>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T: Copy + CoordNum> Copy for Coord<T>

impl<T: Eq + CoordNum> Eq for Coord<T>

impl<T: CoordNum> StructuralPartialEq for Coord<T>