Struct DVec2x2

#[repr(C)]
pub struct DVec2x2 {
    pub x: f64x2,
    pub y: f64x2,
}

A set of two coordinates which may be interpreted as a vector or point in 2d space.

Generally this distinction between a point and vector is more of a pain than it is worth to distinguish on a type level, however when converting to and from homogeneous coordinates it is quite important.

Fields

x: f64x2

y: f64x2

Implementations

impl DVec2x2

pub const fn new(x: f64x2, y: f64x2) -> DVec2x2

pub const fn broadcast(val: f64x2) -> DVec2x2

pub fn unit_x() -> DVec2x2

pub fn unit_y() -> DVec2x2

pub fn into_homogeneous_point(self) -> DVec3x2

Create a homogeneous 2d point from this vector interpreted as a point, meaning the homogeneous component will start with a value of 1.0.

pub fn into_homogeneous_vector(self) -> DVec3x2

Create a homogeneous 2d vector from this vector, meaning the homogeneous component will always have a value of 0.0.

pub fn from_homogeneous_point(v: DVec3x2) -> DVec2x2

Create a 2d point from a homogeneous 2d point, performing division by the homogeneous component. This should not be used for homogeneous 2d vectors, which will have 0 as their homogeneous component.

pub fn from_homogeneous_vector(v: DVec3x2) -> DVec2x2

Create a 2d vector from homogeneous 2d vector, which simply discards the homogeneous component.

pub fn dot(&self, other: DVec2x2) -> f64x2

pub fn wedge(&self, other: DVec2x2) -> DBivec2x2

The wedge (aka exterior) product of two vectors.

Note: Sometimes called “cross” product in 2D. Such a product is not well defined in 2 dimensions and is really just shorthand notation for a hacky operation that extends the vectors into 3 dimensions, takes the cross product, then returns only the resulting Z component as a pseudoscalar value. This value is will have the same value as the resulting bivector of the wedge product in 2d (a 2d bivector is also a kind of pseudoscalar value), so you may use this product to calculate the same value.

This operation results in a bivector, which represents the plane parallel to the two vectors, and which has a ‘oriented area’ equal to the parallelogram created by extending the two vectors, oriented such that the positive direction is the one which would move self closer to other.

pub fn geom(&self, other: DVec2x2) -> DRotor2x2

The geometric product of this and another vector, which is defined as the sum of the dot product and the wedge product.

This operation results in a ‘rotor’, named as such as it may define a rotation. The rotor which results from the geometric product will rotate in the plane parallel to the two vectors, by twice the angle between them and in the opposite direction (i.e. it will rotate in the direction that would bring other towards self, and rotate in that direction by twice the angle between them).

pub fn rotate_by(&mut self, rotor: DRotor2x2)

pub fn rotated_by(self, rotor: DRotor2x2) -> DVec2x2

pub fn reflected(&self, normal: DVec2x2) -> DVec2x2

pub fn mag_sq(&self) -> f64x2

pub fn mag(&self) -> f64x2

pub fn normalize(&mut self)

pub fn normalized(&self) -> DVec2x2

pub fn mul_add(&self, mul: DVec2x2, add: DVec2x2) -> DVec2x2

pub fn abs(&self) -> DVec2x2

pub fn clamp(&mut self, min: DVec2x2, max: DVec2x2)

pub fn clamped(self, min: DVec2x2, max: DVec2x2) -> DVec2x2

pub fn map<F>(&self, f: F) -> DVec2x2

where F: FnMut(f64x2) -> f64x2,

pub fn apply<F>(&mut self, f: F)

where F: FnMut(f64x2) -> f64x2,

pub fn max_by_component(self, other: DVec2x2) -> DVec2x2

pub fn min_by_component(self, other: DVec2x2) -> DVec2x2

pub fn component_max(&self) -> f64x2

pub fn component_min(&self) -> f64x2

pub fn zero() -> DVec2x2

pub fn one() -> DVec2x2

pub fn xyz(&self) -> DVec3x2

pub fn xyzw(&self) -> DVec4x2

pub fn layout() -> Layout

Get the core::alloc::Layout of Self

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

Interpret self as a statically-sized array of its base numeric type

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

Interpret self as a statically-sized array of its base numeric type

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

Interpret self as a slice of its base numeric type

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

Interpret self as a slice of its base numeric type

pub fn as_byte_slice(&self) -> &[u8]

pub fn as_mut_byte_slice(&mut self) -> &mut [u8]

pub const fn as_ptr(&self) -> *const f64x2

Returns a constant unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

pub fn as_mut_ptr(&mut self) -> *mut f64x2

Returns a mutable unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

impl DVec2x2

pub fn new_splat(x: f64, y: f64) -> DVec2x2

pub fn splat(vec: DVec2) -> DVec2x2

pub fn blend(mask: f64x2, tru: DVec2x2, fals: DVec2x2) -> DVec2x2

Blend two vectors together lanewise using mask as a mask.

This is essentially a bitwise blend operation, such that any point where there is a 1 bit in mask, the output will put the bit from tru, while where there is a 0 bit in mask, the output will put the bit from fals

pub fn refract(&mut self, normal: DVec2x2, eta: f64x2)

pub fn refracted(&self, normal: DVec2x2, eta: f64x2) -> DVec2x2

Trait Implementations

impl Add for DVec2x2

type Output = DVec2x2

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for DVec2x2

fn add_assign(&mut self, rhs: DVec2x2)

Performs the += operation.

impl Clone for DVec2x2

fn clone(&self) -> DVec2x2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DVec2x2

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

Formats the value using the given formatter.

impl Default for DVec2x2

fn default() -> DVec2x2

Returns the “default value” for a type.

impl Div<f64x2> for DVec2x2

type Output = DVec2x2

The resulting type after applying the / operator.

fn div(self, rhs: f64x2) -> DVec2x2

Performs the / operation.

impl Div for DVec2x2

type Output = DVec2x2

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64x2> for DVec2x2

fn div_assign(&mut self, rhs: f64x2)

Performs the /= operation.

impl DivAssign for DVec2x2

fn div_assign(&mut self, rhs: DVec2x2)

Performs the /= operation.

impl FloatVector for DVec2x2

type Float = f64x2

Floating-point associated with the vector.

fn norm_squared(self) -> Self::Float

Returns the norm squared of the vector.

impl From<&[f64x2; 2]> for DVec2x2

fn from(comps: &[f64x2; 2]) -> DVec2x2

Converts to this type from the input type.

impl From<&(f64x2, f64x2)> for DVec2x2

fn from(comps: &(f64x2, f64x2)) -> DVec2x2

Converts to this type from the input type.

impl From<&mut [f64x2; 2]> for DVec2x2

fn from(comps: &mut [f64x2; 2]) -> DVec2x2

Converts to this type from the input type.

impl From<[DVec2; 2]> for DVec2x2

fn from(vecs: [DVec2; 2]) -> DVec2x2

Converts to this type from the input type.

impl From<[f64x2; 2]> for DVec2x2

fn from(comps: [f64x2; 2]) -> DVec2x2

Converts to this type from the input type.

impl From<(f64x2, f64x2)> for DVec2x2

fn from(comps: (f64x2, f64x2)) -> DVec2x2

Converts to this type from the input type.

impl From<DVec2> for DVec2x2

fn from(vec: DVec2) -> DVec2x2

Converts to this type from the input type.

impl From<DVec2x2> for DVec3x2

fn from(vec: DVec2x2) -> DVec3x2

Converts to this type from the input type.

impl From<DVec3x2> for DVec2x2

fn from(vec: DVec3x2) -> DVec2x2

Converts to this type from the input type.

impl Index<usize> for DVec2x2

type Output = f64x2

The returned type after indexing.

fn index(&self, index: usize) -> &<DVec2x2 as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for DVec2x2

fn index_mut(&mut self, index: usize) -> &mut <DVec2x2 as Index<usize>>::Output

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

impl IntoArray for DVec2x2

type Array = [f64x2; 2]

The array the type can be converted into.

impl Lerp<f64x2> for DVec2x2

fn lerp(&self, end: DVec2x2, t: f64x2) -> DVec2x2

Linearly interpolate between self and end by t between 0.0 and 1.0. i.e. (1.0 - t) * self + (t) * end.

For interpolating Rotors with linear interpolation, you almost certainly want to normalize the returned Rotor. For example,

let interpolated_rotor = rotor1.lerp(rotor2, 0.5).normalized();

For most cases (especially where performance is the primary concern, like in animation interpolation for games, this ‘normalized lerp’ or ‘nlerp’ is probably what you want to use. However, there are situations in which you really want the interpolation between two Rotors to be of constant angular velocity. In this case, check out Slerp.

impl Mul<DVec2x2> for f64x2

type Output = DVec2x2

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64x2> for DVec2x2

type Output = DVec2x2

The resulting type after applying the * operator.

fn mul(self, rhs: f64x2) -> DVec2x2

Performs the * operation.

impl Mul for DVec2x2

type Output = DVec2x2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64x2> for DVec2x2

fn mul_assign(&mut self, rhs: f64x2)

Performs the *= operation.

impl MulAssign for DVec2x2

fn mul_assign(&mut self, rhs: DVec2x2)

Performs the *= operation.

impl Neg for DVec2x2

type Output = DVec2x2

The resulting type after applying the - operator.

fn neg(self) -> DVec2x2

Performs the unary - operation.

impl PartialEq for DVec2x2

fn eq(&self, other: &DVec2x2) -> 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 Reduce for DVec2x2

fn reduce_sum(self) -> Self::Element

Sums the lanes of a SIMD vector.

impl SIMD for DVec2x2

type Element = DVec2

Element from which the SIMD value can be created.

type Lane = [<DVec2x2 as SIMD>::Element; 2]

The type a lane is equivalent to.

fn splat(element: Self::Element) -> Self

Creates a SIMD value with all lanes set to the specified value.

fn new_lane(lane: Self::Lane) -> Self

Creates a SIMD value with lanes set to the given values.

impl Slerp<f64x2> for DVec2x2

fn slerp(&self, end: DVec2x2, t: f64x2) -> DVec2x2

Spherical-linear interpolation between self and end based on t from 0.0 to 1.0.

self and end should both be normalized or something bad will happen!

The implementation for SIMD types also requires that the two things being interpolated between are not exactly aligned, or else the result is undefined.

Basically, interpolation that maintains a constant angular velocity from one orientation on a unit hypersphere to another. This is sorta the “high quality” interpolation for Rotors, and it can also be used to interpolate other things, one example being interpolation of 3d normal vectors.

Note that you should often normalize the result returned by this operation, when working with Rotors, etc!

impl Sub for DVec2x2

type Output = DVec2x2

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for DVec2x2

fn sub_assign(&mut self, rhs: DVec2x2)

Performs the -= operation.

impl Sum for DVec2x2

fn sum<I>(iter: I) -> DVec2x2

where I: Iterator<Item = DVec2x2>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Zero for DVec2x2

const ZERO: Self

zero value of the type.

impl Copy for DVec2x2

impl StructuralPartialEq for DVec2x2