aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2010-10-05 15:56:50 +0200
committerGravatar Gael Guennebaud <g.gael@free.fr>2010-10-05 15:56:50 +0200
commit01fad14d788add27f2caf93464b960c4149db662 (patch)
treea7533a8c61da476451c840b6a3d138da68933bc1 /Eigen/src
parent2334291157fe192b7b9f651967126de3bf8d8cbe (diff)
mark LLT/LDLT solveInPlace func internal and rm their boolean returned value
Diffstat (limited to 'Eigen/src')
-rw-r--r--Eigen/src/Cholesky/LDLT.h4
-rw-r--r--Eigen/src/Cholesky/LLT.h19
2 files changed, 13 insertions, 10 deletions
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<LDLT<_MatrixType,_UpLo>, 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<typename _MatrixType, int _UpLo> class LLT
typedef LLT_Traits<MatrixType,UpLo> 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<typename _MatrixType, int _UpLo> class LLT
}
template<typename Derived>
- bool solveInPlace(MatrixBase<Derived> &bAndX) const;
+ void solveInPlace(MatrixBase<Derived> &bAndX) const;
LLT& compute(const MatrixType& matrix);
@@ -309,7 +309,9 @@ struct ei_solve_retval<LLT<_MatrixType, UpLo>, 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<LLT<_MatrixType, UpLo>, Rhs>
*/
template<typename MatrixType, int _UpLo>
template<typename Derived>
-bool LLT<MatrixType,_UpLo>::solveInPlace(MatrixBase<Derived> &bAndX) const
+void LLT<MatrixType,_UpLo>::solveInPlace(MatrixBase<Derived> &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,