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

Add documentation and exemples for inplace decomposition.

Browse Source
This commit is contained in:
Gael Guennebaud
2016-07-04 17:18:26 +02:00
parent 32a41ee659
commit 7f7839c12f
11 changed files with 201 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Eigen/src/LU/FullPivLU.h
View File

@@ -52,6 +52,8 @@ template<typename _MatrixType> struct traits<FullPivLU<_MatrixType> >
* \include class_FullPivLU.cpp
* Output: \verbinclude class_FullPivLU.out
*
* This class supports the \link InplaceDecomposition inplace decomposition \endlink mechanism.
*
* \sa MatrixBase::fullPivLu(), MatrixBase::determinant(), MatrixBase::inverse()
*/
template<typename _MatrixType> class FullPivLU
@@ -99,7 +101,7 @@ template<typename _MatrixType> class FullPivLU
/** \brief Constructs a LU factorization from a given matrix
*
* This overloaded constructor is provided for inplace solving when \c MatrixType is a Eigen::Ref.
* This overloaded constructor is provided for \link InplaceDecomposition inplace decomposition \endlink when \c MatrixType is a Eigen::Ref.
*
* \sa FullPivLU(const EigenBase&)
*/

11
Eigen/src/LU/PartialPivLU.h
View File

@@ -68,6 +68,8 @@ struct enable_if_ref<Ref<T>,Derived> {
*
* The data of the LU decomposition can be directly accessed through the methods matrixLU(), permutationP().
*
* This class supports the \link InplaceDecomposition inplace decomposition \endlink mechanism.
*
* \sa MatrixBase::partialPivLu(), MatrixBase::determinant(), MatrixBase::inverse(), MatrixBase::computeInverse(), class FullPivLU
*/
template<typename _MatrixType> class PartialPivLU
@@ -113,17 +115,10 @@ template<typename _MatrixType> class PartialPivLU
template<typename InputType>
explicit PartialPivLU(const EigenBase<InputType>& matrix);
/** Constructor for inplace decomposition
/** Constructor for \link InplaceDecomposition inplace decomposition \endlink
*
* \param matrix the matrix of which to compute the LU decomposition.
*
* If \c MatrixType is an Eigen::Ref, then the storage of \a matrix will be shared
* between \a matrix and \c *this and the decomposition will take place in-place.
* The memory of \a matrix will be used througrough the lifetime of \c *this. In
* particular, further calls to \c this->compute(A) will still operate on the memory
* of \a matrix meaning. This also implies that the sizes of \c A must match the
* ones of \a matrix.
*
* \warning The matrix should have full rank (e.g. if it's square, it should be invertible).
* If you need to deal with non-full rank, use class FullPivLU instead.
*/