Struct nalgebra::geometry::DualQuaternion[][src]

#[repr(C)]pub struct DualQuaternion<N: Scalar> {
    pub real: Quaternion<N>,
    pub dual: Quaternion<N>,
}

A dual quaternion.

Indexing

DualQuaternions are stored as [..real, ..dual]. Both of the quaternion components are laid out in i, j, k, w order.


let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);

let dq = DualQuaternion::from_real_and_dual(real, dual);
assert_eq!(dq[0], 2.0);
assert_eq!(dq[1], 3.0);

assert_eq!(dq[4], 6.0);
assert_eq!(dq[7], 5.0);

NOTE: As of December 2020, dual quaternion support is a work in progress. If a feature that you need is missing, feel free to open an issue or a PR. See https://github.com/dimforge/nalgebra/issues/487

Fields

real: Quaternion<N>

The real component of the quaternion

dual: Quaternion<N>

The dual component of the quaternion

Implementations

impl<N: SimdRealField> DualQuaternion<N> where
    N::Element: SimdRealField
[src]

#[must_use = "Did you mean to use normalize_mut()?"]pub fn normalize(&self) -> Self[src]

Normalizes this quaternion.

Example

let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);
let dq = DualQuaternion::from_real_and_dual(real, dual);

let dq_normalized = dq.normalize();

relative_eq!(dq_normalized.real.norm(), 1.0);

pub fn normalize_mut(&mut self) -> N[src]

Normalizes this quaternion.

Example

let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);
let mut dq = DualQuaternion::from_real_and_dual(real, dual);

dq.normalize_mut();

relative_eq!(dq.real.norm(), 1.0);

#[must_use = "Did you mean to use conjugate_mut()?"]pub fn conjugate(&self) -> Self[src]

The conjugate of this dual quaternion, containing the conjugate of the real and imaginary parts..

Example

let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);
let dq = DualQuaternion::from_real_and_dual(real, dual);

let conj = dq.conjugate();
assert!(conj.real.i == -2.0 && conj.real.j == -3.0 && conj.real.k == -4.0);
assert!(conj.real.w == 1.0);
assert!(conj.dual.i == -6.0 && conj.dual.j == -7.0 && conj.dual.k == -8.0);
assert!(conj.dual.w == 5.0);

pub fn conjugate_mut(&mut self)[src]

Replaces this quaternion by its conjugate.

Example

let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);
let mut dq = DualQuaternion::from_real_and_dual(real, dual);

dq.conjugate_mut();
assert!(dq.real.i == -2.0 && dq.real.j == -3.0 && dq.real.k == -4.0);
assert!(dq.real.w == 1.0);
assert!(dq.dual.i == -6.0 && dq.dual.j == -7.0 && dq.dual.k == -8.0);
assert!(dq.dual.w == 5.0);

#[must_use = "Did you mean to use try_inverse_mut()?"]pub fn try_inverse(&self) -> Option<Self> where
    N: RealField
[src]

Inverts this dual quaternion if it is not zero.

Example

let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);
let dq = DualQuaternion::from_real_and_dual(real, dual);
let inverse = dq.try_inverse();

assert!(inverse.is_some());
assert_relative_eq!(inverse.unwrap() * dq, DualQuaternion::identity());

//Non-invertible case
let zero = Quaternion::new(0.0, 0.0, 0.0, 0.0);
let dq = DualQuaternion::from_real_and_dual(zero, zero);
let inverse = dq.try_inverse();

assert!(inverse.is_none());

pub fn try_inverse_mut(&mut self) -> bool where
    N: RealField
[src]

Inverts this dual quaternion in-place if it is not zero.

Example

let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);
let dq = DualQuaternion::from_real_and_dual(real, dual);
let mut dq_inverse = dq;
dq_inverse.try_inverse_mut();

assert_relative_eq!(dq_inverse * dq, DualQuaternion::identity());

//Non-invertible case
let zero = Quaternion::new(0.0, 0.0, 0.0, 0.0);
let mut dq = DualQuaternion::from_real_and_dual(zero, zero);
assert!(!dq.try_inverse_mut());

pub fn lerp(&self, other: &Self, t: N) -> Self[src]

Linear interpolation between two dual quaternions.

Computes self * (1 - t) + other * t.

Example

let dq1 = DualQuaternion::from_real_and_dual(
    Quaternion::new(1.0, 0.0, 0.0, 4.0),
    Quaternion::new(0.0, 2.0, 0.0, 0.0)
);
let dq2 = DualQuaternion::from_real_and_dual(
    Quaternion::new(2.0, 0.0, 1.0, 0.0),
    Quaternion::new(0.0, 2.0, 0.0, 0.0)
);
assert_eq!(dq1.lerp(&dq2, 0.25), DualQuaternion::from_real_and_dual(
    Quaternion::new(1.25, 0.0, 0.25, 3.0),
    Quaternion::new(0.0, 2.0, 0.0, 0.0)
));

impl<N: Scalar> DualQuaternion<N>[src]

pub fn from_real_and_dual(real: Quaternion<N>, dual: Quaternion<N>) -> Self[src]

Creates a dual quaternion from its rotation and translation components.

Example

let rot = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let trans = Quaternion::new(5.0, 6.0, 7.0, 8.0);

let dq = DualQuaternion::from_real_and_dual(rot, trans);
assert_eq!(dq.real.w, 1.0);

pub fn identity() -> Self where
    N: SimdRealField
[src]

The dual quaternion multiplicative identity.

Example


let dq1 = DualQuaternion::identity();
let dq2 = DualQuaternion::from_real_and_dual(
    Quaternion::new(1.,2.,3.,4.),
    Quaternion::new(5.,6.,7.,8.)
);

assert_eq!(dq1 * dq2, dq2);
assert_eq!(dq2 * dq1, dq2);

pub fn cast<To: Scalar>(self) -> DualQuaternion<To> where
    DualQuaternion<To>: SupersetOf<Self>, 
[src]

Cast the components of self to another type.

Example

let q = DualQuaternion::from_real(Quaternion::new(1.0f64, 2.0, 3.0, 4.0));
let q2 = q.cast::<f32>();
assert_eq!(q2, DualQuaternion::from_real(Quaternion::new(1.0f32, 2.0, 3.0, 4.0)));

impl<N: SimdRealField> DualQuaternion<N> where
    N::Element: SimdRealField
[src]

pub fn from_real(real: Quaternion<N>) -> Self[src]

Creates a dual quaternion from only its real part, with no translation component.

Example

let rot = Quaternion::new(1.0, 2.0, 3.0, 4.0);

let dq = DualQuaternion::from_real(rot);
assert_eq!(dq.real.w, 1.0);
assert_eq!(dq.dual.w, 0.0);

Trait Implementations

impl<N: RealField + AbsDiffEq<Epsilon = N>> AbsDiffEq<DualQuaternion<N>> for DualQuaternion<N>[src]

type Epsilon = N

Used for specifying relative comparisons.

impl<'a, 'b, N: SimdRealField> Add<&'b DualQuaternion<N>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the + operator.

impl<'b, N: SimdRealField> Add<&'b DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the + operator.

impl<'a, N: SimdRealField> Add<DualQuaternion<N>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the + operator.

impl<N: SimdRealField> Add<DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the + operator.

impl<'b, N: SimdRealField> AddAssign<&'b DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<N: SimdRealField> AddAssign<DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<N: SimdRealField> AsMut<[N; 8]> for DualQuaternion<N>[src]

impl<N: SimdRealField> AsRef<[N; 8]> for DualQuaternion<N>[src]

impl<N: Clone + Scalar> Clone for DualQuaternion<N>[src]

impl<N: Copy + Scalar> Copy for DualQuaternion<N>[src]

impl<N: Debug + Scalar> Debug for DualQuaternion<N>[src]

impl<N: Scalar + Zero> Default for DualQuaternion<N>[src]

impl<'a, 'b, N: SimdRealField> Div<&'b Unit<DualQuaternion<N>>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the / operator.

impl<'b, N: SimdRealField> Div<&'b Unit<DualQuaternion<N>>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the / operator.

impl<N: SimdRealField> Div<N> for DualQuaternion<N> where
    N::Element: SimdRealField
[src]

type Output = DualQuaternion<N>

The resulting type after applying the / operator.

impl<'a, N: SimdRealField> Div<N> for &'a DualQuaternion<N> where
    N::Element: SimdRealField
[src]

type Output = DualQuaternion<N>

The resulting type after applying the / operator.

impl<'a, N: SimdRealField> Div<Unit<DualQuaternion<N>>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the / operator.

impl<N: SimdRealField> Div<Unit<DualQuaternion<N>>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the / operator.

impl<'b, N: SimdRealField> DivAssign<&'b Unit<DualQuaternion<N>>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<N: SimdRealField> DivAssign<N> for DualQuaternion<N> where
    N::Element: SimdRealField
[src]

impl<N: SimdRealField> DivAssign<Unit<DualQuaternion<N>>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<N: Eq + Scalar> Eq for DualQuaternion<N>[src]

impl<N: SimdRealField> Index<usize> for DualQuaternion<N>[src]

type Output = N

The returned type after indexing.

impl<N: SimdRealField> IndexMut<usize> for DualQuaternion<N>[src]

impl<'a, 'b, N: SimdRealField> Mul<&'b DualQuaternion<N>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'b, N: SimdRealField> Mul<&'b DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'a, 'b, N: SimdRealField> Mul<&'b DualQuaternion<N>> for &'a UnitDualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'b, N: SimdRealField> Mul<&'b DualQuaternion<N>> for UnitDualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'a, 'b, N: SimdRealField> Mul<&'b Unit<DualQuaternion<N>>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'b, N: SimdRealField> Mul<&'b Unit<DualQuaternion<N>>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'a, N: SimdRealField> Mul<DualQuaternion<N>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<N: SimdRealField> Mul<DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'a, N: SimdRealField> Mul<DualQuaternion<N>> for &'a UnitDualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<N: SimdRealField> Mul<DualQuaternion<N>> for UnitDualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<N: SimdRealField> Mul<N> for DualQuaternion<N> where
    N::Element: SimdRealField
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'a, N: SimdRealField> Mul<N> for &'a DualQuaternion<N> where
    N::Element: SimdRealField
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'a, N: SimdRealField> Mul<Unit<DualQuaternion<N>>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<N: SimdRealField> Mul<Unit<DualQuaternion<N>>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

impl<'b, N: SimdRealField> MulAssign<&'b DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<'b, N: SimdRealField> MulAssign<&'b Unit<DualQuaternion<N>>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<N: SimdRealField> MulAssign<DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<N: SimdRealField> MulAssign<N> for DualQuaternion<N> where
    N::Element: SimdRealField
[src]

impl<N: SimdRealField> MulAssign<Unit<DualQuaternion<N>>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<N: SimdRealField> Neg for DualQuaternion<N> where
    N::Element: SimdRealField
[src]

type Output = DualQuaternion<N>

The resulting type after applying the - operator.

impl<'a, N: SimdRealField> Neg for &'a DualQuaternion<N> where
    N::Element: SimdRealField
[src]

type Output = DualQuaternion<N>

The resulting type after applying the - operator.

impl<N: SimdRealField> Normed for DualQuaternion<N>[src]

type Norm = N::SimdRealField

The type of the norm.

impl<N: SimdRealField> One for DualQuaternion<N> where
    N::Element: SimdRealField
[src]

impl<N: PartialEq + Scalar> PartialEq<DualQuaternion<N>> for DualQuaternion<N>[src]

impl<N: RealField + RelativeEq<Epsilon = N>> RelativeEq<DualQuaternion<N>> for DualQuaternion<N>[src]

impl<N: Scalar> StructuralEq for DualQuaternion<N>[src]

impl<N: Scalar> StructuralPartialEq for DualQuaternion<N>[src]

impl<'a, 'b, N: SimdRealField> Sub<&'b DualQuaternion<N>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the - operator.

impl<'b, N: SimdRealField> Sub<&'b DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the - operator.

impl<'a, N: SimdRealField> Sub<DualQuaternion<N>> for &'a DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the - operator.

impl<N: SimdRealField> Sub<DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

type Output = DualQuaternion<N>

The resulting type after applying the - operator.

impl<'b, N: SimdRealField> SubAssign<&'b DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<N: SimdRealField> SubAssign<DualQuaternion<N>> for DualQuaternion<N> where
    N::Element: SimdRealField,
    DefaultAllocator: Allocator<N, U4, U1>, 
[src]

impl<N1, N2> SubsetOf<DualQuaternion<N2>> for DualQuaternion<N1> where
    N1: SimdRealField,
    N2: SimdRealField + SupersetOf<N1>, 
[src]

impl<N: RealField + UlpsEq<Epsilon = N>> UlpsEq<DualQuaternion<N>> for DualQuaternion<N>[src]

impl<N: SimdRealField> Zero for DualQuaternion<N> where
    N::Element: SimdRealField
[src]

Auto Trait Implementations

impl<N> RefUnwindSafe for DualQuaternion<N> where
    N: RefUnwindSafe

impl<N> Send for DualQuaternion<N> where
    N: Send

impl<N> Sync for DualQuaternion<N> where
    N: Sync

impl<N> Unpin for DualQuaternion<N> where
    N: Unpin

impl<N> UnwindSafe for DualQuaternion<N> where
    N: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T, Right> ClosedAdd<Right> for T where
    T: Add<Right, Output = T> + AddAssign<Right>, 
[src]

impl<T, Right> ClosedDiv<Right> for T where
    T: Div<Right, Output = T> + DivAssign<Right>, 
[src]

impl<T, Right> ClosedMul<Right> for T where
    T: Mul<Right, Output = T> + MulAssign<Right>, 
[src]

impl<T> ClosedNeg for T where
    T: Neg<Output = T>, 
[src]

impl<T, Right> ClosedSub<Right> for T where
    T: Sub<Right, Output = T> + SubAssign<Right>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,