devtools/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2026-04-10 11:34:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Dox in MatrixFunctions

Browse Source
This commit is contained in:
jdh8
2012-08-19 18:12:04 +08:00
parent 15dabd4db7
commit 573d88f81c
4 changed files with 85 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
unsupported/Eigen/src/MatrixFunctions/MatrixLogarithm.h
View File

@@ -217,7 +217,7 @@ int MatrixLogarithmAtomic<MatrixType>::getPadeDegree(long double normTminusI)
3.6688019729653446926585242192447447e-2L, 5.9290962294020186998954055264528393e-2L,
8.6998436081634343903250580992127677e-2L, 1.1880960220216759245467951592883642e-1L };
#endif
int degree = 3
int degree = 3;
for (; degree <= maxPadeDegree; ++degree)
if (normTminusI <= maxNormForPade[degree - minPadeDegree])
break;

22
unsupported/Eigen/src/MatrixFunctions/MatrixPower.h
View File

@@ -71,8 +71,8 @@ class MatrixPower
/**
* \brief Compute the matrix power.
*
* If \c b is \em fatter than \c A, it computes \f$ A^{p_{\textrm int}}
* \f$ first, and then multiplies it with \c b. Otherwise,
* If \p b is \em fatter than \p A, it computes \f$ A^{p_{\textrm int}}
* \f$ first, and then multiplies it with \p b. Otherwise,
* #computeChainProduct optimizes the expression.
*
* \sa computeChainProduct(ResultType&);
@@ -124,13 +124,13 @@ class MatrixPower
*/
void computeBig();
/** \brief Get suitable degree for Pade approximation. (specialized for \c RealScalar = \c double) */
/** \brief Get suitable degree for Pade approximation. (specialized for RealScalar = double) */
inline int getPadeDegree(double);
/** \brief Get suitable degree for Pade approximation. (specialized for \c RealScalar = \c float) */
/** \brief Get suitable degree for Pade approximation. (specialized for RealScalar = float) */
inline int getPadeDegree(float);
/** \brief Get suitable degree for Pade approximation. (specialized for \c RealScalar = \c long double) */
/** \brief Get suitable degree for Pade approximation. (specialized for RealScalar = long double) */
inline int getPadeDegree(long double);
/** \brief Compute Pad&eacute; approximation to matrix fractional power. */
@@ -196,8 +196,8 @@ class MatrixPower<MatrixType, IntExponent, PlainObject, 1>
/**
* \brief Compute the matrix power.
*
* If \c b is \em fatter than \c A, it computes \f$ A^p \f$ first, and
* then multiplies it with \c b. Otherwise, #computeChainProduct
* If \p b is \em fatter than \p A, it computes \f$ A^p \f$ first, and
* then multiplies it with \p b. Otherwise, #computeChainProduct
* optimizes the expression.
*
* \param[out] result \f$ A^p b \f$, as specified in the constructor.
@@ -646,7 +646,7 @@ template<typename MatrixType, typename ExponentType, typename Derived> class Mat
/**
* \brief Compute the matrix exponential.
*
* \param[out] result \f$ A^p b \f$ where \c A ,\c p and \c b are as in
* \param[out] result \f$ A^p b \f$ where \p A ,\p p and \p b are as in
* the constructor.
*/
template <typename ResultType>
@@ -700,12 +700,12 @@ template<typename Derived, typename ExponentType> class MatrixPowerReturnValue
: m_A(A), m_p(p) { }
/**
* \brief Return the matrix power multiplied by %Matrix \c b.
* \brief Return the matrix power multiplied by %Matrix \p b.
*
* The %MatrixPower class can optimize \f$ A^p b \f$ computing, and this
* method provides an elegant way to call it:
*
* \param[in] b %Matrix (exporession), the multiplier.
* \param[in] b %Matrix (expression), the multiplier.
*/
template <typename OtherDerived>
const MatrixPowerMultiplied<Derived, ExponentType, OtherDerived> operator*(const MatrixBase<OtherDerived>& b) const
@@ -714,7 +714,7 @@ template<typename Derived, typename ExponentType> class MatrixPowerReturnValue
/**
* \brief Compute the matrix power.
*
* \param[out] result \f$ A^p \f$ where \c A and \c p are as in the
* \param[out] result \f$ A^p \f$ where \p A and \p p are as in the
* constructor.
*/
template <typename ResultType>