Struct Vector

Source

pub struct Vector<const N: usize> { /* private fields */ }

Expand description

A vector with N plain f64 components.

§Examples

use use_vector::Vector;

let vector = Vector::<3>::from_array([2.0, 3.0, 6.0]);

assert_eq!(vector.dimension(), 3);
assert_eq!(vector.magnitude(), 7.0);

Implementations§

Source §

impl<const N: usize> Vector<N>

Source

pub const ZERO: Vector<N>

The zero vector.

Source

pub const ONE: Vector<N>

A vector with every component set to 1.0.

Source

pub const fn from_array(components: [f64; N]) -> Vector<N>

Creates a vector from its component array.

Source

pub const fn as_array(&self) -> &[f64; N]

Returns a shared reference to the component array.

Source

pub const fn into_array(self) -> [f64; N]

Returns the component array.

Source

pub const fn dimension(self) -> usize

Returns the vector dimension.

Source

pub fn dot(self, other: Vector<N>) -> f64

Returns the dot product with other.

§Examples

use use_vector::Vector;

let a = Vector::<3>::from_array([1.0, 2.0, 3.0]);
let b = Vector::<3>::from_array([4.0, 5.0, 6.0]);

assert_eq!(a.dot(b), 32.0);

Source

pub fn magnitude_squared(self) -> f64

Returns the squared Euclidean magnitude.

Source

pub fn magnitude(self) -> f64

Returns the Euclidean magnitude.

Source

pub fn normalize(self) -> Option<Vector<N>>

Returns a normalized vector when the magnitude is finite and non-zero.

Returns None for zero vectors or vectors with non-finite magnitude.

§Examples

use use_vector::Vector2;

let unit = Vector2::new(3.0, 4.0)
    .normalize()
    .expect("non-zero finite vector should normalize");

assert!((unit.x() - 0.6).abs() < 1.0e-12);
assert!((unit.y() - 0.8).abs() < 1.0e-12);

Source

pub fn scale(self, scalar: f64) -> Vector<N>

Returns the vector scaled by scalar.

Source

pub fn distance(self, other: Vector<N>) -> f64

Returns the Euclidean distance to other.

§Examples

use use_vector::Vector2;

let start = Vector2::ZERO;
let end = Vector2::new(3.0, 4.0);

assert_eq!(start.distance(end), 5.0);

Source

pub fn distance_squared(self, other: Vector<N>) -> f64

Returns the squared Euclidean distance to other.

Source

pub fn lerp(self, other: Vector<N>, t: f64) -> Vector<N>

Returns the linear interpolation between self and other for t.

Source

pub fn map_components(self, mapper: impl FnMut(f64) -> f64) -> Vector<N>

Maps each component with mapper.

Source

pub fn zip_components( self, other: Vector<N>, mapper: impl FnMut(f64, f64) -> f64, ) -> Vector<N>

Combines components from self and other with mapper.

Source

pub fn component_min(self, other: Vector<N>) -> Vector<N>

Returns the component-wise minimum with other.

Source

pub fn component_max(self, other: Vector<N>) -> Vector<N>

Returns the component-wise maximum with other.

Source

pub fn clamp_components( self, minimum: Vector<N>, maximum: Vector<N>, ) -> Vector<N>

Returns each component bounded by the matching minimum and maximum components.

Source

pub fn abs(self) -> Vector<N>

Returns a vector with the absolute value of each component.

Source

pub fn is_finite(self) -> bool

Returns true when every component is finite.

Source

pub fn is_nan(self) -> bool

Returns true when any component is NaN.

Source §

impl Vector<2>

Source

pub const fn new(x: f64, y: f64) -> Vector<2>

Creates a two-dimensional vector from its components.

Source

pub const fn x(self) -> f64

Returns the x component.

Source

pub const fn y(self) -> f64

Returns the y component.

Source §

impl Vector<3>

Source

pub const fn new(x: f64, y: f64, z: f64) -> Vector<3>

Creates a three-dimensional vector from its components.

Source

pub const fn x(self) -> f64

Returns the x component.

Source

pub const fn y(self) -> f64

Returns the y component.

Source

pub const fn z(self) -> f64

Returns the z component.

Source

pub fn cross(self, other: Vector<3>) -> Vector<3>

Returns the cross product with other.

§Examples

use use_vector::Vector3;

let x = Vector3::new(1.0, 0.0, 0.0);
let y = Vector3::new(0.0, 1.0, 0.0);

assert_eq!(x.cross(y), Vector3::new(0.0, 0.0, 1.0));