Struct geocoding::Point

pub struct Point<T>(pub Coordinate<T>)
 where
    T: CoordinateType;

A single Point in 2D space.

Points can be created using the new(x, y) constructor, or from a Coordinate or pair of points.

use geo::{Point, Coordinate};
let p1: Point<f64> = (0., 1.).into();
let c = Coordinate{ x: 10., y: 20.};
let p2: Point<f64> = c.into();

Methods

impl<T> Point<T> where
    T: CoordinateType + ToPrimitive, 

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

Creates a new point.

use geo::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.

use geo::Point;

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

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

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

Sets the x/horizontal component of the point.

use geo::Point;

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

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

pub fn y(&self) -> T

Returns the y/vertical component of the point.

use geo::Point;

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

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

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

Sets the y/vertical component of the point.

use geo::Point;

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

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

pub fn lng(&self) -> T

Returns the longitude/horizontal component of the point.

use geo::Point;

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

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

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

Sets the longitude/horizontal component of the point.

use geo::Point;

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

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

pub fn lat(&self) -> T

Returns the latitude/vertical component of the point.

use geo::Point;

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

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

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

Sets the latitude/vertical component of the point.

use geo::Point;

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

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

pub fn dot(&self, point: &Point<T>) -> T

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

use geo::Point;

let p = Point::new(1.5, 0.5);
let dot = p.dot(&Point::new(2.0, 4.5));

assert_eq!(dot, 5.25);

pub fn cross_prod(&self, point_b: &Point<T>, point_c: &Point<T>) -> T where
    T: Float, 

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

Examples

use geo::Point;
 
let p_a = Point::new(1.0, 2.0);
let p_b = Point::new(3.0,5.0);
let p_c = Point::new(7.0,12.0);
 
let cross = p_a.cross_prod(&p_b, &p_c);
 
assert_eq!(cross, 2.0)

Trait Implementations

impl<T> PointN for Point<T> where
    T: Float + SpadeNum + Debug, 

type Scalar = T

The points's internal scalar type.

fn dimensions() -> usize

The (fixed) number of dimensions of this point type.

fn from_value(value: <Point<T> as PointN>::Scalar) -> Point<T>

Creates a new point with all components set to a certain value.

fn nth(&self, index: usize) -> &<Point<T> as PointN>::Scalar

Returns the nth element of this point.

fn nth_mut(&mut self, index: usize) -> &mut <Point<T> as PointN>::Scalar

Returns a mutable reference to the nth element of this point.

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

type Output = Point<T>

The resulting type after applying the - operator.

fn neg(self) -> Point<T>

Returns a point with the x and y components negated.

use geo::Point;

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

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

impl<T> Centroid<T> for Point<T> where
    T: Float, 

type Output = Point<T>

fn centroid(&self) -> <Point<T> as Centroid<T>>::Output

See: https://en.wikipedia.org/wiki/Centroid

impl<T> Serialize for Point<T> where
    T: CoordinateType + Serialize, 

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

Serialize this value into the given Serde serializer.

impl<T> Sub<Point<T>> for Point<T> where
    T: CoordinateType + ToPrimitive, 

type Output = Point<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Point<T>) -> Point<T>

Subtract a point from the given point.

use geo::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);

impl<T> Rotate<T> for Point<T> where
    T: Float, 

fn rotate(&self, angle: T) -> Point<T>

Rotate the Point about itself by the given number of degrees This operation leaves the point coordinates unchanged

impl<T> TwoDimensional for Point<T> where
    T: Float + SpadeNum + Debug, 

impl<T> Copy for Point<T> where
    T: Copy + CoordinateType, 

impl<T> MapCoordsInplace<T> for Point<T> where
    T: CoordinateType, 

fn map_coords_inplace(&mut self, func: &Fn(&(T, T)))

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

impl<T, NT> MapCoords<T, NT> for Point<T> where
    NT: CoordinateType,
    T: CoordinateType, 

type Output = Point<NT>

fn map_coords(
    &self,
    func: &Fn(&(T, T))
) -> <Point<T> as MapCoords<T, NT>>::Output

Apply a function to all the coordinates in a geometric object, returning a new object.

impl<T> PartialEq<Point<T>> for Point<T> where
    T: PartialEq<T> + CoordinateType, 

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

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

fn ne(&self, __arg_0: &Point<T>) -> bool

This method tests for !=.

impl<T> Clone for Point<T> where
    T: Clone + CoordinateType, 

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> Add<Point<T>> for Point<T> where
    T: CoordinateType + ToPrimitive, 

type Output = Point<T>

The resulting type after applying the + operator.

fn add(self, rhs: Point<T>) -> Point<T>

Add a point to the given point.

use geo::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);

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

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

Deserialize this value from the given Serde deserializer.

impl<T> Distance<T, Point<T>> for MultiPolygon<T> where
    T: Float, 

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

Minimum distance from a MultiPolygon to a Point

impl<T> Distance<T, MultiPolygon<T>> for Point<T> where
    T: Float, 

fn distance(&self, mpolygon: &MultiPolygon<T>) -> T

Minimum distance from a Point to a MultiPolygon

impl<T> Distance<T, MultiLineString<T>> for Point<T> where
    T: Float, 

fn distance(&self, mls: &MultiLineString<T>) -> T

Minimum distance from a Point to a MultiLineString

impl<T> Distance<T, Polygon<T>> for Point<T> where
    T: Float, 

fn distance(&self, polygon: &Polygon<T>) -> T

Minimum distance from a Point to a Polygon

impl<T> Distance<T, Point<T>> for LineString<T> where
    T: Float, 

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

Minimum distance from a LineString to a Point

impl<T> Distance<T, Point<T>> for Line<T> where
    T: Float, 

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

Minimum distance from a Line to a Point

impl<T> Distance<T, Line<T>> for Point<T> where
    T: Float, 

fn distance(&self, line: &Line<T>) -> T

Minimum distance from a Line to a Point

impl<T> Distance<T, LineString<T>> for Point<T> where
    T: Float, 

fn distance(&self, linestring: &LineString<T>) -> T

Minimum distance from a Point to a LineString

impl<T> Distance<T, Point<T>> for MultiLineString<T> where
    T: Float, 

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

Minimum distance from a MultiLineString to a Point

impl<T> Distance<T, Point<T>> for Point<T> where
    T: Float, 

fn distance(&self, p: &Point<T>) -> T

Minimum distance between two Points

impl<T> Distance<T, Point<T>> for Polygon<T> where
    T: Float, 

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

Minimum distance from a Polygon to a Point

impl<T> Distance<T, MultiPoint<T>> for Point<T> where
    T: Float, 

fn distance(&self, points: &MultiPoint<T>) -> T

Minimum distance from a Point to a MultiPoint

impl<T> Distance<T, Point<T>> for MultiPoint<T> where
    T: Float, 

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

Minimum distance from a MultiPoint to a Point

impl<T> Bearing<T> for Point<T> where
    T: Float + FromPrimitive, 

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

Returns the bearing to another Point in degrees, where North is 0° and East is 45°.

impl<F> ClosestPoint<F, Point<F>> for Polygon<F> where
    F: Float, 

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<F> ClosestPoint<F, Point<F>> for MultiPolygon<F> where
    F: Float, 

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<'a, F, C> ClosestPoint<F, Point<F>> for &'a C where
    C: ClosestPoint<F, Point<F>>,
    F: Float, 

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<F> ClosestPoint<F, Point<F>> for Line<F> where
    F: Float, 

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<F> ClosestPoint<F, Point<F>> for MultiLineString<F> where
    F: Float, 

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<F> ClosestPoint<F, Point<F>> for Point<F> where
    F: Float, 

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<F> ClosestPoint<F, Point<F>> for LineString<F> where
    F: Float, 

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<F> ClosestPoint<F, Point<F>> for MultiPoint<F> where
    F: Float, 

fn closest_point(&self, p: &Point<F>) -> Closest<F>

Find the closest point between self and p.

impl<T> Intersects<Line<T>> for Point<T> where
    T: Float, 

fn intersects(&self, line: &Line<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> Intersects<Point<T>> for Line<T> where
    T: Float, 

fn intersects(&self, p: &Point<T>) -> bool

Checks if the geometry A intersects the geometry B.

impl<T> HaversineDistance<T, Point<T>> for Point<T> where
    T: Float + FromPrimitive, 

fn haversine_distance(&self, rhs: &Point<T>) -> T

Returns the Haversine distance between two points:

impl<T> From<Point<T>> for Geometry<T> where
    T: CoordinateType, 

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

Performs the conversion.

impl<T> From<(T, T)> for Point<T> where
    T: CoordinateType, 

fn from(coords: (T, T)) -> Point<T>

Performs the conversion.

impl<T> From<Coordinate<T>> for Point<T> where
    T: CoordinateType, 

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

Performs the conversion.

impl<T> Contains<Point<T>> for Point<T> where
    T: Float + ToPrimitive, 

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

Checks if the geometry A is completely inside the B geometry.

impl<T> Contains<Point<T>> for Bbox<T> where
    T: CoordinateType, 

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

Checks if the geometry A is completely inside the B geometry.

impl<T> Contains<Point<T>> for LineString<T> where
    T: Float, 

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

Checks if the geometry A is completely inside the B geometry.

impl<T> Contains<Point<T>> for MultiPolygon<T> where
    T: Float, 

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

Checks if the geometry A is completely inside the B geometry.

impl<T> Contains<Point<T>> for Line<T> where
    T: Float, 

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

Checks if the geometry A is completely inside the B geometry.

impl<T> Contains<Point<T>> for Polygon<T> where
    T: Float, 

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

Checks if the geometry A is completely inside the B geometry.

impl<T> Debug for Point<T> where
    T: Debug + CoordinateType, 

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> HaversineDestination<T> for Point<T> where
    T: Float + FromPrimitive, 

fn haversine_destination(&self, bearing: T, distance: T) -> Point<T>

Returns a new Point using distance to the existing Point and a bearing for the direction