M-Labs
/
nalgebra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename `Unit::unwrap` to `Unit::into_inner` and deprecate `Unit::unwrap` 

See #460
This commit is contained in:
Jack Wrenn 2018-12-09 15:08:14 -05:00
parent 0f66403cbb
commit 35d2381a2a
9 changed files with 41 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/base/unit.rs
View File

@ -15,7 +15,7 @@ use alga::linear::NormedSpace;
/// A wrapper that ensures the underlying algebraic entity has a unit norm. /// A wrapper that ensures the underlying algebraic entity has a unit norm.
/// ///
/// Use `.as_ref()` or `.unwrap()` to obtain the underlying value by-reference or by-move. /// Use `.as_ref()` or `.into_inner()` to obtain the underlying value by-reference or by-move.
#[repr(transparent)] #[repr(transparent)]
#[derive(Eq, PartialEq, Clone, Hash, Debug, Copy)] #[derive(Eq, PartialEq, Clone, Hash, Debug, Copy)]
pub struct Unit<T> { pub struct Unit<T> {
@ -113,6 +113,14 @@ impl<T> Unit<T> {
/// Retrieves the underlying value. /// Retrieves the underlying value.
#[inline] #[inline]
pub fn into_inner(self) -> T {
self.value
}
/// Retrieves the underlying value.
/// Deprecated: use [Unit::into_inner] instead.
#[deprecated(note="use `.into_inner()` instead")]
#[inline]
pub fn unwrap(self) -> T { pub fn unwrap(self) -> T {
self.value self.value
} }
@ -143,7 +151,7 @@ where T::Field: RelativeEq
{ {
#[inline] #[inline]
fn to_superset(&self) -> T { fn to_superset(&self) -> T {
self.clone().unwrap() self.clone().into_inner()
} }
#[inline] #[inline]

14
src/geometry/quaternion.rs
View File

@ -156,7 +156,7 @@ impl<N: Real> Quaternion<N> {
/// let inv_q = q.try_inverse(); /// let inv_q = q.try_inverse();
/// ///
/// assert!(inv_q.is_some()); /// assert!(inv_q.is_some());
/// assert_relative_eq!(inv_q.unwrap() * q, Quaternion::identity()); /// assert_relative_eq!(inv_q.into_inner() * q, Quaternion::identity());
/// ///
/// //Non-invertible case /// //Non-invertible case
/// let q = Quaternion::new(0.0, 0.0, 0.0, 0.0); /// let q = Quaternion::new(0.0, 0.0, 0.0, 0.0);
@ -747,7 +747,7 @@ impl<N: Real> UnitQuaternion<N> {
Unit::new_unchecked(Quaternion::from( Unit::new_unchecked(Quaternion::from(
Unit::new_unchecked(self.coords) Unit::new_unchecked(self.coords)
.slerp(&Unit::new_unchecked(other.coords), t) .slerp(&Unit::new_unchecked(other.coords), t)
.unwrap(), .into_inner(),
)) ))
} }
@ -771,7 +771,7 @@ impl<N: Real> UnitQuaternion<N> {
{ {
Unit::new_unchecked(self.coords) Unit::new_unchecked(self.coords)
.try_slerp(&Unit::new_unchecked(other.coords), t, epsilon) .try_slerp(&Unit::new_unchecked(other.coords), t, epsilon)
.map(|q| Unit::new_unchecked(Quaternion::from(q.unwrap()))) .map(|q| Unit::new_unchecked(Quaternion::from(q.into_inner())))
} }
/// Compute the conjugate of this unit quaternion in-place. /// Compute the conjugate of this unit quaternion in-place.
@ -837,7 +837,7 @@ impl<N: Real> UnitQuaternion<N> {
#[inline] #[inline]
pub fn scaled_axis(&self) -> Vector3<N> { pub fn scaled_axis(&self) -> Vector3<N> {
if let Some(axis) = self.axis() { if let Some(axis) = self.axis() {
axis.unwrap() * self.angle() axis.into_inner() * self.angle()
} else { } else {
Vector3::zero() Vector3::zero()
} }
@ -894,7 +894,7 @@ impl<N: Real> UnitQuaternion<N> {
#[inline] #[inline]
pub fn ln(&self) -> Quaternion<N> { pub fn ln(&self) -> Quaternion<N> {
if let Some(v) = self.axis() { if let Some(v) = self.axis() {
Quaternion::from_parts(N::zero(), v.unwrap() * self.angle()) Quaternion::from_parts(N::zero(), v.into_inner() * self.angle())
} else { } else {
Quaternion::zero() Quaternion::zero()
} }
@ -914,7 +914,7 @@ impl<N: Real> UnitQuaternion<N> {
/// let angle = 1.2; /// let angle = 1.2;
/// let rot = UnitQuaternion::from_axis_angle(&axis, angle); /// let rot = UnitQuaternion::from_axis_angle(&axis, angle);
/// let pow = rot.powf(2.0); /// let pow = rot.powf(2.0);
/// assert_relative_eq!(pow.axis().unwrap(), axis, epsilon = 1.0e-6); /// assert_relative_eq!(pow.axis().into_inner(), axis, epsilon = 1.0e-6);
/// assert_eq!(pow.angle(), 2.4); /// assert_eq!(pow.angle(), 2.4);
/// ``` /// ```
#[inline] #[inline]
@ -1029,7 +1029,7 @@ impl<N: Real> UnitQuaternion<N> {
impl<N: Real + fmt::Display> fmt::Display for UnitQuaternion<N> { impl<N: Real + fmt::Display> fmt::Display for UnitQuaternion<N> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if let Some(axis) = self.axis() { if let Some(axis) = self.axis() {
let axis = axis.unwrap(); let axis = axis.into_inner();
write!( write!(
f, f,
"UnitQuaternion angle: {} − axis: ({}, {}, {})", "UnitQuaternion angle: {} − axis: ({}, {}, {})",

20
src/geometry/quaternion_construction.rs
View File

@ -76,7 +76,7 @@ impl<N: Real> Quaternion<N> {
where SB: Storage<N, U3> { where SB: Storage<N, U3> {
let rot = UnitQuaternion::<N>::from_axis_angle(&axis, theta * ::convert(2.0f64)); let rot = UnitQuaternion::<N>::from_axis_angle(&axis, theta * ::convert(2.0f64));
rot.unwrap() * scale rot.into_inner() * scale
} }
/// The quaternion multiplicative identity. /// The quaternion multiplicative identity.
@ -176,7 +176,7 @@ impl<N: Real> UnitQuaternion<N> {
/// let vec = Vector3::new(4.0, 5.0, 6.0); /// let vec = Vector3::new(4.0, 5.0, 6.0);
/// let q = UnitQuaternion::from_axis_angle(&axis, angle); /// let q = UnitQuaternion::from_axis_angle(&axis, angle);
/// ///
/// assert_eq!(q.axis().unwrap(), axis); /// assert_eq!(q.axis().into_inner(), axis);
/// assert_eq!(q.angle(), angle); /// assert_eq!(q.angle(), angle);
/// assert_relative_eq!(q * pt, Point3::new(6.0, 5.0, -4.0), epsilon = 1.0e-6); /// assert_relative_eq!(q * pt, Point3::new(6.0, 5.0, -4.0), epsilon = 1.0e-6);
/// assert_relative_eq!(q * vec, Vector3::new(6.0, 5.0, -4.0), epsilon = 1.0e-6); /// assert_relative_eq!(q * vec, Vector3::new(6.0, 5.0, -4.0), epsilon = 1.0e-6);
@ -244,7 +244,7 @@ impl<N: Real> UnitQuaternion<N> {
/// let rot = Rotation3::from_axis_angle(&axis, angle); /// let rot = Rotation3::from_axis_angle(&axis, angle);
/// let q = UnitQuaternion::from_rotation_matrix(&rot); /// let q = UnitQuaternion::from_rotation_matrix(&rot);
/// assert_relative_eq!(q.to_rotation_matrix(), rot, epsilon = 1.0e-6); /// assert_relative_eq!(q.to_rotation_matrix(), rot, epsilon = 1.0e-6);
/// assert_relative_eq!(q.axis().unwrap(), rot.axis().unwrap(), epsilon = 1.0e-6); /// assert_relative_eq!(q.axis().into_inner(), rot.axis().into_inner(), epsilon = 1.0e-6);
/// assert_relative_eq!(q.angle(), rot.angle(), epsilon = 1.0e-6); /// assert_relative_eq!(q.angle(), rot.angle(), epsilon = 1.0e-6);
/// ``` /// ```
#[inline] #[inline]
@ -306,7 +306,7 @@ impl<N: Real> UnitQuaternion<N> {
/// # use nalgebra::{Vector3, UnitQuaternion}; /// # use nalgebra::{Vector3, UnitQuaternion};
/// let a = Vector3::new(1.0, 2.0, 3.0); /// let a = Vector3::new(1.0, 2.0, 3.0);
/// let b = Vector3::new(3.0, 1.0, 2.0); /// let b = Vector3::new(3.0, 1.0, 2.0);
/// let q = UnitQuaternion::rotation_between(&a, &b).unwrap(); /// let q = UnitQuaternion::rotation_between(&a, &b).into_inner();
/// assert_relative_eq!(q * a, b); /// assert_relative_eq!(q * a, b);
/// assert_relative_eq!(q.inverse() * b, a); /// assert_relative_eq!(q.inverse() * b, a);
/// ``` /// ```
@ -329,8 +329,8 @@ impl<N: Real> UnitQuaternion<N> {
/// # use nalgebra::{Vector3, UnitQuaternion}; /// # use nalgebra::{Vector3, UnitQuaternion};
/// let a = Vector3::new(1.0, 2.0, 3.0); /// let a = Vector3::new(1.0, 2.0, 3.0);
/// let b = Vector3::new(3.0, 1.0, 2.0); /// let b = Vector3::new(3.0, 1.0, 2.0);
/// let q2 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.2).unwrap(); /// let q2 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.2).into_inner();
/// let q5 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.5).unwrap(); /// let q5 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.5).into_inner();
/// assert_relative_eq!(q2 * q2 * q2 * q2 * q2 * a, b, epsilon = 1.0e-6); /// assert_relative_eq!(q2 * q2 * q2 * q2 * q2 * a, b, epsilon = 1.0e-6);
/// assert_relative_eq!(q5 * q5 * a, b, epsilon = 1.0e-6); /// assert_relative_eq!(q5 * q5 * a, b, epsilon = 1.0e-6);
/// ``` /// ```
@ -365,7 +365,7 @@ impl<N: Real> UnitQuaternion<N> {
/// # use nalgebra::{Unit, Vector3, UnitQuaternion}; /// # use nalgebra::{Unit, Vector3, UnitQuaternion};
/// let a = Unit::new_normalize(Vector3::new(1.0, 2.0, 3.0)); /// let a = Unit::new_normalize(Vector3::new(1.0, 2.0, 3.0));
/// let b = Unit::new_normalize(Vector3::new(3.0, 1.0, 2.0)); /// let b = Unit::new_normalize(Vector3::new(3.0, 1.0, 2.0));
/// let q = UnitQuaternion::rotation_between(&a, &b).unwrap(); /// let q = UnitQuaternion::rotation_between(&a, &b).into_inner();
/// assert_relative_eq!(q * a, b); /// assert_relative_eq!(q * a, b);
/// assert_relative_eq!(q.inverse() * b, a); /// assert_relative_eq!(q.inverse() * b, a);
/// ``` /// ```
@ -391,8 +391,8 @@ impl<N: Real> UnitQuaternion<N> {
/// # use nalgebra::{Unit, Vector3, UnitQuaternion}; /// # use nalgebra::{Unit, Vector3, UnitQuaternion};
/// let a = Unit::new_normalize(Vector3::new(1.0, 2.0, 3.0)); /// let a = Unit::new_normalize(Vector3::new(1.0, 2.0, 3.0));
/// let b = Unit::new_normalize(Vector3::new(3.0, 1.0, 2.0)); /// let b = Unit::new_normalize(Vector3::new(3.0, 1.0, 2.0));
/// let q2 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.2).unwrap(); /// let q2 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.2).into_inner();
/// let q5 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.5).unwrap(); /// let q5 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.5).into_inner();
/// assert_relative_eq!(q2 * q2 * q2 * q2 * q2 * a, b, epsilon = 1.0e-6); /// assert_relative_eq!(q2 * q2 * q2 * q2 * q2 * a, b, epsilon = 1.0e-6);
/// assert_relative_eq!(q5 * q5 * a, b, epsilon = 1.0e-6); /// assert_relative_eq!(q5 * q5 * a, b, epsilon = 1.0e-6);
/// ``` /// ```
@ -701,7 +701,7 @@ mod tests {
let mut rng = rand::prng::XorShiftRng::from_seed([0xAB; 16]); let mut rng = rand::prng::XorShiftRng::from_seed([0xAB; 16]);
for _ in 0..1000 { for _ in 0..1000 {
let x = rng.gen::<UnitQuaternion<f32>>(); let x = rng.gen::<UnitQuaternion<f32>>();
assert!(relative_eq!(x.unwrap().norm(), 1.0)) assert!(relative_eq!(x.into_inner().norm(), 1.0))
} }
} }
} }

4
src/geometry/quaternion_ops.rs
View File

@ -469,7 +469,7 @@ quaternion_op_impl!(
(U4, U1), (U3, U1) for SB: Storage<N, U3> ; (U4, U1), (U3, U1) for SB: Storage<N, U3> ;
self: &'a UnitQuaternion<N>, rhs: Unit<Vector<N, U3, SB>>, self: &'a UnitQuaternion<N>, rhs: Unit<Vector<N, U3, SB>>,
Output = Unit<Vector3<N>> => U3, U4; Output = Unit<Vector3<N>> => U3, U4;
Unit::new_unchecked(self * rhs.unwrap()); Unit::new_unchecked(self * rhs.into_inner());
'a); 'a);
quaternion_op_impl!( quaternion_op_impl!(
@ -485,7 +485,7 @@ quaternion_op_impl!(
(U4, U1), (U3, U1) for SB: Storage<N, U3> ; (U4, U1), (U3, U1) for SB: Storage<N, U3> ;
self: UnitQuaternion<N>, rhs: Unit<Vector<N, U3, SB>>, self: UnitQuaternion<N>, rhs: Unit<Vector<N, U3, SB>>,
Output = Unit<Vector3<N>> => U3, U4; Output = Unit<Vector3<N>> => U3, U4;
Unit::new_unchecked(self * rhs.unwrap()); Unit::new_unchecked(self * rhs.into_inner());
); );
macro_rules! scalar_op_impl( macro_rules! scalar_op_impl(

2
src/geometry/reflection.rs
View File

@ -20,7 +20,7 @@ impl<N: Real, D: Dim, S: Storage<N, D>> Reflection<N, D, S> {
/// represents a plane that passes through the origin. /// represents a plane that passes through the origin.
pub fn new(axis: Unit<Vector<N, D, S>>, bias: N) -> Reflection<N, D, S> { pub fn new(axis: Unit<Vector<N, D, S>>, bias: N) -> Reflection<N, D, S> {
Reflection { Reflection {
axis: axis.unwrap(), axis: axis.into_inner(),
bias: bias, bias: bias,
} }
} }

4
src/geometry/rotation_ops.rs
View File

@ -125,8 +125,8 @@ md_impl_all!(
where DefaultAllocator: Allocator<N, D> where DefaultAllocator: Allocator<N, D>
where ShapeConstraint: AreMultipliable<D, D, D, U1>; where ShapeConstraint: AreMultipliable<D, D, D, U1>;
self: Rotation<N, D>, right: Unit<Vector<N, D, S>>, Output = Unit<VectorN<N, D>>; self: Rotation<N, D>, right: Unit<Vector<N, D, S>>, Output = Unit<VectorN<N, D>>;
[val val] => Unit::new_unchecked(self.unwrap() * right.unwrap()); [val val] => Unit::new_unchecked(self.unwrap() * right.into_inner());
[ref val] => Unit::new_unchecked(self.matrix() * right.unwrap()); [ref val] => Unit::new_unchecked(self.matrix() * right.into_inner());
[val ref] => Unit::new_unchecked(self.unwrap() * right.as_ref()); [val ref] => Unit::new_unchecked(self.unwrap() * right.as_ref());
[ref ref] => Unit::new_unchecked(self.matrix() * right.as_ref()); [ref ref] => Unit::new_unchecked(self.matrix() * right.as_ref());
); );

2
src/geometry/rotation_specialization.rs
View File

@ -616,7 +616,7 @@ impl<N: Real> Rotation3<N> {
#[inline] #[inline]
pub fn scaled_axis(&self) -> Vector3<N> { pub fn scaled_axis(&self) -> Vector3<N> {
if let Some(axis) = self.axis() { if let Some(axis) = self.axis() {
axis.unwrap() * self.angle() axis.into_inner() * self.angle()
} else { } else {
Vector::zero() Vector::zero()
} }

14
src/geometry/unit_complex_ops.rs
View File

@ -50,7 +50,7 @@ impl<N: Real> Mul<UnitComplex<N>> for UnitComplex<N> {
#[inline] #[inline]
fn mul(self, rhs: UnitComplex<N>) -> UnitComplex<N> { fn mul(self, rhs: UnitComplex<N>) -> UnitComplex<N> {
Unit::new_unchecked(self.unwrap() * rhs.unwrap()) Unit::new_unchecked(self.into_inner() * rhs.into_inner())
} }
} }
@ -59,7 +59,7 @@ impl<'a, N: Real> Mul<UnitComplex<N>> for &'a UnitComplex<N> {
#[inline] #[inline]
fn mul(self, rhs: UnitComplex<N>) -> UnitComplex<N> { fn mul(self, rhs: UnitComplex<N>) -> UnitComplex<N> {
Unit::new_unchecked(self.complex() * rhs.unwrap()) Unit::new_unchecked(self.complex() * rhs.into_inner())
} }
} }
@ -68,7 +68,7 @@ impl<'b, N: Real> Mul<&'b UnitComplex<N>> for UnitComplex<N> {
#[inline] #[inline]
fn mul(self, rhs: &'b UnitComplex<N>) -> UnitComplex<N> { fn mul(self, rhs: &'b UnitComplex<N>) -> UnitComplex<N> {
Unit::new_unchecked(self.unwrap() * rhs.complex()) Unit::new_unchecked(self.into_inner() * rhs.complex())
} }
} }
@ -87,7 +87,7 @@ impl<N: Real> Div<UnitComplex<N>> for UnitComplex<N> {
#[inline] #[inline]
fn div(self, rhs: UnitComplex<N>) -> UnitComplex<N> { fn div(self, rhs: UnitComplex<N>) -> UnitComplex<N> {
Unit::new_unchecked(self.unwrap() * rhs.conjugate().unwrap()) Unit::new_unchecked(self.into_inner() * rhs.conjugate().into_inner())
} }
} }
@ -96,7 +96,7 @@ impl<'a, N: Real> Div<UnitComplex<N>> for &'a UnitComplex<N> {
#[inline] #[inline]
fn div(self, rhs: UnitComplex<N>) -> UnitComplex<N> { fn div(self, rhs: UnitComplex<N>) -> UnitComplex<N> {
Unit::new_unchecked(self.complex() * rhs.conjugate().unwrap()) Unit::new_unchecked(self.complex() * rhs.conjugate().into_inner())
} }
} }
@ -105,7 +105,7 @@ impl<'b, N: Real> Div<&'b UnitComplex<N>> for UnitComplex<N> {
#[inline] #[inline]
fn div(self, rhs: &'b UnitComplex<N>) -> UnitComplex<N> { fn div(self, rhs: &'b UnitComplex<N>) -> UnitComplex<N> {
Unit::new_unchecked(self.unwrap() * rhs.conjugate().unwrap()) Unit::new_unchecked(self.into_inner() * rhs.conjugate().into_inner())
} }
} }
@ -114,7 +114,7 @@ impl<'a, 'b, N: Real> Div<&'b UnitComplex<N>> for &'a UnitComplex<N> {
#[inline] #[inline]
fn div(self, rhs: &'b UnitComplex<N>) -> UnitComplex<N> { fn div(self, rhs: &'b UnitComplex<N>) -> UnitComplex<N> {
Unit::new_unchecked(self.complex() * rhs.conjugate().unwrap()) Unit::new_unchecked(self.complex() * rhs.conjugate().into_inner())
} }
} }

2
src/linalg/schur.rs
View File

@ -412,7 +412,7 @@ where
rot.rotate_rows(&mut m); rot.rotate_rows(&mut m);
if compute_q { if compute_q {
let c = rot.unwrap(); let c = rot.into_inner();
// XXX: we have to build the matrix manually because // XXX: we have to build the matrix manually because
// rot.to_rotation_matrix().unwrap() causes an ICE. // rot.to_rotation_matrix().unwrap() causes an ICE.
q = Some(MatrixN::from_column_slice_generic( q = Some(MatrixN::from_column_slice_generic(