Browse Source

Math: doc++

pull/118/head
Vladimír Vondruš 11 years ago
parent
commit
5160779e5e
  1. 4
      src/Magnum/Math/Dual.h
  2. 5
      src/Magnum/Math/Functions.h
  3. 4
      src/Magnum/Math/Vector.h

4
src/Magnum/Math/Dual.h

@ -240,13 +240,13 @@ template<class T> Corrade::Utility::Debug& operator<<(Corrade::Utility::Debug& d
<< value.dual() << Corrade::Utility::Debug::nospace << ")";
}
/** @relates Dual
/** @relatesalso Dual
@brief Square root of dual number
@f[
\sqrt{\hat a} = \sqrt{a_0} + \epsilon \frac{a_\epsilon}{2 \sqrt{a_0}}
@f]
@see @ref Math::sqrt(const T&)
@see @ref sqrt(const T&)
*/
template<class T> Dual<T> sqrt(const Dual<T>& dual) {
T sqrt0 = std::sqrt(dual.real());

5
src/Magnum/Math/Functions.h

@ -340,7 +340,7 @@ template<std::size_t size, class T> Vector<size, T> ceil(const Vector<size, T>&
/**
@brief Square root
@see @ref sqrtInverted(), @ref Vector::length()
@see @ref sqrtInverted(), @ref Vector::length(), @ref sqrt(const Dual<T>&)
*/
#ifdef DOXYGEN_GENERATING_OUTPUT
template<class T> inline T sqrt(const T& a);
@ -419,7 +419,8 @@ template<std::size_t size, class T, class U> inline Vector<size, T> lerpInverted
/**
@brief Fused multiply-add
Computes and returns @f$ ab + c @f$.
Computes and returns @f$ ab + c @f$. On some architectures might be faster than
doing the computation manually.
*/
#ifdef DOXYGEN_GENERATING_OUTPUT
template<class T> inline T fma(const T& a, const T& b, const T& c);

4
src/Magnum/Math/Vector.h

@ -371,7 +371,7 @@ template<std::size_t size, class T> class Vector {
* @brief Multiply vector with number
*
* @see @ref operator*(const Vector<size, T>&) const,
* @ref operator*=(T), operator*(T, const Vector<size, T>&),
* @ref operator*=(T), @ref operator*(T, const Vector<size, T>&),
* @ref operator*(const Vector<size, Integral>&, FloatingPoint)
*/
Vector<size, T> operator*(T number) const {
@ -398,7 +398,7 @@ template<std::size_t size, class T> class Vector {
* @brief Divide vector with number
*
* @see @ref operator/(const Vector<size, T>&) const,
* @ref operator/=(T), operator/(T, const Vector<size, T>&),
* @ref operator/=(T), @ref operator/(T, const Vector<size, T>&),
* @ref operator/(const Vector<size, Integral>&, FloatingPoint)
*/
Vector<size, T> operator/(T number) const {

Loading…
Cancel
Save