GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-06-04 18:54:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

minor documentation fixes

Browse Source
This commit is contained in:
Gael Guennebaud 2015-06-05 14:40:07 +02:00
parent 56d4ef7ad6
commit d0b7b5cb55
3 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Eigen/src/Cholesky/LDLT.h
View File

@ -314,9 +314,9 @@ template<> struct ldlt_inplace<Lower>
} }
// In some previous versions of Eigen (e.g., 3.2.1), the scaling was omitted if the pivot // In some previous versions of Eigen (e.g., 3.2.1), the scaling was omitted if the pivot
// was smaller than the cutoff value. However, soince LDLT is not rank-revealing // was smaller than the cutoff value. However, since LDLT is not rank-revealing
// we should only make sure we do not introduce INF or NaN values. // we should only make sure that we do not introduce INF or NaN values.
// LAPACK also uses 0 as the cutoff value. // Remark that LAPACK also uses 0 as the cutoff value.
RealScalar realAkk = numext::real(mat.coeffRef(k,k)); RealScalar realAkk = numext::real(mat.coeffRef(k,k));
if((rs>0) && (abs(realAkk) > RealScalar(0))) if((rs>0) && (abs(realAkk) > RealScalar(0)))
A21 /= realAkk; A21 /= realAkk;

1
Eigen/src/Core/PlainObjectBase.h
View File

@ -71,6 +71,7 @@ namespace internal {
// this is a workaround to doxygen not being able to understand the inheritance logic // this is a workaround to doxygen not being able to understand the inheritance logic
// when it is hidden by the dense_xpr_base helper struct. // when it is hidden by the dense_xpr_base helper struct.
/** This class is just a workaround for Doxygen and it does not not actually exist. */
template<typename Derived> struct dense_xpr_base_dispatcher_for_doxygen;// : public MatrixBase<Derived> {}; template<typename Derived> struct dense_xpr_base_dispatcher_for_doxygen;// : public MatrixBase<Derived> {};
/** This class is just a workaround for Doxygen and it does not not actually exist. */ /** This class is just a workaround for Doxygen and it does not not actually exist. */
template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols> template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>

17
Eigen/src/Core/TriangularMatrix.h
View File

@ -19,9 +19,7 @@ template<int Side, typename TriangularType, typename Rhs> struct triangular_solv
} }
/** \internal /** \class TriangularBase
*
* \class TriangularBase
* \ingroup Core_Module * \ingroup Core_Module
* *
* \brief Base class for triangular part in a matrix * \brief Base class for triangular part in a matrix
@ -148,7 +146,7 @@ template<typename Derived> class TriangularBase : public EigenBase<Derived>
/** \class TriangularView /** \class TriangularView
* \ingroup Core_Module * \ingroup Core_Module
* *
* \brief Base class for triangular part in a matrix * \brief Expression of a triangular part in a matrix
* *
* \param MatrixType the type of the object in which we are taking the triangular part * \param MatrixType the type of the object in which we are taking the triangular part
* \param Mode the kind of triangular matrix expression to construct. Can be #Upper, * \param Mode the kind of triangular matrix expression to construct. Can be #Upper,
@ -158,7 +156,7 @@ template<typename Derived> class TriangularBase : public EigenBase<Derived>
* *
* This class represents a triangular part of a matrix, not necessarily square. Strictly speaking, for rectangular * This class represents a triangular part of a matrix, not necessarily square. Strictly speaking, for rectangular
* matrices one should speak of "trapezoid" parts. This class is the return type * matrices one should speak of "trapezoid" parts. This class is the return type
* of MatrixBase::triangularView() and most of the time this is the only way it is used. * of MatrixBase::triangularView() and SparseMatrixBase::triangularView(), and most of the time this is the only way it is used.
* *
* \sa MatrixBase::triangularView() * \sa MatrixBase::triangularView()
*/ */
@ -306,6 +304,15 @@ template<typename _MatrixType, unsigned int _Mode> class TriangularView
MatrixTypeNested m_matrix; MatrixTypeNested m_matrix;
}; };
/** \ingroup Core_Module
*
* \brief Base class for a triangular part in a \b dense matrix
*
* This class is an abstract base class of class TriangularView, and objects of type TriangularViewImpl cannot be instantiated.
* It extends class TriangularView with additional methods which available for dense expressions only.
*
* \sa class TriangularView, MatrixBase::triangularView()
*/
template<typename _MatrixType, unsigned int _Mode> class TriangularViewImpl<_MatrixType,_Mode,Dense> template<typename _MatrixType, unsigned int _Mode> class TriangularViewImpl<_MatrixType,_Mode,Dense>
: public TriangularBase<TriangularView<_MatrixType, _Mode> > : public TriangularBase<TriangularView<_MatrixType, _Mode> >
{ {