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

Fix doctests broken by 35d2381a2a

This commit is contained in:
Jack Wrenn 2018-12-10 10:52:19 -05:00 committed by Sébastien Crozet
parent 0d47a8e16b
commit 2595db1607
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
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.into_inner() * q, Quaternion::identity()); /// assert_relative_eq!(inv_q.unwrap() * 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);
@ -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().into_inner(), axis, epsilon = 1.0e-6); /// assert_relative_eq!(pow.axis().unwrap(), axis, epsilon = 1.0e-6);
/// assert_eq!(pow.angle(), 2.4); /// assert_eq!(pow.angle(), 2.4);
/// ``` /// ```
#[inline] #[inline]

16
src/geometry/quaternion_construction.rs
View File

@ -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().into_inner(), axis); /// assert_eq!(q.axis().unwrap(), 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().into_inner(), rot.axis().into_inner(), epsilon = 1.0e-6); /// assert_relative_eq!(q.axis().unwrap(), rot.axis().unwrap(), 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).into_inner(); /// let q = UnitQuaternion::rotation_between(&a, &b).unwrap();
/// 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).into_inner(); /// let q2 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.2).unwrap();
/// let q5 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.5).into_inner(); /// let q5 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.5).unwrap();
/// 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).into_inner(); /// let q = UnitQuaternion::rotation_between(&a, &b).unwrap();
/// 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).into_inner(); /// let q2 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.2).unwrap();
/// let q5 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.5).into_inner(); /// let q5 = UnitQuaternion::scaled_rotation_between(&a, &b, 0.5).unwrap();
/// 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);
/// ``` /// ```