Struct geo_types::geometry::Point

pub struct Point<T: CoordNum = f64>(pub Coord<T>);

A single point in 2D space.

Points can be created using the Point::new constructor, the point! macro, or from a Coord, two-element tuples, or arrays – see the From impl section for a complete list.

Semantics

The interior of the point is itself (a singleton set), and its boundary is empty. A point is valid if and only if the Coord is valid.

Examples

use geo_types::{coord, Point};
let p1: Point = (0., 1.).into();
let c = coord! { x: 10., y: 20. };
let p2: Point = c.into();

Tuple Fields

0: Coord<T>

Implementations

impl<T: CoordNum> Point<T>

pub fn new(x: T, y: T) -> Self

Creates a new point.

Examples

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.x(), 1.234);
assert_eq!(p.y(), 2.345);

pub fn x(self) -> T

Returns the x/horizontal component of the point.

Examples

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.x(), 1.234);

pub fn set_x(&mut self, x: T) -> &mut Self

Sets the x/horizontal component of the point.

Examples

use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
p.set_x(9.876);

assert_eq!(p.x(), 9.876);

pub fn x_mut(&mut self) -> &mut T

Returns a mutable reference to the x/horizontal component of the point

Examples

use approx::assert_relative_eq;
use geo_types::Point;
let mut p = Point::new(1.234, 2.345);
let mut p_x = p.x_mut();
*p_x += 1.0;
assert_relative_eq!(p.x(), 2.234);

pub fn y(self) -> T

Returns the y/vertical component of the point.

Examples

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.y(), 2.345);

pub fn set_y(&mut self, y: T) -> &mut Self

Sets the y/vertical component of the point.

Examples

use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
p.set_y(9.876);

assert_eq!(p.y(), 9.876);

pub fn y_mut(&mut self) -> &mut T

Returns a mutable reference to the x/horizontal component of the point

Examples

use approx::assert_relative_eq;
use geo_types::Point;
let mut p = Point::new(1.234, 2.345);
let mut p_y = p.y_mut();
*p_y += 1.0;
assert_relative_eq!(p.y(), 3.345);

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

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

Examples

use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
let (x, y) = p.x_y();

assert_eq!(y, 2.345);
assert_eq!(x, 1.234);

pub fn lng(self) -> T

👎Deprecated: use Point::x instead, it’s less ambiguous

Returns the longitude/horizontal component of the point.

Examples

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.x(), 1.234);

pub fn set_lng(&mut self, lng: T) -> &mut Self

👎Deprecated: use Point::set_x instead, it’s less ambiguous

Sets the longitude/horizontal component of the point.

Examples

use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
#[allow(deprecated)]
p.set_lng(9.876);

assert_eq!(p.x(), 9.876);

pub fn lat(self) -> T

👎Deprecated: use Point::y instead, it’s less ambiguous

Returns the latitude/vertical component of the point.

Examples

use geo_types::Point;

let p = Point::new(1.234, 2.345);

assert_eq!(p.y(), 2.345);

pub fn set_lat(&mut self, lat: T) -> &mut Self

👎Deprecated: use Point::set_y instead, it’s less ambiguous

Sets the latitude/vertical component of the point.

Examples

use geo_types::Point;

let mut p = Point::new(1.234, 2.345);
#[allow(deprecated)]
p.set_lat(9.876);

assert_eq!(p.y(), 9.876);

impl<T: CoordNum> Point<T>

pub fn dot(self, other: Self) -> T

Returns the dot product of the two points: dot = x1 * x2 + y1 * y2

Examples

use geo_types::{point, Point};

let point = point! { x: 1.5, y: 0.5 };
let dot = point.dot(point! { x: 2.0, y: 4.5 });

assert_eq!(dot, 5.25);

pub fn cross_prod(self, point_b: Self, point_c: Self) -> T

Returns the cross product of 3 points. A positive value implies self → point_b → point_c is counter-clockwise, negative implies clockwise.

Note on Robustness

This function is not robust against floating-point errors. The geo crate offers robust predicates for standard numeric types using the Kernel trait, and these should be preferred if possible.

Examples

use geo_types::point;

let point_a = point! { x: 1., y: 2. };
let point_b = point! { x: 3., y: 5. };
let point_c = point! { x: 7., y: 12. };

let cross = point_a.cross_prod(point_b, point_c);

assert_eq!(cross, 2.0)

impl<T: CoordFloat> Point<T>

pub fn to_degrees(self) -> Self

Converts the (x,y) components of Point to degrees

Example

use geo_types::Point;

let p = Point::new(1.234, 2.345);
let (x, y): (f32, f32) = p.to_degrees().x_y();
assert_eq!(x.round(), 71.0);
assert_eq!(y.round(), 134.0);

pub fn to_radians(self) -> Self

Converts the (x,y) components of Point to radians

Example

use geo_types::Point;

let p = Point::new(180.0, 341.5);
let (x, y): (f32, f32) = p.to_radians().x_y();
assert_eq!(x.round(), 3.0);
assert_eq!(y.round(), 6.0);

Trait Implementations

impl<T> AbsDiffEq<Point<T>> for Point<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::Point;

let a = Point::new(2.0, 3.0);
let b = Point::new(2.0, 3.0000001);

approx::assert_relative_eq!(a, b, epsilon=0.1)

type Epsilon = <T as AbsDiffEq<T>>::Epsilon

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: CoordNum> Add<Point<T>> for Point<T>

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

Add a point to the given point.

Examples

use geo_types::Point;

let p = Point::new(1.25, 2.5) + Point::new(1.5, 2.5);

assert_eq!(p.x(), 2.75);
assert_eq!(p.y(), 5.0);

type Output = Point<T>

The resulting type after applying the + operator.

impl<T: CoordNum> AddAssign<Point<T>> for Point<T>

fn add_assign(&mut self, rhs: Self)

Add a point to the given point and assign it to the original point.

Examples

use geo_types::Point;

let mut p = Point::new(1.25, 2.5);
p += Point::new(1.5, 2.5);

assert_eq!(p.x(), 2.75);
assert_eq!(p.y(), 5.0);

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + CoordNum> Debug for Point<T>

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

Formats the value using the given formatter.

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

fn default() -> Point<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Point<T>where
    T: Deserialize<'de> + CoordNum,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: CoordNum> Div<T> for Point<T>

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

Scaler division of a point

Examples

use geo_types::Point;

let p = Point::new(2.0, 3.0) / 2.0;

assert_eq!(p.x(), 1.0);
assert_eq!(p.y(), 1.5);

type Output = Point<T>

The resulting type after applying the / operator.

impl<T: CoordNum> DivAssign<T> for Point<T>

fn div_assign(&mut self, rhs: T)

Scaler division of a point in place

Examples

use geo_types::Point;

let mut p = Point::new(2.0, 3.0);
p /= 2.0;

assert_eq!(p.x(), 1.0);
assert_eq!(p.y(), 1.5);

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(x: Coord<T>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(point: Point<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: CoordNum> From<Point<T>> for Geometry<T>

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

Converts to this type from the input type.

impl<T: Hash + CoordNum> Hash for Point<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 Point<T>

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

Scaler multiplication of a point

Examples

use geo_types::Point;

let p = Point::new(2.0, 3.0) * 2.0;

assert_eq!(p.x(), 4.0);
assert_eq!(p.y(), 6.0);

type Output = Point<T>

The resulting type after applying the * operator.

impl<T: CoordNum> MulAssign<T> for Point<T>

fn mul_assign(&mut self, rhs: T)

Scaler multiplication of a point in place

Examples

use geo_types::Point;

let mut p = Point::new(2.0, 3.0);
p *= 2.0;

assert_eq!(p.x(), 4.0);
assert_eq!(p.y(), 6.0);

impl<T> Neg for Point<T>where
    T: CoordNum + Neg<Output = T>,

fn neg(self) -> Self::Output

Returns a point with the x and y components negated.

Examples

use geo_types::Point;

let p = -Point::new(-1.25, 2.5);

assert_eq!(p.x(), 1.25);
assert_eq!(p.y(), -2.5);

type Output = Point<T>

The resulting type after applying the - operator.

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

fn eq(&self, other: &Point<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Point for Point<T>where
    T: Float + RTreeNum,

type Scalar = T

The number type used by this point type.

const DIMENSIONS: usize = 2usize

The number of dimensions of this point type.

fn generate(generator: impl FnMut(usize) -> Self::Scalar) -> Self

Creates a new point value with given values for each dimension.

fn nth(&self, index: usize) -> Self::Scalar

Returns a single coordinate of this point.

fn nth_mut(&mut self, index: usize) -> &mut Self::Scalar

Mutable variant of nth.

impl<T> RelativeEq<Point<T>> for Point<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::Point;

let a = Point::new(2.0, 3.0);
let b = Point::new(2.0, 3.01);

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> Serialize for Point<T>where
    T: Serialize + CoordNum,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: CoordNum> Sub<Point<T>> for Point<T>

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

Subtract a point from the given point.

Examples

use geo_types::Point;

let p = Point::new(1.25, 3.0) - Point::new(1.5, 2.5);

assert_eq!(p.x(), -0.25);
assert_eq!(p.y(), 0.5);

type Output = Point<T>

The resulting type after applying the - operator.

impl<T: CoordNum> SubAssign<Point<T>> for Point<T>

fn sub_assign(&mut self, rhs: Self)

Subtract a point from the given point and assign it to the original point.

Examples

use geo_types::Point;

let mut p = Point::new(1.25, 2.5);
p -= Point::new(1.5, 2.5);

assert_eq!(p.x(), -0.25);
assert_eq!(p.y(), 0.0);

impl<T: CoordNum> TryFrom<Geometry<T>> for Point<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: Copy + CoordNum> Copy for Point<T>

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

impl<T: CoordNum> StructuralEq for Point<T>

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