Eigne Matrix Class Library
Dependents: Eigen_test Odometry_test AttitudeEstimation_usingTicker MPU9250_Quaternion_Binary_Serial ... more
DiagonalWrapper< _DiagonalVectorType > Class Template Reference
[Core module]
Expression of a diagonal matrix. More...
#include <DiagonalMatrix.h>
Inherits Eigen::DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >, and Eigen::internal::no_assignment_operator.
Public Member Functions | |
DiagonalWrapper (DiagonalVectorType &a_diagonal) | |
Constructor from expression of diagonal coefficients to wrap. | |
const DiagonalVectorType & | diagonal () const |
template<typename MatrixDerived > | |
const DiagonalProduct < MatrixDerived, Derived, OnTheLeft > | operator* (const MatrixBase< MatrixDerived > &matrix) const |
Index | size () const |
Detailed Description
template<typename _DiagonalVectorType>
class Eigen::DiagonalWrapper< _DiagonalVectorType >
Expression of a diagonal matrix.
- Parameters:
-
_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() and most of the time this is the only way that it is used.
- See also:
- class DiagonalMatrix, class DiagonalBase, MatrixBase::asDiagonal()
Definition at line 248 of file DiagonalMatrix.h.
Constructor & Destructor Documentation
DiagonalWrapper | ( | DiagonalVectorType & | a_diagonal ) |
Constructor from expression of diagonal coefficients to wrap.
Definition at line 258 of file DiagonalMatrix.h.
Member Function Documentation
const DiagonalVectorType& diagonal | ( | ) | const |
- Returns:
- a const reference to the wrapped expression of diagonal coefficients.
Definition at line 261 of file DiagonalMatrix.h.
const DiagonalProduct<MatrixDerived, Derived, OnTheLeft> operator* | ( | const MatrixBase< MatrixDerived > & | matrix ) | const [inherited] |
- Returns:
- the diagonal matrix product of
*this
by the matrix matrix.
Definition at line 63 of file DiagonalMatrix.h.
Index size | ( | ) | const [inherited] |
- Returns:
- the number of coefficients, which is rows()*cols().
Reimplemented in PermutationBase< Derived >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, and PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
Definition at line 49 of file EigenBase.h.
Generated on Tue Jul 12 2022 17:47:04 by 1.7.2