Struct agb_fixnum::Vector2D

pub struct Vector2D<T: Number> {
    pub x: T,
    pub y: T,
}

A vector of two points: (x, y) represented by integers or fixed point numbers

Fields

x: T

The x coordinate

y: T

The y coordinate

Implementations

impl<T: FixedWidthSignedInteger> Vector2D<T>

pub fn abs(self) -> Self

Calculates the absolute value of the x and y components.

impl<I: FixedWidthUnsignedInteger, const N: usize> Vector2D<Num<I, N>>

pub fn trunc(self) -> Vector2D<I>

Truncates the x and y coordinate, see Num::trunc

let v1: Vector2D<Num<i32, 8>> = (num!(1.56), num!(-2.2)).into();
let v2: Vector2D<i32> = (1, -2).into();
assert_eq!(v1.trunc(), v2);

pub fn floor(self) -> Vector2D<I>

Floors the x and y coordinate, see Num::floor

let v1: Vector2D<Num<i32, 8>> = Vector2D::new(num!(1.56), num!(-2.2));
let v2: Vector2D<i32> = (1, -3).into();
assert_eq!(v1.floor(), v2);

pub fn try_change_base<J: FixedWidthUnsignedInteger + TryFrom<I>, const M: usize>( self ) -> Option<Vector2D<Num<J, M>>>

Attempts to change the base returning None if the numbers cannot be represented

impl<const N: usize> Vector2D<Num<i32, N>>

pub fn magnitude_squared(self) -> Num<i32, N>

Calculates the magnitude squared, ie (xx + yy)

let v1: Vector2D<Num<i32, 8>> = (num!(3.), num!(4.)).into();
assert_eq!(v1.magnitude_squared(), 25.into());

pub fn manhattan_distance(self) -> Num<i32, N>

Calculates the manhattan distance, x.abs() + y.abs().

let v1: Vector2D<Num<i32, 8>> = (num!(3.), num!(4.)).into();
assert_eq!(v1.manhattan_distance(), 7.into());

pub fn magnitude(self) -> Num<i32, N>

Calculates the magnitude by square root

let v1: Vector2D<Num<i32, 8>> = (num!(3.), num!(4.)).into();
assert_eq!(v1.magnitude(), 5.into());

pub fn fast_magnitude(self) -> Num<i32, N>

Calculates the magnitude of a vector using the alpha max plus beta min algorithm this has a maximum error of less than 4% of the true magnitude, probably depending on the size of your fixed point approximation

let v1: Vector2D<Num<i32, 8>> = (num!(3.), num!(4.)).into();
assert!(v1.fast_magnitude() > num!(4.9) && v1.fast_magnitude() < num!(5.1));

pub fn normalise(self) -> Self

Normalises the vector to magnitude of one by performing a square root, due to fixed point imprecision this magnitude may not be exactly one

let v1: Vector2D<Num<i32, 8>> = (num!(4.), num!(4.)).into();
assert_eq!(v1.normalise().magnitude(), 1.into());

pub fn fast_normalise(self) -> Self

Normalises the vector to magnitude of one using Vector2D::fast_magnitude.

let v1: Vector2D<Num<i32, 8>> = (num!(4.), num!(4.)).into();
assert_eq!(v1.fast_normalise().magnitude(), 1.into());

impl<T: Number> Vector2D<T>

pub fn change_base<U: Number + From<T>>(self) -> Vector2D<U>

Converts the representation of the vector to another type

let v1: Vector2D<i16> = Vector2D::new(1, 2);
let v2: Vector2D<i32> = v1.change_base();

impl<I: FixedWidthSignedInteger, const N: usize> Vector2D<Num<I, N>>

pub fn new_from_angle(angle: Num<I, N>) -> Self

Creates a unit vector from an angle, noting that the domain of the angle is [0, 1], see Num::cos and Num::sin.

let v: Vector2D<Num<i32, 8>> = Vector2D::new_from_angle(num!(0.0));
assert_eq!(v, (num!(1.0), num!(0.0)).into());

impl<T: Number> Vector2D<T>

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

Created a vector from the given coordinates

let v = Vector2D::new(1, 2);
assert_eq!(v.x, 1);
assert_eq!(v.y, 2);

pub fn get(self) -> (T, T)

Returns the tuple of the coordinates

let v = Vector2D::new(1, 2);
assert_eq!(v.get(), (1, 2));

pub fn hadamard(self, other: Self) -> Self

Calculates the hadamard product of two vectors

let v1 = Vector2D::new(2, 3);
let v2 = Vector2D::new(4, 5);

let r = v1.hadamard(v2);
assert_eq!(r, Vector2D::new(v1.x * v2.x, v1.y * v2.y));

pub fn swap(self) -> Self

Swaps the x and y coordinate

let v1 = Vector2D::new(2, 3);
assert_eq!(v1.swap(), Vector2D::new(3, 2));

Trait Implementations

impl<T: Number> Add for Vector2D<T>

type Output = Vector2D<T>

The resulting type after applying the + operator.

fn add(self, rhs: Vector2D<T>) -> Self::Output

Performs the + operation.

impl<T: Number> AddAssign for Vector2D<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T: Clone + Number> Clone for Vector2D<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Number> Debug for Vector2D<T>

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

Formats the value using the given formatter.

impl<T: Default + Number> Default for Vector2D<T>

fn default() -> Vector2D<T>

Returns the “default value” for a type.

impl<T, U: Copy> Div<U> for Vector2D<T>

where T: Div<U, Output = T> + Number,

type Output = Vector2D<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, U: Copy> DivAssign<U> for Vector2D<T>

where T: Div<U, Output = T> + Number,

fn div_assign(&mut self, rhs: U)

Performs the /= operation.

impl<T: Number, P: Number + Into<T>> From<(P, P)> for Vector2D<T>

fn from(f: (P, P)) -> Self

Converts to this type from the input type.

impl<I: FixedWidthUnsignedInteger, const N: usize> From<Vector2D<I>> for Vector2D<Num<I, N>>

fn from(n: Vector2D<I>) -> Self

Converts to this type from the input type.

impl<T: Hash + Number> Hash for Vector2D<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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, U: Copy> Mul<U> for Vector2D<T>

where T: Mul<U, Output = T> + Number,

type Output = Vector2D<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, U: Copy> MulAssign<U> for Vector2D<T>

where T: Mul<U, Output = T> + Number,

fn mul_assign(&mut self, rhs: U)

Performs the *= operation.

impl<T: Number + Neg<Output = T>> Neg for Vector2D<T>

type Output = Vector2D<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T: PartialEq + Number> PartialEq for Vector2D<T>

fn eq(&self, other: &Vector2D<T>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Number> Sub for Vector2D<T>

type Output = Vector2D<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Number> SubAssign for Vector2D<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<T: Copy + Number> Copy for Vector2D<T>

impl<T: Eq + Number> Eq for Vector2D<T>

impl<T: Number> StructuralPartialEq for Vector2D<T>