aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Cholesky/CholeskyWithoutSquareRoot.h
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2008-10-17 11:20:46 +0000
committerGravatar Gael Guennebaud <g.gael@free.fr>2008-10-17 11:20:46 +0000
commit727dfa1c439d02c712537bd19d891b1f0b23aa88 (patch)
treeb67bb6e6890bb3e4b8379d18b7906626d07f8260 /Eigen/src/Cholesky/CholeskyWithoutSquareRoot.h
parente747b338eec21cf1de664d257f0420485fd8e330 (diff)
fix some documentation issues
Diffstat (limited to 'Eigen/src/Cholesky/CholeskyWithoutSquareRoot.h')
-rw-r--r--Eigen/src/Cholesky/CholeskyWithoutSquareRoot.h30
1 files changed, 4 insertions, 26 deletions
diff --git a/Eigen/src/Cholesky/CholeskyWithoutSquareRoot.h b/Eigen/src/Cholesky/CholeskyWithoutSquareRoot.h
index af44634a0..bf9951709 100644
--- a/Eigen/src/Cholesky/CholeskyWithoutSquareRoot.h
+++ b/Eigen/src/Cholesky/CholeskyWithoutSquareRoot.h
@@ -77,8 +77,7 @@ template<typename MatrixType> class CholeskyWithoutSquareRoot
bool m_isPositiveDefinite;
};
-/** Compute / recompute the Cholesky decomposition A = L D L^* = U^* D U of \a matrix
- */
+/** \deprecated */
template<typename MatrixType>
void CholeskyWithoutSquareRoot<MatrixType>::compute(const MatrixType& a)
{
@@ -145,20 +144,7 @@ typename Derived::Eval CholeskyWithoutSquareRoot<MatrixType>::solve(const Matrix
);
}
-/** Computes the solution x of \f$ A x = b \f$ using the current decomposition of A.
- * The result is stored in \a bAndx
- *
- * \returns true in case of success, false otherwise.
- *
- * In other words, it computes \f$ b = A^{-1} b \f$ with
- * \f$ {L^{*}}^{-1} D^{-1} L^{-1} b \f$ from right to left.
- * \param bAndX stores both the matrix \f$ b \f$ and the result \f$ x \f$
- *
- * Example: \include CholeskyCholeskyWithoutSquareRoot_solve.cpp
- * Output: \verbinclude CholeskyCholeskyWithoutSquareRoot_solve.out
- *
- * \sa CholeskyWithoutSquareRoot::solveInPlace(), MatrixBase::choleskyNoSqrt()
- */
+/** \deprecated */
template<typename MatrixType>
template<typename RhsDerived, typename ResDerived>
bool CholeskyWithoutSquareRoot<MatrixType>
@@ -170,15 +156,7 @@ bool CholeskyWithoutSquareRoot<MatrixType>
return solveInPlace(*result);
}
-/** This is the \em in-place version of solve().
- *
- * \param bAndX represents both the right-hand side matrix b and result x.
- *
- * This version avoids a copy when the right hand side matrix b is not
- * needed anymore.
- *
- * \sa CholeskyWithoutSquareRoot::solve(), MatrixBase::choleskyNoSqrt()
- */
+/** \deprecated */
template<typename MatrixType>
template<typename Derived>
bool CholeskyWithoutSquareRoot<MatrixType>::solveInPlace(MatrixBase<Derived> &bAndX) const
@@ -193,7 +171,7 @@ bool CholeskyWithoutSquareRoot<MatrixType>::solveInPlace(MatrixBase<Derived> &bA
return true;
}
-/** \deprecated \cholesky_module
+/** \cholesky_module
* \deprecated has been renamed ldlt()
*/
template<typename Derived>