use approx::{AbsDiffEq, RelativeEq, UlpsEq}; use num::{One, Zero}; use std::fmt; use std::hash; #[cfg(feature = "abomonation-serialize")] use std::io::{Result as IOResult, Write}; #[cfg(feature = "serde-serialize")] use serde; #[cfg(feature = "serde-serialize")] use base::storage::Owned; #[cfg(feature = "abomonation-serialize")] use abomonation::Abomonation; use alga::general::Real; use base::allocator::Allocator; use base::dimension::{DimName, DimNameAdd, DimNameSum, U1}; use base::{DefaultAllocator, MatrixN, Scalar}; /// A rotation matrix. #[repr(C)] #[derive(Debug)] pub struct Rotation where DefaultAllocator: Allocator, { matrix: MatrixN, } impl hash::Hash for Rotation where DefaultAllocator: Allocator, >::Buffer: hash::Hash, { fn hash(&self, state: &mut H) { self.matrix.hash(state) } } impl Copy for Rotation where DefaultAllocator: Allocator, >::Buffer: Copy, { } impl Clone for Rotation where DefaultAllocator: Allocator, >::Buffer: Clone, { #[inline] fn clone(&self) -> Self { Rotation::from_matrix_unchecked(self.matrix.clone()) } } #[cfg(feature = "abomonation-serialize")] impl Abomonation for Rotation where N: Scalar, D: DimName, MatrixN: Abomonation, DefaultAllocator: Allocator, { unsafe fn entomb(&self, writer: &mut W) -> IOResult<()> { self.matrix.entomb(writer) } fn extent(&self) -> usize { self.matrix.extent() } unsafe fn exhume<'a, 'b>(&'a mut self, bytes: &'b mut [u8]) -> Option<&'b mut [u8]> { self.matrix.exhume(bytes) } } #[cfg(feature = "serde-serialize")] impl serde::Serialize for Rotation where DefaultAllocator: Allocator, Owned: serde::Serialize, { fn serialize(&self, serializer: S) -> Result where S: serde::Serializer, { self.matrix.serialize(serializer) } } #[cfg(feature = "serde-serialize")] impl<'a, N: Scalar, D: DimName> serde::Deserialize<'a> for Rotation where DefaultAllocator: Allocator, Owned: serde::Deserialize<'a>, { fn deserialize(deserializer: Des) -> Result where Des: serde::Deserializer<'a>, { let matrix = MatrixN::::deserialize(deserializer)?; Ok(Rotation::from_matrix_unchecked(matrix)) } } impl Rotation where DefaultAllocator: Allocator, { /// A reference to the underlying matrix representation of this rotation. #[inline] pub fn matrix(&self) -> &MatrixN { &self.matrix } /// A mutable reference to the underlying matrix representation of this rotation. /// /// This is unsafe because this allows the user to replace the matrix by another one that is /// non-square, non-inversible, or non-orthonormal. If one of those properties is broken, /// subsequent method calls may be UB. #[inline] pub unsafe fn matrix_mut(&mut self) -> &mut MatrixN { &mut self.matrix } /// Unwraps the underlying matrix. #[inline] pub fn unwrap(self) -> MatrixN { self.matrix } /// Converts this rotation into its equivalent homogeneous transformation matrix. #[inline] pub fn to_homogeneous(&self) -> MatrixN> where N: Zero + One, D: DimNameAdd, DefaultAllocator: Allocator, DimNameSum>, { let mut res = MatrixN::>::identity(); res.fixed_slice_mut::(0, 0).copy_from(&self.matrix); res } /// Creates a new rotation from the given square matrix. /// /// The matrix squareness is checked but not its orthonormality. #[inline] pub fn from_matrix_unchecked(matrix: MatrixN) -> Rotation { assert!( matrix.is_square(), "Unable to create a rotation from a non-square matrix." ); Rotation { matrix: matrix } } /// Transposes `self`. #[inline] pub fn transpose(&self) -> Rotation { Rotation::from_matrix_unchecked(self.matrix.transpose()) } /// Inverts `self`. #[inline] pub fn inverse(&self) -> Rotation { self.transpose() } /// Transposes `self` in-place. #[inline] pub fn transpose_mut(&mut self) { self.matrix.transpose_mut() } /// Inverts `self` in-place. #[inline] pub fn inverse_mut(&mut self) { self.transpose_mut() } } impl Eq for Rotation where DefaultAllocator: Allocator, { } impl PartialEq for Rotation where DefaultAllocator: Allocator, { #[inline] fn eq(&self, right: &Rotation) -> bool { self.matrix == right.matrix } } impl AbsDiffEq for Rotation where N: Scalar + AbsDiffEq, DefaultAllocator: Allocator, N::Epsilon: Copy, { type Epsilon = N::Epsilon; #[inline] fn default_epsilon() -> Self::Epsilon { N::default_epsilon() } #[inline] fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool { self.matrix.abs_diff_eq(&other.matrix, epsilon) } } impl RelativeEq for Rotation where N: Scalar + RelativeEq, DefaultAllocator: Allocator, N::Epsilon: Copy, { #[inline] fn default_max_relative() -> Self::Epsilon { N::default_max_relative() } #[inline] fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool { self.matrix .relative_eq(&other.matrix, epsilon, max_relative) } } impl UlpsEq for Rotation where N: Scalar + UlpsEq, DefaultAllocator: Allocator, N::Epsilon: Copy, { #[inline] fn default_max_ulps() -> u32 { N::default_max_ulps() } #[inline] fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool { self.matrix.ulps_eq(&other.matrix, epsilon, max_ulps) } } /* * * Display * */ impl fmt::Display for Rotation where N: Real + fmt::Display, DefaultAllocator: Allocator + Allocator, { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { let precision = f.precision().unwrap_or(3); try!(writeln!(f, "Rotation matrix {{")); try!(write!(f, "{:.*}", precision, self.matrix)); writeln!(f, "}}") } } // // /* // // * // // * Absolute // // * // // */ // // impl Absolute for $t { // // type AbsoluteValue = $submatrix; // // // // #[inline] // // fn abs(m: &$t) -> $submatrix { // // Absolute::abs(&m.submatrix) // // } // // }