ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Math: doc++, minor code cleanup.

pull/7/head
Vladimír Vondruš 13 years ago
parent
0ed0f261b4
commit
4c16a767db
2 changed files with 17 additions and 20 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 14
      src/Math/RectangularMatrix.h
  2. 23
      src/Math/Vector.h

14
src/Math/RectangularMatrix.h
Unescape View File

@ -388,10 +388,10 @@ template<std::size_t cols, std::size_t rows, class T> class RectangularMatrix {
Same as RectangularMatrix::operator*(U) const. Same as RectangularMatrix::operator*(U) const.
*/ */
#ifndef DOXYGEN_GENERATING_OUTPUT #ifdef DOXYGEN_GENERATING_OUTPUT
template<std::size_t cols, std::size_t rows, class T, class U> inline typename std::enable_if<std::is_arithmetic<U>::value, RectangularMatrix<cols, rows, T>>::type operator*(U number, const RectangularMatrix<cols, rows, T>& matrix) {
#else
template<std::size_t cols, std::size_t rows, class T, class U> inline RectangularMatrix<cols, rows, T> operator*(U number, const RectangularMatrix<cols, rows, T>& matrix) { template<std::size_t cols, std::size_t rows, class T, class U> inline RectangularMatrix<cols, rows, T> operator*(U number, const RectangularMatrix<cols, rows, T>& matrix) {
#else
template<std::size_t cols, std::size_t rows, class T, class U> inline typename std::enable_if<std::is_arithmetic<U>::value, RectangularMatrix<cols, rows, T>>::type operator*(U number, const RectangularMatrix<cols, rows, T>& matrix) {
#endif #endif
return matrix*number; return matrix*number;
} }
@ -402,12 +402,12 @@ template<std::size_t cols, std::size_t rows, class T, class U> inline Rectangula
@f[ @f[
\boldsymbol B_{ji} = \frac a {\boldsymbol A_{ji}} \boldsymbol B_{ji} = \frac a {\boldsymbol A_{ji}}
@f] @f]
@see RectangularMatrix::operator/() @see RectangularMatrix::operator/(U) const
*/ */
#ifndef DOXYGEN_GENERATING_OUTPUT #ifdef DOXYGEN_GENERATING_OUTPUT
template<std::size_t cols, std::size_t rows, class T, class U> typename std::enable_if<std::is_arithmetic<U>::value, RectangularMatrix<cols, rows, T>>::type operator/(U number, const RectangularMatrix<cols, rows, T>& matrix) {
#else
template<std::size_t cols, std::size_t rows, class T, class U> RectangularMatrix<cols, rows, T> operator/(U number, const RectangularMatrix<cols, rows, T>& matrix) { template<std::size_t cols, std::size_t rows, class T, class U> RectangularMatrix<cols, rows, T> operator/(U number, const RectangularMatrix<cols, rows, T>& matrix) {
#else
template<std::size_t cols, std::size_t rows, class T, class U> typename std::enable_if<std::is_arithmetic<U>::value, RectangularMatrix<cols, rows, T>>::type operator/(U number, const RectangularMatrix<cols, rows, T>& matrix) {
#endif #endif
RectangularMatrix<cols, rows, T> out; RectangularMatrix<cols, rows, T> out;

23
src/Math/Vector.h
Unescape View File

@ -41,7 +41,7 @@ template<std::size_t size, class T> class Vector: public RectangularMatrix<1, si
* @brief Dot product * @brief Dot product
* *
* @f[ * @f[
* a \cdot b = \sum_{i=0}^{n-1} a_ib_i * \boldsymbol a \cdot \boldsymbol b = \sum_{i=0}^{n-1} \boldsymbol a_i \boldsymbol b_i
* @f] * @f]
* @see dot() const * @see dot() const
*/ */
@ -58,7 +58,7 @@ template<std::size_t size, class T> class Vector: public RectangularMatrix<1, si
* @brief Angle between normalized vectors (in radians) * @brief Angle between normalized vectors (in radians)
* *
* Expects that both vectors are normalized. @f[ * Expects that both vectors are normalized. @f[
* \theta = acos \left( \frac{a \cdot b}{|a| \cdot |b|} \right) * \theta = acos \left( \frac{\boldsymbol a \cdot \boldsymbol b}{|\boldsymbol a| \cdot |\boldsymbol b|} \right) = acos (\boldsymbol a \cdot \boldsymbol b)
* @f] * @f]
*/ */
inline static T angle(const Vector<size, T>& normalizedA, const Vector<size, T>& normalizedB) { inline static T angle(const Vector<size, T>& normalizedA, const Vector<size, T>& normalizedB) {
@ -74,7 +74,7 @@ template<std::size_t size, class T> class Vector: public RectangularMatrix<1, si
* @param t Interpolation phase (from range @f$ [0; 1] @f$) * @param t Interpolation phase (from range @f$ [0; 1] @f$)
* *
* The interpolation is done as in following: @f[ * The interpolation is done as in following: @f[
* v_{LERP} = (1 - t) \boldsymbol v_A + t \boldsymbol v_B * \boldsymbol v_{LERP} = (1 - t) \boldsymbol v_A + t \boldsymbol v_B
* @f] * @f]
* @todo http://fgiesen.wordpress.com/2012/08/15/linear-interpolation-past-present-and-future/ * @todo http://fgiesen.wordpress.com/2012/08/15/linear-interpolation-past-present-and-future/
* (when SIMD is in place) * (when SIMD is in place)
@ -83,22 +83,19 @@ template<std::size_t size, class T> class Vector: public RectangularMatrix<1, si
return (U(1) - t)*a + t*b; return (U(1) - t)*a + t*b;
} }
/** @brief Default constructor */ /** @brief Construct zero-filled vector */
inline constexpr /*implicit*/ Vector() {} inline constexpr /*implicit*/ Vector() {}
/** @todo Creating Vector from combination of vector and scalar types */ /** @todo Creating Vector from combination of vector and scalar types */
/** /**
* @brief Initializer-list constructor * @brief Construct vector from values
* @param first First value * @param first First value
* @param next Next values * @param next Next values
*/ */
template<class ...U> inline constexpr /*implicit*/ Vector(T first, U... next): RectangularMatrix<1, size, T>(first, next...) {} template<class ...U> inline constexpr /*implicit*/ Vector(T first, U... next): RectangularMatrix<1, size, T>(first, next...) {}
/** /** @brief Construct vector with one value for all fields */
* @brief Constructor
* @param value Value for all fields
*/
#ifdef DOXYGEN_GENERATING_OUTPUT #ifdef DOXYGEN_GENERATING_OUTPUT
inline explicit Vector(T value) { inline explicit Vector(T value) {
#else #else
@ -183,7 +180,7 @@ template<std::size_t size, class T> class Vector: public RectangularMatrix<1, si
* @see operator*=(const Vector<size, U>&) * @see operator*=(const Vector<size, U>&)
*/ */
template<class U> inline Vector<size, T> operator*(const Vector<size, U>& other) const { template<class U> inline Vector<size, T> operator*(const Vector<size, U>& other) const {
return Vector<size, T>(*this)*=other; return Vector<size, T>(*this) *= other;
} }
/** /**
@ -206,7 +203,7 @@ template<std::size_t size, class T> class Vector: public RectangularMatrix<1, si
* @see operator/=(const Vector<size, U>&) * @see operator/=(const Vector<size, U>&)
*/ */
template<class U> inline Vector<size, T> operator/(const Vector<size, U>& other) const { template<class U> inline Vector<size, T> operator/(const Vector<size, U>& other) const {
return Vector<size, T>(*this)/=other; return Vector<size, T>(*this) /= other;
} }
/** /**
@ -214,7 +211,7 @@ template<std::size_t size, class T> class Vector: public RectangularMatrix<1, si
* *
* Should be used instead of length() for comparing vector length with * Should be used instead of length() for comparing vector length with
* other values, because it doesn't compute the square root. @f[ * other values, because it doesn't compute the square root. @f[
* a \cdot a = \sum_{i=0}^{n-1} a_i^2 * \boldsymbol a \cdot \boldsymbol a = \sum_{i=0}^{n-1} \boldsymbol a_i^2
* @f] * @f]
* @see dot(const Vector<size, T>&, const Vector<size, T>&) * @see dot(const Vector<size, T>&, const Vector<size, T>&)
*/ */
@ -226,7 +223,7 @@ template<std::size_t size, class T> class Vector: public RectangularMatrix<1, si
* @brief %Vector length * @brief %Vector length
* *
* @f[ * @f[
* |a| = \sqrt{a \cdot a} * |\boldsymbol a| = \sqrt{\boldsymbol a \cdot \boldsymbol a}
* @f] * @f]
* @see dot() const * @see dot() const
*/ */

Write Preview
Loading…
Cancel
Save