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

Small fixes

Browse Source 
This MR fixes a bunch of smaller issues, making the following changes:

* Template parameters in the documentation are documented with `\tparam` instead
  of `\param`
* Superfluous semicolon warnings fixed
* Fixed the type of literals used to initialize float variables
This commit is contained in:
Erik Schultheis
2021-12-21 16:46:09 +00:00
committed by David Tellenbach
parent 2a6594de29
commit f7a056bf04
14 changed files with 28 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -246,7 +246,7 @@ template<typename MatrixType_, int UpLo_> class LDLT
* This method is provided for compatibility with other matrix decompositions, thus enabling generic code such as:
* \code x = decomposition.adjoint().solve(b) \endcode
*/
const LDLT& adjoint() const { return *this; };
const LDLT& adjoint() const { return *this; }
EIGEN_DEVICE_FUNC inline EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT { return m_matrix.rows(); }
EIGEN_DEVICE_FUNC inline EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT { return m_matrix.cols(); }

2
Eigen/src/Cholesky/LLT.h
View File

@@ -201,7 +201,7 @@ template<typename MatrixType_, int UpLo_> class LLT
* This method is provided for compatibility with other matrix decompositions, thus enabling generic code such as:
* \code x = decomposition.adjoint().solve(b) \endcode
*/
const LLT& adjoint() const EIGEN_NOEXCEPT { return *this; };
const LLT& adjoint() const EIGEN_NOEXCEPT { return *this; }
inline EIGEN_CONSTEXPR Index rows() const EIGEN_NOEXCEPT { return m_matrix.rows(); }
inline EIGEN_CONSTEXPR Index cols() const EIGEN_NOEXCEPT { return m_matrix.cols(); }

2
Eigen/src/CholmodSupport/CholmodSupport.h
View File

@@ -438,7 +438,7 @@ class CholmodBase : public SparseSolverBase<Derived>
if (m_cholmodFactor->is_ll)
logDet *= 2.0;
return logDet;
};
}
template<typename Stream>
void dumpMemory(Stream& /*s*/)

4
Eigen/src/Core/Diagonal.h
View File

@@ -20,8 +20,8 @@ namespace Eigen {
*
* \brief Expression of a diagonal/subdiagonal/superdiagonal in a matrix
*
* \param MatrixType the type of the object in which we are taking a sub/main/super diagonal
* \param DiagIndex the index of the sub/super diagonal. The default is 0 and it means the main diagonal.
* \tparam MatrixType the type of the object in which we are taking a sub/main/super diagonal
* \tparam DiagIndex the index of the sub/super diagonal. The default is 0 and it means the main diagonal.
* A positive value means a superdiagonal, a negative value means a subdiagonal.
* You can also use DynamicIndex so the index can be set at runtime.
*

8
Eigen/src/Core/DiagonalMatrix.h
View File

@@ -118,9 +118,9 @@ class DiagonalBase : public EigenBase<Derived>
*
* \brief Represents a diagonal matrix with its storage
*
* \param Scalar_ the type of coefficients
* \param SizeAtCompileTime the dimension of the matrix, or Dynamic
* \param MaxSizeAtCompileTime the dimension of the matrix, or Dynamic. This parameter is optional and defaults
* \tparam Scalar_ the type of coefficients
* \tparam SizeAtCompileTime the dimension of the matrix, or Dynamic
* \tparam MaxSizeAtCompileTime the dimension of the matrix, or Dynamic. This parameter is optional and defaults
* to SizeAtCompileTime. Most of the time, you do not need to specify it.
*
* \sa class DiagonalWrapper
@@ -261,7 +261,7 @@ class DiagonalMatrix
*
* \brief Expression of a diagonal matrix
*
* \param DiagonalVectorType_ the type of the vector of diagonal coefficients
* \tparam DiagonalVectorType_ the type of the vector of diagonal coefficients
*
* This class is an expression of a diagonal matrix, but not storing its own vector of diagonal coefficients,
* instead wrapping an existing vector expression. It is the return type of MatrixBase::asDiagonal()

6
Eigen/src/Core/Select.h
View File

@@ -19,9 +19,9 @@ namespace Eigen {
*
* \brief Expression of a coefficient wise version of the C++ ternary operator ?:
*
* \param ConditionMatrixType the type of the \em condition expression which must be a boolean matrix
* \param ThenMatrixType the type of the \em then expression
* \param ElseMatrixType the type of the \em else expression
* \tparam ConditionMatrixType the type of the \em condition expression which must be a boolean matrix
* \tparam ThenMatrixType the type of the \em then expression
* \tparam ElseMatrixType the type of the \em else expression
*
* This class represents an expression of a coefficient wise version of the C++ ternary operator ?:.
* It is the return type of DenseBase::select() and most of the time this is the only way it is used.

4
Eigen/src/Core/SelfAdjointView.h
View File

@@ -20,8 +20,8 @@ namespace Eigen {
*
* \brief Expression of a selfadjoint matrix from a triangular part of a dense matrix
*
* \param MatrixType the type of the dense matrix storing the coefficients
* \param TriangularPart can be either \c #Lower or \c #Upper
* \tparam MatrixType the type of the dense matrix storing the coefficients
* \tparam TriangularPart can be either \c #Lower or \c #Upper
*
* This class is an expression of a sefladjoint matrix from a triangular part of a matrix
* with given dense storage of the coefficients. It is the return type of MatrixBase::selfadjointView()

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

@@ -155,8 +155,8 @@ template<typename Derived> class TriangularBase : public EigenBase<Derived>
*
* \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 Mode the kind of triangular matrix expression to construct. Can be #Upper,
* \tparam MatrixType the type of the object in which we are taking the triangular part
* \tparam Mode the kind of triangular matrix expression to construct. Can be #Upper,
* #Lower, #UnitUpper, #UnitLower, #StrictlyUpper, or #StrictlyLower.
* This is in fact a bit field; it must have either #Upper or #Lower,
* and additionally it may have #UnitDiag or #ZeroDiag or neither.

2
Eigen/src/Core/util/Serializer.h
View File

@@ -46,7 +46,7 @@ class Serializer<T, typename std::enable_if<
/**
* Serializes a value to a byte buffer.
* \param dest the destination buffer.
* \param T the value to serialize.
* \param value the value to serialize.
* \return the next memory address past the end of the serialized data.
*/
EIGEN_DEVICE_FUNC uint8_t* serialize(uint8_t* dest, const T& value) {

2
Eigen/src/QR/CompleteOrthogonalDecomposition.h
View File

@@ -32,7 +32,7 @@ struct traits<CompleteOrthogonalDecomposition<MatrixType_> >
*
* \brief Complete orthogonal decomposition (COD) of a matrix.
*
* \param MatrixType the type of the matrix of which we are computing the COD.
* \tparam MatrixType_ the type of the matrix of which we are computing the COD.
*
* This class performs a rank-revealing complete orthogonal decomposition of a
* matrix \b A into matrices \b P, \b Q, \b T, and \b Z such that

4
Eigen/src/SparseLU/SparseLU.h
View File

@@ -454,8 +454,8 @@ class SparseLU : public SparseSolverBase<SparseLU<MatrixType_,OrderingType_> >,
return (m_detPermR * m_detPermC) > 0 ? det : -det;
}
Index nnzL() const { return m_nnzL; };
Index nnzU() const { return m_nnzU; };
Index nnzL() const { return m_nnzL; }
Index nnzU() const { return m_nnzU; }
protected:
// Functions