Struct Coordinate 

pub struct Coordinate(pub f64, pub f64);

This structure conceptually represents a point or a vector on the 2-dimensional Cartesian plane.

It may be vary on the context which represents which.

Tuple Fields

0: f64

x-component of the Cartesian coordinates.

1: f64

y-component of the Cartesian coordinates.

Implementations

impl Coordinate

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

Creates and returns a Coordinate w.r.t. the given argument.

Argument

• x: x-component of the Coordinate.
• y: y-component of the Coordinate.

Example

let c1 = geo_buf::Coordinate::new(3., 4.);
assert_eq!(c1, (3., 4.).into());

pub fn get_val(&self) -> (f64, f64)

Returns a tuple wihch has values of each component.

Example

let c1 = geo_buf::Coordinate::new(3., 4.);
let t1 = c1.get_val();
assert_eq!(t1, (3., 4.));

pub fn inner_product(&self, rhs: &Self) -> f64

Returns a value of inner product (i.e. dot product) of the Cartesian coordinates of two vectors.

Argument

• self: The Cartesian coordinates of the first vector, a.
• rhs: The Cartesian coordinates of the second vector, b.

Return

a · b

Example

let c1 = geo_buf::Coordinate::new(1., 2.);
let c2 = geo_buf::Coordinate::new(3., 4.);
let ip = c1.inner_product(&c2);
assert_eq!(ip, 11.);

Notes

• This operation is linear.
• This operation is commutative.

pub fn outer_product(&self, rhs: &Self) -> f64

Returns a value of the magnitude of cross product of the Cartesian coordinates of two vectors.

Argument

• self: The Cartesian coordinates of the first vector, a.
• rhs: The Cartesian coordinates of the second vector, b.

Return

a × b

Example

let c1 = geo_buf::Coordinate::new(1., 2.);
let c2 = geo_buf::Coordinate::new(3., 4.);
let op = c1.outer_product(&c2);
assert_eq!(op, -2.);

Notes

• This operation is linear.
• This operation is not commutative. (More precisely, it is anti-commutative.)
• The sign of cross product indicates the orientation of a and b. If a lies before b in the counter-clockwise (CCW for short) ordering, the sign of the result will be positive. If a lies after b in CCW ordering, the sign will be negative. The result will be zero if two vectors are colinear. (I.e. lay on the same line.)

pub fn norm(&self) -> f64

Returns the Euclidean norm (i.e. magnitude, or L2 norm) of the given vector.

Example

let c1 = geo_buf::Coordinate::new(3., 4.);
assert_eq!(c1.norm(), 5.);

pub fn dist_coord(&self, rhs: &Coordinate) -> f64

Returns the distance between two Cartesian coordinates.

Example

let c1 = geo_buf::Coordinate::new(3., 4.);
let c2 = geo_buf::Coordinate::new(7., 7.);
assert_eq!(c1.dist_coord(&c2), 5.);

pub fn dist_ray(&self, rhs: &Ray) -> f64

Returns the distance from self to the given ray.

Note that this function considers the given ray as a open-ended line. That is, the foot of perpendicular may lay on the extended line of the given ray.

Example

use geo_buf::{Coordinate, Ray};

let r1 = Ray::new((0., 3.).into(), (4., 0.).into());
let c1 = Coordinate::new(0., 0.);
assert_eq!(c1.dist_ray(&r1), 2.4);

pub fn eq(&self, rhs: &Self) -> bool

Checks whether the given two Cartesian coordinates are the same (by the equality test with a small epsilon).

Result

• true if the given coordinates are the same.
• false otherwise.

Example

let c1 = geo_buf::Coordinate::new(0.1, 0.2);
let c2 = geo_buf::Coordinate::new(0.2, 0.3);
let c3 = geo_buf::Coordinate::new(0.3, 0.5);
let c4 = c1 + c2;
assert!(c3.eq(&c4));

Example (this example panics)

let c1 = geo_buf::Coordinate::new(0.1, 0.2);
let c2 = geo_buf::Coordinate::new(0.2, 0.3);
let c3 = geo_buf::Coordinate::new(0.3, 0.5);
let c4 = c1 + c2;
assert_eq!(c3, c4); // should panic since 0.1 + 0.2 != 0.3 due to floating point errors

Trait Implementations

impl Add for Coordinate

type Output = Coordinate

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Coordinate

fn clone(&self) -> Coordinate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Coordinate

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

Formats the value using the given formatter.

impl Default for Coordinate

fn default() -> Coordinate

Returns the “default value” for a type.

impl Div<f64> for Coordinate

type Output = Coordinate

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Coordinate

type Output = f64

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<(f64, f64)> for Coordinate

fn from(item: (f64, f64)) -> Coordinate

Converts to this type from the input type.

impl From<Coord> for Coordinate

fn from(value: Coord<f64>) -> Self

Converts to this type from the input type.

impl From<Coordinate> for (f64, f64)

fn from(item: Coordinate) -> (f64, f64)

Converts to this type from the input type.

impl From<Coordinate> for Coord<f64>

fn from(value: Coordinate) -> Coord<f64>

Converts to this type from the input type.

impl Mul<f64> for Coordinate

type Output = Coordinate

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for Coordinate

fn eq(&self, other: &Coordinate) -> 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 PartialOrd for Coordinate

fn partial_cmp(&self, other: &Coordinate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Coordinate

type Output = Coordinate

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Coordinate

impl StructuralPartialEq for Coordinate