Struct iron_shapes::point::Point

pub struct Point<T> { /* private fields */ }

A point is defined by a x and y coordinate in the euclidean plane.

Implementations

impl<T> Point<T>

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

Create a new point with x and y coordinates.

impl<T: Copy> Point<T>

pub fn v(&self) -> Vector<T>

Return the location of this point as a vector.

impl<T: Zero> Point<T>

pub fn zero() -> Self

Get zero-Point.

Examples

use iron_shapes::point::Point;

let a = Point::zero();
let b = Point::new(0, 0);

assert_eq!(a, b);

pub fn is_zero(&self) -> bool

Check if this is the zero-Point.

Examples

use iron_shapes::point::*;

assert!(Point::<usize>::zero().is_zero());

impl<T: Copy + Mul<Output = T> + Add<Output = T> + Sub<Output = T>> Point<T>

pub fn distance_sq(self, other: &Point<T>) -> T

Compute the squared distance to the other point.

Examples

use iron_shapes::point::*;

let a = Point::new(0, 0);
let b = Point::new(2, 0);
assert_eq!(a.distance_sq(&b), 2*2);

pub fn cross_prod3(&self, b: Point<T>, c: Point<T>) -> T

Calculate the cross product of the two vectors defined by three points.

A positive value implies that self → a → b is counter-clockwise, negative implies clockwise.

(b - self) x (c - b)

Examples

use iron_shapes::point::Point;

let a = Point::new(1,0);
let b = Point::new(1,1);
let c = Point::new(0,1);

let p = a.cross_prod3(b, c);

assert_eq!(p, (b-a).cross_prod(c - b));

impl<T: Copy + Sub<Output = T> + NumCast> Point<T>

pub fn distance<F: Float>(self, other: &Point<T>) -> F

Compute the Euclidean distance betwen two points.

impl<T: Copy + NumCast> Point<T>

pub fn cast_to_float<F: Float + NumCast>(&self) -> Point<F>

Convert Point into a Point with floating point data type.

Methods from Deref<Target = Vector<T>>

pub fn norm1(&self) -> T

Get 1-norm of vector, i.e. the sum of the absolute values of its components.

Examples

use iron_shapes::vector::Vector;
let a = Vector::new(-2, 3);
assert_eq!(a.norm1(), 5);

pub fn orientation_of(&self, other: Self) -> Orientation

Check if other is oriented clockwise or counter-clockwise respective to self.

Examples

use iron_shapes::vector::Vector;
use iron_shapes::types::Orientation;

let a = Vector::new(1, 0);
let b = Vector::new(1, 1);
let c = Vector::new(1, -1);
let d = Vector::new(2, 0);

assert_eq!(a.orientation_of(b), Orientation::CounterClockWise);
assert_eq!(a.orientation_of(c), Orientation::ClockWise);
assert_eq!(a.orientation_of(d), Orientation::Straight);

pub fn norm2_squared(&self) -> T

Get squared 2-norm of vector.

Examples

use iron_shapes::vector::Vector;
let a = Vector::new(2, 3);
assert_eq!(a.norm2_squared(), 2*2+3*3);

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

Calculate scalar product.

Examples

use iron_shapes::vector::Vector;

let a = Vector::new(1, 2);
let b = Vector::new(3, 4);

assert_eq!(a.dot(b), 1*3 + 2*4);

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

Calculate cross product.

Examples

use iron_shapes::vector::Vector;

let a = Vector::new(2, 0);
let b = Vector::new(0, 2);

assert_eq!(a.cross_prod(b), 4);
assert_eq!(b.cross_prod(a), -4);

pub fn cast_to_float<F: CoordinateType + Float + NumCast>(&self) -> Vector<F>

Convert vector into a vector with floating point data type.

pub fn norm2(&self) -> T

Get 2-norm of vector (length of vector).

Examples

use iron_shapes::vector::Vector;
let a = Vector::new(2.0, 3.0);
let norm2 = a.norm2();
let norm2_sq = norm2 * norm2;
let expected = a.norm2_squared();
assert!(norm2_sq < expected + 1e-12);
assert!(norm2_sq > expected - 1e-12);

pub fn normalized(&self) -> Self

Return a vector with the same direction but length 1.

Panics

Panics if the vector has length 0.

pub fn normal(&self) -> Self

Return the normal vector onto this vector. The normal has length 1.

Panics

Panics if the vector has length 0.

pub fn length<F: Float>(&self) -> F

Calculate length of vector.

Similar to Vector::norm2 but does potentially return another data type for the length.

Examples

use iron_shapes::vector::Vector;
let a = Vector::new(2.0, 3.0);
let length: f64 = a.length();
let norm2_sq = length * length;
let expected = a.norm2_squared();
assert!(norm2_sq < expected + 1e-12);
assert!(norm2_sq > expected - 1e-12);

Trait Implementations

impl<T, V> Add<V> for Point<T> where
    T: Copy + Add<Output = T>,
    V: Into<Point<T>>, 

Point addition.

type Output = Point<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, V> AddAssign<V> for Point<T> where
    T: Copy + AddAssign<T>,
    V: Into<Vector<T>>, 

fn add_assign(&mut self, rhs: V)

Performs the += operation.

impl<T: Copy> BoundingBox<T> for Point<T>

fn bounding_box(&self) -> Rect<T>

Return the bounding box of this geometry.

impl<T: Clone> 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 for Point<T> where
    T: Debug, 

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

Formats the value using the given formatter.

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

fn default() -> Point<T>

Returns the “default value” for a type.

impl<T> Deref for Point<T>

type Target = Vector<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Point<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Display for Point<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T> Div<T> for Point<T> where
    T: Copy + Div<Output = T>, 

Scalar division.

type Output = Point<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, T: Copy> From<&'a (T, T)> for Point<T>

fn from(coords: &'a (T, T)) -> Self

Converts to this type from the input type.

impl<'a, T: Copy> From<&'a Point<T>> for Point<T>

fn from(v: &'a Point<T>) -> Self

Converts to this type from the input type.

impl<T: Copy> From<&Vector<T>> for Point<T>

fn from(v: &Vector<T>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<T> From<Point<T>> for Geometry<T>

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

Converts to this type from the input type.

impl<T> From<Vector<T>> for Point<T>

fn from(v: Vector<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> 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, 

Feeds a slice of this type into the given Hasher.

impl<T: Copy> Into<(T, T)> for &Point<T>

fn into(self) -> (T, T)

Converts this type into the (usually inferred) input type.

impl<T: Copy> Into<(T, T)> for Point<T>

fn into(self) -> (T, T)

Converts this type into the (usually inferred) input type.

impl<T> Into<Vector<T>> for Point<T>

fn into(self) -> Vector<T>

Converts this type into the (usually inferred) input type.

impl<T: Copy> MapPointwise<T> for Point<T>

Point wise transformation for a single point.

fn transform<F>(&self, transformation: F) -> Self where
    F: Fn(Point<T>) -> Point<T>, 

Point wise transformation.

impl<T> Mul<T> for Point<T> where
    T: Copy + Mul<Output = T>, 

Scalar multiplication.

type Output = Point<T>

The resulting type after applying the * operator.

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

Performs the * operation.

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

In-place scalar multiplication.

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

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

type Output = Point<T>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: Ord> Ord for Point<T>

Compare points.

The ordering is determined by the x-coordinates. If it is the same for both points the y-coordinate is used.

Point a > Point b iff a.x > b.x || (a.x == b.x && a.y > b.y).

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

fn eq(&self, other: &Self) -> 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 !=.

impl<T: PartialOrd> PartialOrd<Point<T>> for Point<T>

Compare points.

The ordering is determined by the x-coordinates. If it is the same for both points the y-coordinate is used.

Point a > Point b iff a.x > b.x || (a.x == b.x && a.y > b.y).

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<C> PointBase<C> for Point<C::Coord> where
    C: CoordinateBase, 

fn new(x: C::Coord, y: C::Coord) -> Self

Construct a new point.

fn get(&self, orient: Orientation2D) -> C::Coord

Get a coordinate value.

fn set(&mut self, orient: Orientation2D, value: C::Coord)

Set a coordinate value.

fn x(&self) -> C::Coord

Get the x-coordinate value.

fn y(&self) -> C::Coord

Get the y-coordinate value.

impl<C> PointConcept<C> for Point<C::Coord> where
    C: CoordinateConcept, 

fn projected_distance(
    &self,
    other: &Self,
    orient: Orientation2D
) -> C::CoordinateDifference

Compute the x or y component of the vector from the point to the other point.

fn manhattan_distance(&self, other: &Self) -> C::CoordinateDifference

Compute the 1-norm of the vector pointing from the point to the other.

fn distance_squared(&self, other: &Self) -> C::CoordinateDistance

Squared euclidean distance.

fn euclidian_distance(&self, other: &Self) -> C::CoordinateDistance

Euclidean distance, i.e. 2-norm of the vector from the point to the other.

impl<T> Sub<Point<T>> for Point<T> where
    T: Copy + Sub<Output = T>, 

Subtract a point.

type Output = Vector<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<Vector<T>> for Point<T> where
    T: Copy + Sub<Output = T>, 

Subtract a vector.

type Output = Point<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, V> SubAssign<V> for Point<T> where
    T: Copy + SubAssign<T>,
    V: Into<Vector<T>>, 

fn sub_assign(&mut self, rhs: V)

Performs the -= operation.

impl<T: Copy + Zero + Add<Output = T>> Sum<Point<T>> for Point<T>

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Compute the sum of all points in the iterator. If the iterator is empty, (0, 0) is returned.

impl<T: Copy> TryBoundingBox<T> for Point<T>

fn try_bounding_box(&self) -> Option<Rect<T>>

Return the bounding box of this geometry if a bounding box is defined.

impl<T: Copy + NumCast, Dst: Copy + NumCast> TryCastCoord<T, Dst> for Point<T>

type Output = Point<Dst>

Output type of the cast. This is likely the same geometrical type just with other coordinate types.

fn try_cast(&self) -> Option<Self::Output>

Try to cast to target data type.

fn cast(&self) -> Self::Output

Cast to target data type.

impl<T: Copy> Copy for Point<T>

impl<T: PartialEq> Eq for Point<T>