Struct Vector2D 

#[repr(C)]
pub struct Vector2D<T>
where
    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> Vector2D<T>

where T: Number + Signed,

pub fn abs(self) -> Vector2D<T>

Calculates the absolute value of the x and y components.

pub fn manhattan_distance(self) -> T

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

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

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

where I: FixedWidthUnsignedInteger,

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>> = vec2(num!(1.56), num!(-2.2));
let v2: Vector2D<i32> = (1, -3).into();
assert_eq!(v1.floor(), v2);

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

Rounds the x and y coordinate, see Num::round

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

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

where J: FixedWidthUnsignedInteger + TryFrom<I>,

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

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

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) -> Vector2D<Num<i32, N>>

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) -> Vector2D<Num<i32, N>>

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> Vector2D<T>

where T: Number,

pub fn change_base<U>(self) -> Vector2D<U>

where U: Number + From<T>,

Converts the representation of the vector to another type

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

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

where I: FixedWidthSignedInteger,

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

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> Vector2D<T>

where T: Number,

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

Created a vector from the given coordinates.

You should use vec2() instead.

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 = vec2(1, 2);
assert_eq!(v.get(), (1, 2));

pub fn hadamard(self, other: Vector2D<T>) -> Vector2D<T>

Calculates the hadamard product of two vectors

let v1 = vec2(2, 3);
let v2 = vec2(4, 5);

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

pub fn dot(self, b: Vector2D<T>) -> T

Calculates the dot product / scalar product of two vectors

use agb_fixnum::vec2;

let v1 = vec2(3, 5);
let v2 = vec2(7, 11);

let dot = v1.dot(v2);
assert_eq!(dot, 76);

The dot product for vectors A and B is defined as

A_x × B_x + A_y × B_y.

pub fn cross(self, b: Vector2D<T>) -> T

Calculates the z component of the cross product / vector product of two vectors

use agb_fixnum::vec2;

let v1 = vec2(3, 5);
let v2 = vec2(7, 11);

let dot = v1.cross(v2);
assert_eq!(dot, -2);

The z component cross product for vectors A and B is defined as

A_x × B_y - A_y × B_x.

Normally the cross product / vector product is itself a vector. This is in the 3D case where the cross product of two vectors is perpendicular to both vectors. The only vector perpendicular to two 2D vectors is purely in the z direction, hence why this method only returns that component. The x and y components are always zero.

pub fn swap(self) -> Vector2D<T>

Swaps the x and y coordinate

let v1 = vec2(2, 3);
assert_eq!(v1.swap(), vec2(3, 2));

pub fn magnitude_squared(self) -> T

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

Trait Implementations

impl<T> Add for Vector2D<T>

where T: Number,

type Output = Vector2D<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign for Vector2D<T>

where T: Number,

fn add_assign(&mut self, rhs: Vector2D<T>)

Performs the += operation.

impl<T> Clone for Vector2D<T>

where T: Clone + Number,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Vector2D<T>

where T: Debug + Number,

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

Formats the value using the given formatter.

impl<T> Default for Vector2D<T>

where T: Default + Number,

fn default() -> Vector2D<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Vector2D<T>

where T: Number + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Vector2D<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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

type Output = Vector2D<T>

The resulting type after applying the / operator.

fn div(self, rhs: U) -> <Vector2D<T> as Div<U>>::Output

Performs the / operation.

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

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

fn div_assign(&mut self, rhs: U)

Performs the /= operation.

impl<T, P> From<(P, P)> for Vector2D<T>

where T: Number, P: Number + Into<T>,

fn from(f: (P, P)) -> Vector2D<T>

Converts to this type from the input type.

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

where I: FixedWidthUnsignedInteger,

fn from(n: Vector2D<I>) -> Vector2D<Num<I, N>>

Converts to this type from the input type.

impl<T> Hash for Vector2D<T>

where T: Hash + Number,

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

where __H: Hasher,

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> Mul<U> for Vector2D<T>

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

type Output = Vector2D<T>

The resulting type after applying the * operator.

fn mul(self, rhs: U) -> <Vector2D<T> as Mul<U>>::Output

Performs the * operation.

impl<T: SignedNumber> Mul<Vector2D<T>> for AffineMatrix<T>

type Output = Vector2D<T>

The resulting type after applying the * operator.

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

Performs the * operation.

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

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

fn mul_assign(&mut self, rhs: U)

Performs the *= operation.

impl<T> Neg for Vector2D<T>

where T: Number + Neg<Output = T>,

type Output = Vector2D<T>

The resulting type after applying the - operator.

fn neg(self) -> <Vector2D<T> as Neg>::Output

Performs the unary - operation.

impl<T> PartialEq for Vector2D<T>

where T: PartialEq + Number,

fn eq(&self, other: &Vector2D<T>) -> 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<T> Serialize for Vector2D<T>

where T: Number + Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Sub for Vector2D<T>

where T: Number,

type Output = Vector2D<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign for Vector2D<T>

where T: Number,

fn sub_assign(&mut self, rhs: Vector2D<T>)

Performs the -= operation.

impl<T> Copy for Vector2D<T>

where T: Copy + Number,

impl<T> Eq for Vector2D<T>

where T: Eq + Number,

impl<T> StructuralPartialEq for Vector2D<T>

where T: Number,