Trait VecN 

pub trait VecN: Sized {
    type Scalar: Scalar;

    const N: usize;
    const ZERO: Self;

    // Required methods
    fn dim(&self, dim: usize) -> Self::Scalar;
    fn dim_mut(&mut self, dim: usize) -> &mut Self::Scalar;

    // Provided methods
    fn set_dim(&mut self, dim: usize, val: Self::Scalar) { ... }
    fn add_assign(&mut self, other: Self) { ... }
    fn add(self, other: Self) -> Self { ... }
    fn sub_assign(&mut self, other: Self) { ... }
    fn sub(self, other: Self) -> Self { ... }
    fn mul_assign(&mut self, by: Self::Scalar) { ... }
    fn mul(self, by: Self::Scalar) -> Self { ... }
    fn div_assign(&mut self, by: Self::Scalar) { ... }
    fn div(self, by: Self::Scalar) -> Self { ... }
    fn mul2_assign(&mut self, other: Self) { ... }
    fn mul2(self, other: Self) -> Self { ... }
    fn div2_assign(&mut self, other: Self) { ... }
    fn div2(self, other: Self) -> Self { ... }
    fn neg_assign(&mut self)
       where Self::Scalar: Neg<Output = Self::Scalar> + Debug { ... }
    fn neg(self) -> Self
       where Self::Scalar: Neg<Output = Self::Scalar> + Debug { ... }
    fn squared_mag(&self) -> Self::Scalar { ... }
    fn squared_dist(self, other: Self) -> Self::Scalar { ... }
    fn min_dim(&self) -> Self::Scalar { ... }
    fn max_dim(&self) -> Self::Scalar { ... }
    fn dot(self, other: Self) -> Self::Scalar { ... }
    fn lerp_assign(&mut self, other: Self, t: Self::Scalar) { ... }
    fn lerp(self, other: Self, t: Self::Scalar) -> Self { ... }
}

Trait for basic vector math operations

Required Associated Constants

const N: usize

The dimensionality of the vector

const ZERO: Self

The zero value

Required Associated Types

type Scalar: Scalar

The scalar type

Required Methods

fn dim(&self, dim: usize) -> Self::Scalar

Get the value of a dimension

fn dim_mut(&mut self, dim: usize) -> &mut Self::Scalar

Get a mutable reference to the value of a dimension

Provided Methods

fn set_dim(&mut self, dim: usize, val: Self::Scalar)

Set the value of a dimension

fn add_assign(&mut self, other: Self)

Add to the vector in place

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

Add the vector to another

fn sub_assign(&mut self, other: Self)

Subtract from the vector in place

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

Subtract a vector from the one

fn mul_assign(&mut self, by: Self::Scalar)

Multiply the vector in place

fn mul(self, by: Self::Scalar) -> Self

Multiply the vector by a scalar value

fn div_assign(&mut self, by: Self::Scalar)

Divide the vector in place

fn div(self, by: Self::Scalar) -> Self

Divide the vector by a scalar value

fn mul2_assign(&mut self, other: Self)

Element-wise multiply the vector by another in place

fn mul2(self, other: Self) -> Self

Element-wise multiply the vector by another

fn div2_assign(&mut self, other: Self)

Element-wise divide the vector by another in place

fn div2(self, other: Self) -> Self

Element-wise divide the vector by another

fn neg_assign(&mut self)

where Self::Scalar: Neg<Output = Self::Scalar> + Debug,

Negate the vector in place

fn neg(self) -> Self

where Self::Scalar: Neg<Output = Self::Scalar> + Debug,

Negate the vector

fn squared_mag(&self) -> Self::Scalar

Get the squared magnitude of the vector

fn squared_dist(self, other: Self) -> Self::Scalar

Get the squared distance between this vector and another

fn min_dim(&self) -> Self::Scalar

Get the minimum dimension

fn max_dim(&self) -> Self::Scalar

Get the maximum dimension

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

Dot the vector with another

fn lerp_assign(&mut self, other: Self, t: Self::Scalar)

Linearly interpolate the vector with another in place

fn lerp(self, other: Self, t: Self::Scalar) -> Self

Linearly interpolate the vector with another

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T, const N: usize> VecN for [T; N]

where T: Scalar,

const N: usize = N

const ZERO: Self

type Scalar = T

fn dim(&self, dim: usize) -> Self::Scalar

fn dim_mut(&mut self, dim: usize) -> &mut Self::Scalar

Implementors