Struct static_math::vector3::V3

pub struct V3<T>(_);

Implementations

impl<T> V3<T>

pub const fn new(input: [T; 3]) -> Self

create a new V3 from a static array

pub fn new_from(a: T, b: T, c: T) -> Self

create a new V3 from numbers

impl<T: Num + Copy> V3<T>

pub fn zeros() -> Self

create a V3 with all elements zero

pub fn ones() -> Self

create a V3 with all elements one

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

calculate the cross product

pub fn x_axis() -> Self

pub fn y_axis() -> Self

pub fn z_axis() -> Self

impl<T: Num + Copy + PartialOrd> V3<T>

pub fn norm_inf(&self) -> T

impl<T: Num + Copy + Signed + Sum> V3<T>

pub fn norm_l(&self) -> T

impl<T: Float> V3<T>

pub fn norm2(&self) -> T

calculate the euclidean norm of the V3

pub fn normalize(&self) -> Result<Self, VectorErrors>

normalize the current V3

Methods from Deref<Target = [T; 3]>

pub fn as_slice(&self) -> &[T]

🔬 This is a nightly-only experimental API. (array_methods)

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

🔬 This is a nightly-only experimental API. (array_methods)

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

🔬 This is a nightly-only experimental API. (array_methods)

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods, array_map)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

🔬 This is a nightly-only experimental API. (array_methods)

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

#![feature(array_methods)]

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

Trait Implementations

impl<T: Num + Copy> Add<V3<T>> for V3<T>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Num + Copy> AddAssign<V3<T>> for V3<T>

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: Clone> Clone for V3<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for V3<T>

impl<T: Debug> Debug for V3<T>

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

Formats the value using the given formatter.

impl<T> Deref for V3<T>

type Target = [T; 3]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for V3<T>

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

Mutably dereferences the value.

impl<T: Num + Display> Display for V3<T>

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

Formats the value using the given formatter.

impl<T: Num + Copy> Div<T> for V3<T>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> From<[T; 3]> for V3<T>

fn from(data: [T; 3]) -> V3<T>

Performs the conversion.

impl<T: Num + Copy> Mul<M33<T>> for V3<T>

type Output = V3<T>

The resulting type after applying the * operator.

fn mul(self, rhs: M33<T>) -> V3<T>

Performs the * operation.

impl<T: Num + Copy> Mul<T> for V3<T>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Num + Copy> Mul<V3<T>> for M33<T>

type Output = V3<T>

The resulting type after applying the * operator.

fn mul(self, rhs: V3<T>) -> V3<T>

Performs the * operation.

impl<T: Num + Copy> Mul<V3<T>> for V3<T>

type Output = T

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Num + Copy + Signed> Mul<V3<T>> for Quaternion<T>

type Output = V3<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Num + Copy + Signed> Neg for V3<T>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: PartialEq> PartialEq<V3<T>> for V3<T>

fn eq(&self, other: &V3<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &V3<T>) -> bool

This method tests for !=.

impl<T> StructuralPartialEq for V3<T>

impl<T: Num + Copy> Sub<V3<T>> for V3<T>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Num + Copy> SubAssign<V3<T>> for V3<T>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T: Num + Copy> Zero for V3<T>

fn zero() -> V3<T>

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

pub fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.