Browse Source

Math: improved documentation for *::isNormalized().

pull/278/head
Vladimír Vondruš 13 years ago
parent
commit
759a28ef45
  1. 2
      src/Math/Complex.h
  2. 1
      src/Math/DualComplex.h
  3. 1
      src/Math/DualQuaternion.h
  4. 2
      src/Math/Quaternion.h
  5. 2
      src/Math/Vector.h

2
src/Math/Complex.h

@ -150,7 +150,7 @@ template<class T> class Complex {
* @brief Whether the complex number is normalized
*
* Complex number is normalized if it has unit length: @f[
* |c|^2 = |c| = 1
* |c \cdot c - 1| < 2 \epsilon + \epsilon^2 \cong 2 \epsilon
* @f]
* @see dot(), normalized()
*/

1
src/Math/DualComplex.h

@ -133,6 +133,7 @@ template<class T> class DualComplex: public Dual<Complex<T>> {
* |c_0|^2 = |c_0| = 1
* @f]
* @see Complex::dot(), normalized()
* @todoc Improve the equation as in Complex::isNormalized()
*/
bool isNormalized() const {
return Implementation::isNormalizedSquared(lengthSquared());

1
src/Math/DualQuaternion.h

@ -139,6 +139,7 @@ template<class T> class DualQuaternion: public Dual<Quaternion<T>> {
* |\hat q|^2 = |\hat q| = 1 + \epsilon 0
* @f]
* @see lengthSquared(), normalized()
* @todoc Improve the equation as in Quaternion::isNormalized()
*/
bool isNormalized() const {
/* Comparing dual part classically, as comparing sqrt() of it would

2
src/Math/Quaternion.h

@ -164,7 +164,7 @@ template<class T> class Quaternion {
* @brief Whether the quaternion is normalized
*
* Quaternion is normalized if it has unit length: @f[
* |q|^2 = |q| = 1
* |q \cdot q - 1| < 2 \epsilon + \epsilon^2 \cong 2 \epsilon
* @f]
* @see dot(), normalized()
*/

2
src/Math/Vector.h

@ -224,7 +224,7 @@ template<std::size_t size, class T> class Vector {
* @brief Whether the vector is normalized
*
* The vector is normalized if it has unit length: @f[
* |\boldsymbol a|^2 = |\boldsymbol a| = 1
* |\boldsymbol a \cdot \boldsymbol a - 1| < 2 \epsilon + \epsilon^2 \cong 2 \epsilon
* @f]
* @see dot(), normalized()
*/

Loading…
Cancel
Save