1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
//! Algebraic vector types generic over a component type.
//!
//! All vectors types impl the [Vector] trait, and all vector components
//! impl the [Component] trait.
mod component;
mod iter;
mod vector2d;
mod vector3d;
pub use self::{
component::Component,
iter::Iter,
vector2d::{F32x2, I16x2, I32x2, I8x2, U16x2, U32x2, U8x2, Vector2d},
vector3d::{F32x3, I16x3, I32x3, I8x3, U16x3, U32x3, U8x3, Vector3d},
};
use core::{fmt::Debug, iter::FromIterator};
#[allow(unused_imports)]
use crate::F32Ext;
/// Algebraic vector generic over a given [`Component`] type.
pub trait Vector<C>: Copy + Debug + Default + FromIterator<C> + Send + Sync
where
C: Component,
{
/// Number of axes
const AXES: usize;
/// Get the component value for a particular index
fn get(self, index: usize) -> Option<C>;
/// Compute the dot product of two vectors
fn dot(self, rhs: Self) -> C;
/// Instantiate a vector from a slice of components.
///
/// Panics if the slice is not the right size.
fn from_slice(slice: &[C]) -> Self {
Self::from_iter(slice.iter().cloned())
}
/// Iterate over the components of this vector
fn iter(&self) -> Iter<'_, Self, C> {
Iter::new(self)
}
/// Compute the distance between two vectors
fn distance(self, rhs: Self) -> f32
where
C: Into<f32>,
{
let differences = self
.iter()
.zip(rhs.iter())
.map(|(a, b)| a.into() - b.into());
differences.map(|n| n * n).sum::<f32>().sqrt()
}
/// Compute the magnitude of a vector
fn magnitude(self) -> f32
where
C: Into<f32>,
{
self.iter()
.map(|n| {
let n = n.into();
n * n
})
.sum::<f32>()
.sqrt()
}
}