Struct Fvec2

#[repr(C)]
pub struct Fvec2 { /* private fields */ }

2D vector with single precision.

The components are laid out in this order: [x, y]. This struct is aligned to 4 bytes, not 8.

This struct is here for consistency and does not explicitly use SIMD instructions. Internally, it is just an array of two floats.

Examples

use mafs::{Vec2, Fvec2};

// Construction
let a = Fvec2::new(2.0, 3.0);
let b = Fvec2::new(6.0, 9.0);
let c = Fvec2::splat(0.0); // Set all four components to the same value

// Arithmetics
assert_eq!(a + b, Fvec2::new(8.0, 12.0));
assert_eq!(a - b, Fvec2::new(-4.0, -6.0));
assert_eq!(a * b, Fvec2::new(12.0, 27.0));
assert_eq!(b / a, Fvec2::new(3.0, 3.0));

// Euclidian norm
assert_eq!(a.norm(), 13.0f32.sqrt());
assert_eq!(a.normalize().norm(), 1.0);

// Specialized operations
assert_eq!(a.dot(b), 39.0);
assert_eq!(b.dot(a), a.dot(b));
assert_eq!(Fvec2::new(-0.5, 0.5).floor(), Fvec2::new(-1.0, 0.0));

// Comparisons
assert_eq!(a.min_componentwise(b), Fvec2::new(2.0, 3.0));
assert_eq!(a.max_componentwise(b), Fvec2::new(6.0, 9.0));

// Reduction
assert_eq!(a.min_reduce(), 2.0);
assert_eq!(b.max_reduce(), 9.0);

Trait Implementations

impl Add<Fvec2> for f32

type Output = Fvec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f32> for Fvec2

type Output = Fvec2

The resulting type after applying the + operator.

fn add(self, rhs: f32) -> Fvec2

Performs the + operation.

impl Add for Fvec2

type Output = Fvec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<f32> for Fvec2

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl AddAssign for Fvec2

fn add_assign(&mut self, rhs: Fvec2)

Performs the += operation.

impl Clone for Fvec2

fn clone(&self) -> Fvec2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Fvec2

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

Formats the value using the given formatter.

impl Default for Fvec2

fn default() -> Fvec2

Returns the “default value” for a type.

impl Div<Fvec2> for f32

type Output = Fvec2

The resulting type after applying the / operator.

fn div(self, rhs: Fvec2) -> Fvec2

Performs the / operation.

impl Div<f32> for Fvec2

type Output = Fvec2

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Fvec2

Performs the / operation.

impl Div for Fvec2

type Output = Fvec2

The resulting type after applying the / operator.

fn div(self, rhs: Fvec2) -> Fvec2

Performs the / operation.

impl DivAssign<f32> for Fvec2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl DivAssign for Fvec2

fn div_assign(&mut self, rhs: Fvec2)

Performs the /= operation.

impl Index<usize> for Fvec2

type Output = f32

The returned type after indexing.

fn index(&self, idx: usize) -> &f32

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Fvec2

fn index_mut(&mut self, idx: usize) -> &mut f32

Performs the mutable indexing (container[index]) operation.

impl Mul<Fvec2> for f32

type Output = Fvec2

The resulting type after applying the * operator.

fn mul(self, rhs: Fvec2) -> Fvec2

Performs the * operation.

impl Mul<f32> for Fvec2

type Output = Fvec2

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Fvec2

Performs the * operation.

impl Mul for Fvec2

type Output = Fvec2

The resulting type after applying the * operator.

fn mul(self, rhs: Fvec2) -> Fvec2

Performs the * operation.

impl MulAssign<f32> for Fvec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign for Fvec2

fn mul_assign(&mut self, rhs: Fvec2)

Performs the *= operation.

impl Neg for Fvec2

type Output = Fvec2

The resulting type after applying the - operator.

fn neg(self) -> Fvec2

Performs the unary - operation.

impl PartialEq for Fvec2

fn eq(&self, rhs: &Fvec2) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<Fvec2> for f32

type Output = Fvec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f32> for Fvec2

type Output = Fvec2

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> Fvec2

Performs the - operation.

impl Sub for Fvec2

type Output = Fvec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<f32> for Fvec2

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl SubAssign for Fvec2

fn sub_assign(&mut self, rhs: Fvec2)

Performs the -= operation.

impl Vec2<f32> for Fvec2

fn new(x: f32, y: f32) -> Fvec2

Create a new two-dimensional vector.

fn as_array(&self) -> &[f32; 2]

Convert to an array. Can also use the indexing operator [].

fn as_mut_array(&mut self) -> &mut [f32; 2]

Convert to a mutable array. Can also use the indexing operator[].

fn add_componentwise(&self, rhs: Fvec2) -> Fvec2

Add component by component. Can also use the + operator.

fn sub_componentwise(&self, rhs: Fvec2) -> Fvec2

Subtract component by component. Can also use the - operator.

fn mul_componentwise(&self, rhs: Fvec2) -> Fvec2

Multiply component by component. Can also use the * operator.

fn div_componentwise(&self, rhs: Fvec2) -> Fvec2

Divide component by component. Can also use the / operator.

fn min_componentwise(&self, rhs: Fvec2) -> Fvec2

For each lane, select the smallest component of the two.

fn max_componentwise(&self, rhs: Fvec2) -> Fvec2

For each lane, select the largest component of the two.

fn floor(&self) -> Fvec2

Round down all components to an integer value.

fn min_reduce(&self) -> f32

Smallest of the four components.

fn max_reduce(&self) -> f32

Largest of the four components.

fn eq_reduce(&self, rhs: Fvec2) -> bool

Equality of a vector to another on all components.

fn dot(&self, rhs: Fvec2) -> f32

Dot product.

fn splat(value: S) -> Self

Create a two-dimensional vector all with equal components.

fn norm(&self) -> S

Norm of this vector.

fn normalize(&self) -> Self

Divide by the norm to obain a normalized vector.

impl Copy for Fvec2