Struct fj_math::Vector

#[repr(C)]
pub struct Vector<const D: usize> {
    pub components: [Scalar; D],
}

An n-dimensional vector

The dimensionality of the vector is defined by the const generic D parameter.

Fields

components: [Scalar; D]

The vector components

Implementations

impl<const D: usize> Vector<D>

pub fn from_components_f64(components: [f64; D]) -> Self

Construct a Vector from f64 components

Panics

Panics, if the components can not be converted to Scalar. See Scalar::from_f64, which this method uses internally.

pub fn from_na(vector: SVector<f64, D>) -> Self

Construct a Vector from an nalgebra vector

pub fn to_na(self) -> SVector<f64, D>

Convert the vector into an nalgebra vector

pub fn to_t(self) -> Vector<1>

Convert to a 1-dimensional vector

pub fn to_uv(self) -> Vector<2>

Convert the vector into a 2-dimensional vector

If the vector is 0-, or 1-dimensional, the missing components will be initialized to zero.

If the vector has higher dimensionality than two, the superfluous components will be discarded.

pub fn to_xyz(self) -> Vector<3>

Convert the vector into a 3-dimensional vector

If the vector is 0-, 1-, or 2-dimensional, the missing components will be initialized to zero.

If the vector has higher dimensionality than three, the superfluous components will be discarded.

pub fn magnitude(&self) -> Scalar

Compute the magnitude of the vector

pub fn normalize(&self) -> Self

Compute a normalized version of the vector

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

Compute the dot product with another vector

pub fn scalar_projection_onto(&self, other: &Self) -> Scalar

Compute the scalar project of this vector onto another

impl Vector<1>

pub fn unit_t() -> Self

Construct a Vector that represents the t-axis

impl Vector<2>

pub fn unit_u() -> Self

Construct a Vector that represents the u-axis

pub fn unit_v() -> Self

Construct a Vector that represents the v-axis

pub fn cross2d(&self, other: &Self) -> Scalar

Compute the 2D cross product with another vector

pub fn is_between(&self, others: [impl Into<Self>; 2]) -> bool

Determine whether this vector is between two other vectors

impl Vector<3>

pub fn unit_x() -> Self

Construct a Vector that represents the x-axis

pub fn unit_y() -> Self

Construct a Vector that represents the y-axis

pub fn unit_z() -> Self

Construct a Vector that represents the z-axis

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

Compute the cross product with another vector

pub fn xy(&self) -> Vector<2>

Construct a new vector from this vector’s x and y components

Trait Implementations

impl<const D: usize> AbsDiffEq<Vector<D>> for Vector<D>

type Epsilon = <Scalar as AbsDiffEq<Scalar>>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<V, const D: usize> Add<V> for Vector<D>where
    V: Into<Self>,

type Output = Vector<D>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const D: usize> Clone for Vector<D>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for Vector<D>

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

Formats the value using the given formatter.

impl<const D: usize> Default for Vector<D>

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Vector<1>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl Deref for Vector<2>

type Target = Uv

The resulting type after dereferencing.

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

Dereferences the value.

impl Deref for Vector<3>

type Target = Xyz

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Vector<1>

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

Mutably dereferences the value.

impl DerefMut for Vector<2>

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

Mutably dereferences the value.

impl DerefMut for Vector<3>

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

Mutably dereferences the value.

impl<S, const D: usize> Div<S> for Vector<D>where
    S: Into<Scalar>,

type Output = Vector<D>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<const D: usize> From<[Scalar; D]> for Vector<D>

fn from(components: [Scalar; D]) -> Self

Converts to this type from the input type.

impl<const D: usize> From<[f64; D]> for Vector<D>

fn from(components: [f64; D]) -> Self

Converts to this type from the input type.

impl<const D: usize> From<Matrix<f64, Const<D>, Const<1>, ArrayStorage<f64, D, 1>>> for Vector<D>

fn from(vector: SVector<f64, D>) -> Self

Converts to this type from the input type.

impl<const D: usize> From<Vector<D>> for [Scalar; D]

fn from(vector: Vector<D>) -> Self

Converts to this type from the input type.

impl<const D: usize> From<Vector<D>> for [f32; D]

fn from(vector: Vector<D>) -> Self

Converts to this type from the input type.

impl<const D: usize> From<Vector<D>> for [f64; D]

fn from(vector: Vector<D>) -> Self

Converts to this type from the input type.

impl<const D: usize> From<Vector<D>> for SVector<f64, D>

fn from(vector: Vector<D>) -> Self

Converts to this type from the input type.

impl<const D: usize> Hash for Vector<D>

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<S, const D: usize> Mul<S> for Vector<D>where
    S: Into<Scalar>,

type Output = Vector<D>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const D: usize> Neg for Vector<D>

type Output = Vector<D>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const D: usize> Ord for Vector<D>

fn cmp(&self, other: &Vector<D>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<const D: usize> PartialEq<Vector<D>> for Vector<D>

fn eq(&self, other: &Vector<D>) -> 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<const D: usize> PartialOrd<Vector<D>> for Vector<D>

fn partial_cmp(&self, other: &Vector<D>) -> 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<V, const D: usize> Sub<V> for Vector<D>where
    V: Into<Self>,

type Output = Vector<D>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const D: usize> Copy for Vector<D>

impl<const D: usize> Eq for Vector<D>

impl<const D: usize> StructuralEq for Vector<D>

impl<const D: usize> StructuralPartialEq for Vector<D>