Docs: Correct documented claims that the code contradicts (410fa16a) · Commits · libeigen / eigen

Eigen/OrderingMethods

+1 −1

Original line number	Diff line number	Diff line
		@@ -55,7 +55,7 @@
		*
		* \note Some of these methods (like AMD or METIS), need the sparsity pattern
		* of the input matrix to be symmetric. When the matrix is structurally unsymmetric,
		* Eigen computes internally the pattern of \f$A^T*A\f$ before calling the method.
		* Eigen computes internally the pattern of \f$A^T+A\f$ before calling the method.
		* If your matrix is already symmetric (at least in structure), you can avoid that
		* by calling the method with a SelfAdjointView type.
		*

Eigen/ThreadPool

+2 −3

Original line number	Diff line number	Diff line
		@@ -17,9 +17,8 @@

		/** \defgroup ThreadPool_Module ThreadPool Module
		*
		* This module provides 2 threadpool implementations
		* - a simple reference implementation
		* - a faster non blocking implementation
		* This module provides a non blocking threadpool implementation, Eigen::ThreadPoolTempl, together with the
		* Eigen::ThreadPool alias for its default thread environment.
		*
		* \code
		* #include <Eigen/ThreadPool>

Eigen/src/Cholesky/LLT.h

+4 −3

Original line number	Diff line number	Diff line
		@@ -63,7 +63,8 @@ struct LLT_Traits;
		* This class supports the \link InplaceDecomposition inplace decomposition \endlink mechanism.
		*
		* Note that during the decomposition, only the lower (or upper, as defined by UpLo_) triangular part of A is
		* considered. Therefore, the strict lower part does not have to store correct values.
		* considered. Therefore, the strict upper part (or the strict lower part when UpLo_ is Upper) does not have to
		* store correct values.
		*
		* \sa MatrixBase::llt(), SelfAdjointView::llt(), class LDLT
		*/
		@@ -205,8 +206,8 @@ class LLT : public SolverBase<LLT<MatrixType_, UpLo_> > {
		EIGEN_STATIC_ASSERT_NON_INTEGER(Scalar)

		/** \internal
		* Used to compute and store L
		* The strict upper part is not used and even not initialized.
		* Used to compute and store L, or U when UpLo_ is Upper.
		* The strict part of the other triangle is not used and even not initialized.
		*/
		MatrixType m_matrix;
		RealScalar m_l1_norm;

Eigen/src/CholmodSupport/CholmodSupport.h

+4 −4

Original line number	Diff line number	Diff line
		@@ -483,7 +483,7 @@ class CholmodBase : public SparseSolverBase<Derived> {
		* \implsparsesolverconcept
		*
		* This class supports all kind of SparseMatrix<>: row or column major; upper, lower, or both; compressed or non
		* compressed.
		* compressed, except row-major matrices with complex scalars.
		*
		* \warning Only double precision real and complex scalar types are supported by Cholmod.
		*
		@@ -540,7 +540,7 @@ class CholmodSimplicialLLT : public CholmodBase<MatrixType_, UpLo_, CholmodSimpl
		* \implsparsesolverconcept
		*
		* This class supports all kind of SparseMatrix<>: row or column major; upper, lower, or both; compressed or non
		* compressed.
		* compressed, except row-major matrices with complex scalars.
		*
		* \warning Only double precision real and complex scalar types are supported by Cholmod.
		*
		@@ -611,7 +611,7 @@ class CholmodSimplicialLDLT : public CholmodBase<MatrixType_, UpLo_, CholmodSimp
		* \implsparsesolverconcept
		*
		* This class supports all kind of SparseMatrix<>: row or column major; upper, lower, or both; compressed or non
		* compressed.
		* compressed, except row-major matrices with complex scalars.
		*
		* \warning Only double precision real and complex scalar types are supported by Cholmod.
		*
		@@ -674,7 +674,7 @@ class CholmodSupernodalLLT : public CholmodBase<MatrixType_, UpLo_, CholmodSuper
		* \implsparsesolverconcept
		*
		* This class supports all kind of SparseMatrix<>: row or column major; upper, lower, or both; compressed or non
		* compressed.
		* compressed, except row-major matrices with complex scalars.
		*
		* \warning Only double precision real and complex scalar types are supported by Cholmod.
		*

Eigen/src/Core/Array.h

+1 −2

Original line number	Diff line number	Diff line
		@@ -102,8 +102,7 @@ class Array : public PlainObjectBase<Array<Scalar_, Rows_, Cols_, Options_, MaxR
		* For fixed-size matrices, does nothing.
		*
		* For dynamic-size matrices, creates an empty matrix of size 0. Does not allocate any array. Such a matrix
		* is called a null matrix. This constructor is the unique way to create null matrices: resizing
		* a matrix to 0 is not supported.
		* is called a null matrix. An existing matrix can also be turned into a null matrix by resizing it to 0.
		*
		* \sa resize(Index,Index)
		*/