Struct iron_shapes::vector::Vector

pub struct Vector<T> {
    pub x: T,
    pub y: T,
}

Vector defines a two dimensional vector with x and y components in the Euclidean plane.

Fields

x: T

x coordinate.

y: T

y coordinate.

Implementations

impl<T: CoordinateType> Vector<T>

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

Create a new vector with x and y coordinates.

Examples

use iron_shapes::vector::Vector;
let a = Vector::new(2, 3);
assert_eq!(a.x, 2);
assert_eq!(a.y, 3);

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 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 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);

impl<T: CoordinateType + NumCast> Vector<T>

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

Convert vector into a vector with floating point data type.

impl<T: CoordinateType + Float> Vector<T>

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 0.

Panics

Panics if the vector has length 0.

impl<T: CoordinateType + NumCast> Vector<T>

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> Add<Vector<T>> for Vector<T> where
    T: CoordinateType + Add<Output = T>, 

Vector addition.

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<Vector<T>> for Vector<T> where
    T: CoordinateType + AddAssign, 

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: Clone> Clone for Vector<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Vector<T>

impl<T> Debug for Vector<T> where
    T: Debug + Copy, 

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

Formats the value using the given formatter.

impl<T: Default> Default for Vector<T>

fn default() -> Vector<T>

Returns the "default value" for a type.

impl<T> Display for Vector<T> where
    T: Display + Copy, 

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

Formats the value using the given formatter.

impl<T> Div<T> for Vector<T> where
    T: CoordinateType + Div<Output = T>, 

Scalar division.

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Eq> Eq for Vector<T>

impl<T: CoordinateType> From<&'_ Vector<T>> for Point<T>

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

Performs the conversion.

impl<'a, T: CoordinateType> From<&'a (T, T)> for Vector<T>

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

Performs the conversion.

impl<'a, T: CoordinateType> From<&'a Vector<T>> for Vector<T>

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

Performs the conversion.

impl<T: CoordinateType> From<[T; 2]> for Vector<T>

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

Performs the conversion.

impl<T: CoordinateType> From<(T, T)> for Vector<T>

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

Performs the conversion.

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

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

Performs the conversion.

impl<T: Hash> Hash for Vector<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: CoordinateType> Into<(T, T)> for Vector<T>

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

Performs the conversion.

impl<T: CoordinateType> Into<(T, T)> for &Vector<T>

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

Performs the conversion.

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

fn into(self) -> Vector<T>

Performs the conversion.

impl<T: CoordinateType> MapPointwise<T> for Vector<T>

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

Point wise transformation.

impl<T> Mul<T> for Vector<T> where
    T: CoordinateType + Mul<Output = T>, 

Scalar multiplication.

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> MulAssign<T> for Vector<T> where
    T: CoordinateType + MulAssign<T>, 

In-place scalar multiplication.

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T> Neg for Vector<T> where
    T: CoordinateType, 

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: PartialEq> PartialEq<Vector<T>> for Vector<T>

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

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

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

This method tests for !=.

impl<T> StructuralEq for Vector<T>

impl<T> StructuralPartialEq for Vector<T>

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

Vector subtraction.

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<Vector<T>> for Point<T> where
    T: CoordinateType + 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> SubAssign<Vector<T>> for Vector<T> where
    T: CoordinateType + SubAssign, 

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<T: CoordinateType> Sum<Vector<T>> for Vector<T>

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

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

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl<T: CoordinateType + NumCast, Dst: CoordinateType + NumCast> TryCastCoord<T, Dst> for Vector<T>

type Output = Vector<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 vector of target data type.

Conversion from float to int can fail and will return None. Float values like infinity or non-a-number have no integer representation.

Examples

use iron_shapes::vector::Vector;
use iron_shapes::traits::TryCastCoord;

let v_int = Vector::new(1,2);
let maybe_v_float: Option<Vector<f64>> = v_int.try_cast();

assert_eq!(maybe_v_float, Some(Vector::new(1.0, 2.0)));

// Conversion from float to int can fail.

let w_float = Vector::new(42.0, 0. / 0.);
let maybe_w_int: Option<Vector<i32>> = w_float.try_cast();

assert_eq!(maybe_w_int, None);

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

Cast to target data type.

impl<T: CoordinateType> Zero for Vector<T>

fn zero() -> Self

Get zero-vector.

Examples

use iron_shapes::vector::{Vector, Zero};

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

assert_eq!(a, b);

fn is_zero(&self) -> bool

Check if this is the zero-vector.

Examples

use iron_shapes::vector::{Vector, Zero};

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

pub fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.