Struct Vector

pub struct Vector {
    pub x: Fp,
    pub y: Fp,
}

Represents a vector in a 2D space.

Fields

x: Fp

y: Fp

Implementations

impl Vector

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

Creates a new Vector with the specified x and y components.

Parameters

• x: The x-coordinate of the vector.
• y: The y-coordinate of the vector.

Returns

A Vector instance with the given x and y components.

Examples

use fixed32::Fp;
use fixed32_math::Vector;

let v = Vector::new(Fp::from(2), Fp::from(3));
assert_eq!(v.x, Fp::from(2));
assert_eq!(v.y, Fp::from(3));

pub const fn left() -> Self

Returns a Vector pointing to the left (negative x-axis direction).

This is a convenience method to create a vector that represents a direction to the left in 2D space.

Returns

A Vector instance with x set to -1 and y set to 0.

Examples

use fixed32::Fp;
use fixed32_math::Vector;

let left = Vector::left();
assert_eq!(left.x, Fp::neg_one());
assert_eq!(left.y, Fp::zero());

pub const fn right() -> Self

Returns a Vector pointing to the right (positive x-axis direction).

This is a convenience method to create a vector that represents a direction to the right in 2D space.

Returns

A Vector instance with x set to 1 and y set to 0.

Examples

use fixed32::Fp;
use fixed32_math::Vector;

let right = Vector::right();
assert_eq!(right.x, Fp::one());
assert_eq!(right.y, Fp::zero());

pub const fn up() -> Self

Returns a Vector pointing upwards (positive y-axis direction).

This is a convenience method to create a vector that represents a direction upwards in 2D space.

Returns

A Vector instance with x set to 0 and y set to 1.

Examples

use fixed32::Fp;
use fixed32_math::Vector;

let up = Vector::up();
assert_eq!(up.x, Fp::zero());
assert_eq!(up.y, Fp::one());

pub const fn down() -> Self

Returns a Vector pointing downwards (negative y-axis direction).

This is a convenience method to create a vector that represents a direction downwards in 2D space.

Returns

A Vector instance with x set to 0 and y set to -1.

Examples

use fixed32::Fp;
use fixed32_math::Vector;

let down = Vector::down();
assert_eq!(down.x, Fp::zero());
assert_eq!(down.y, Fp::neg_one());

pub fn sqr_len(&self) -> Fp

Computes the squared length (magnitude) of the vector.

This method calculates the squared length of the vector, which is the sum of the squares of its x and y components. It is often used for performance reasons when the actual length is not needed, as computing the square root can be costly.

Returns

The squared length of the vector as an Fp value.

Examples

use fixed32::Fp;
use fixed32_math::Vector;

let v = Vector::new(Fp::from(3), Fp::from(4));
let sqr_len = v.sqr_len();
assert_eq!(sqr_len, Fp::from(25));

pub fn len(&self) -> Fp

Returns the length of the vector.

pub fn normalize(&self) -> Option<Self>

Returns a normalized vector with length 1. Returns None if the vector is zero-length.

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

Computes the dot product of this vector with another.

pub fn cross(&self, other: &Self) -> Fp

Computes the magnitude of the cross product in 2D (which is a scalar value).

pub fn scale(&self, factor: &Self) -> Self

Scales the vector by another vector component-wise.

pub fn rotate(&self, angle: Fp) -> Self

Rotates the vector by the given angle in radians.

pub const fn abs(&self) -> Self

Returns the absolute value of each component of the vector.

Trait Implementations

impl Add for Vector

type Output = Vector

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Vector

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Vector

fn clone(&self) -> Vector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vector

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

Formats the value using the given formatter.

impl Default for Vector

fn default() -> Vector

Returns the “default value” for a type.

impl Display for Vector

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

Formats the value using the given formatter.

impl Div<Fp> for Vector

type Output = Vector

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<Vector> for i16

type Output = Vector

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i16> for Vector

type Output = Vector

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Vector

type Output = Vector

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<(f32, f32)> for Vector

fn from(values: (f32, f32)) -> Self

Converts to this type from the input type.

impl From<(i16, i16)> for Vector

fn from(values: (i16, i16)) -> Self

Converts to this type from the input type.

impl Mul<Fp> for Vector

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector> for Fp

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Vector> for i16

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i16> for Vector

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Vector

type Output = Vector

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Vector

type Output = Vector

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Vector

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

type Output = Vector

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Vector

impl Eq for Vector

impl StructuralPartialEq for Vector