Struct geo_types::Line

pub struct Line<T> where
    T: CoordNum,  {
    pub start: Coordinate<T>,
    pub end: Coordinate<T>,
}

A line segment made up of exactly two Coordinates.

Semantics

The interior and boundary are defined as with a LineString with the two end points.

Fields

start: Coordinate<T>

end: Coordinate<T>

Implementations

impl<T> Line<T> where
    T: CoordNum, 

pub fn new<C>(start: C, end: C) -> Line<T> where
    C: Into<Coordinate<T>>, 

Creates a new line segment.

Examples

use geo_types::{Coordinate, Line};

let line = Line::new(Coordinate { x: 0., y: 0. }, Coordinate { x: 1., y: 2. });

assert_eq!(line.start, Coordinate { x: 0., y: 0. });
assert_eq!(line.end, Coordinate { x: 1., y: 2. });

pub fn delta(&self) -> Coordinate<T>

Calculate the difference in coordinates (Δx, Δy).

pub fn dx(&self) -> T

Calculate the difference in ‘x’ components (Δx).

Equivalent to:

line.end.x - line.start.x

pub fn dy(&self) -> T

Calculate the difference in ‘y’ components (Δy).

Equivalent to:

line.end.y - line.start.y

pub fn slope(&self) -> T

Calculate the slope (Δy/Δx).

Equivalent to:

line.dy() / line.dx()

Note that:

Line::new(a, b).slope() == Line::new(b, a).slope()

pub fn determinant(&self) -> T

Calculate the determinant of the line.

Equivalent to:

line.start.x * line.end.y - line.start.y * line.end.x

Note that:

Line::new(a, b).determinant() == -Line::new(b, a).determinant()

pub fn start_point(&self) -> Point<T>

pub fn end_point(&self) -> Point<T>

pub fn points(&self) -> (Point<T>, Point<T>)

Trait Implementations

impl<T: AbsDiffEq<Epsilon = T> + CoordNum> AbsDiffEq<Line<T>> for Line<T>

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

Equality assertion with an absolute limit.

Examples

use geo_types::{Coordinate, Line};

let a = Line::new(Coordinate { x: 0., y: 0. }, Coordinate { x: 1., y: 1. });
let b = Line::new(Coordinate { x: 0., y: 0. }, Coordinate { x: 1.001, y: 1. });

approx::assert_abs_diff_eq!(a, b, epsilon=0.1);

type Epsilon = T

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: Clone> Clone for Line<T> where
    T: CoordNum, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Line<T> where
    T: CoordNum, 

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

Formats the value using the given formatter.

impl<T: CoordNum> From<[(T, T); 2]> for Line<T>

fn from(coord: [(T, T); 2]) -> Line<T>

Performs the conversion.

impl<T: CoordNum> From<Line<T>> for LineString<T>

fn from(line: Line<T>) -> Self

Performs the conversion.

impl<T: CoordNum> From<Line<T>> for Geometry<T>

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

Performs the conversion.

impl<T: Hash> Hash for Line<T> where
    T: CoordNum, 

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, 

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq<Line<T>> for Line<T> where
    T: CoordNum, 

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

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

fn ne(&self, other: &Line<T>) -> bool

This method tests for !=.

impl<T> PointDistance for Line<T> where
    T: Float + RTreeNum, 

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

Returns the squared euclidean distance of an object to a point.

fn contains_point(&self, point: &<Self::Envelope as Envelope>::Point) -> bool

Returns true if a point is contained within this object.

fn distance_2_if_less_or_equal(
    &self,
    point: &<Self::Envelope as Envelope>::Point,
    max_distance_2: <<Self::Envelope as Envelope>::Point as Point>::Scalar
) -> Option<<<Self::Envelope as Envelope>::Point as Point>::Scalar>

Returns the squared distance to this object or None if the distance is larger than a given maximum value.

impl<T> RTreeObject for Line<T> where
    T: Float + RTreeNum, 

type Envelope = AABB<Point<T>>

The object’s envelope type. Usually, AABB will be the right choice. This type also defines the objects dimensionality.

fn envelope(&self) -> Self::Envelope

Returns the object’s envelope.

impl<T> RelativeEq<Line<T>> for Line<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::{Coordinate, Line};

let a = Line::new(Coordinate { x: 0., y: 0. }, Coordinate { x: 1., y: 1. });
let b = Line::new(Coordinate { x: 0., y: 0. }, Coordinate { x: 1.001, y: 1. });

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: CoordNum> TryFrom<Geometry<T>> for Line<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> Copy for Line<T> where
    T: CoordNum, 

impl<T: Eq> Eq for Line<T> where
    T: CoordNum, 

impl<T> StructuralEq for Line<T> where
    T: CoordNum, 

impl<T> StructuralPartialEq for Line<T> where
    T: CoordNum,