From 01fad14d788add27f2caf93464b960c4149db662 Mon Sep 17 00:00:00 2001 From: Gael Guennebaud Date: Tue, 5 Oct 2010 15:56:50 +0200 Subject: mark LLT/LDLT solveInPlace func internal and rm their boolean returned value --- Eigen/src/Cholesky/LDLT.h | 4 +++- Eigen/src/Cholesky/LLT.h | 19 ++++++++++--------- 2 files changed, 13 insertions(+), 10 deletions(-) (limited to 'Eigen/src') diff --git a/Eigen/src/Cholesky/LDLT.h b/Eigen/src/Cholesky/LDLT.h index 9b9ff7fde..15a92f8fe 100644 --- a/Eigen/src/Cholesky/LDLT.h +++ b/Eigen/src/Cholesky/LDLT.h @@ -363,7 +363,9 @@ struct ei_solve_retval, Rhs> } }; -/** This is the \em in-place version of solve(). +/** \internal use x = ldlt_object.solve(x); + * + * This is the \em in-place version of solve(). * * \param bAndX represents both the right-hand side matrix b and result x. * diff --git a/Eigen/src/Cholesky/LLT.h b/Eigen/src/Cholesky/LLT.h index f60821790..df135fce3 100644 --- a/Eigen/src/Cholesky/LLT.h +++ b/Eigen/src/Cholesky/LLT.h @@ -76,11 +76,11 @@ template class LLT typedef LLT_Traits Traits; /** - * \brief Default Constructor. - * - * The default constructor is useful in cases in which the user intends to - * perform decompositions via LLT::compute(const MatrixType&). - */ + * \brief Default Constructor. + * + * The default constructor is useful in cases in which the user intends to + * perform decompositions via LLT::compute(const MatrixType&). + */ LLT() : m_matrix(), m_isInitialized(false) {} /** \brief Default Constructor with memory preallocation @@ -134,7 +134,7 @@ template class LLT } template - bool solveInPlace(MatrixBase &bAndX) const; + void solveInPlace(MatrixBase &bAndX) const; LLT& compute(const MatrixType& matrix); @@ -309,7 +309,9 @@ struct ei_solve_retval, Rhs> } }; -/** This is the \em in-place version of solve(). +/** \internal use x = llt_object.solve(x); + * + * This is the \em in-place version of solve(). * * \param bAndX represents both the right-hand side matrix b and result x. * @@ -322,13 +324,12 @@ struct ei_solve_retval, Rhs> */ template template -bool LLT::solveInPlace(MatrixBase &bAndX) const +void LLT::solveInPlace(MatrixBase &bAndX) const { ei_assert(m_isInitialized && "LLT is not initialized."); ei_assert(m_matrix.rows()==bAndX.rows()); matrixL().solveInPlace(bAndX); matrixU().solveInPlace(bAndX); - return true; } /** \returns the matrix represented by the decomposition, -- cgit v1.2.3