Represents a diagonal matrix with its storage. More...
#include <DiagonalMatrix.h>
Inheritance diagram for Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >:
Public Types | |
| typedef internal::traits< DiagonalMatrix >::DiagonalVectorType | DiagonalVectorType |
| typedef const DiagonalMatrix & | Nested |
| typedef _Scalar | Scalar |
| typedef internal::traits< DiagonalMatrix >::StorageKind | StorageKind |
| typedef internal::traits< DiagonalMatrix >::Index | Index |
 Public Types inherited from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > > | |
| enum | |
| typedef internal::traits< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::DiagonalVectorType | DiagonalVectorType |
| typedef DiagonalVectorType::Scalar | Scalar |
| typedef DiagonalVectorType::RealScalar | RealScalar |
| typedef internal::traits< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::StorageKind | StorageKind |
| typedef internal::traits< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::Index | Index |
| typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime > | DenseMatrixType |
| typedef DenseMatrixType | DenseType |
| typedef DiagonalMatrix< Scalar, DiagonalVectorType::SizeAtCompileTime, DiagonalVectorType::MaxSizeAtCompileTime > | PlainObject |
| Public Types inherited from Eigen::EigenBase< Derived > | |
| typedef internal::traits< Derived >::StorageKind | StorageKind |
| typedef internal::traits< Derived >::Index | Index |
Public Member Functions | |
| const DiagonalVectorType & | diagonal () const |
| const version of diagonal(). More... | |
| DiagonalVectorType & | diagonal () |
| DiagonalMatrix () | |
| Default constructor without initialization. | |
| DiagonalMatrix (Index dim) | |
| Constructs a diagonal matrix with given dimension. | |
| DiagonalMatrix (const Scalar &x, const Scalar &y) | |
| 2D constructor. More... | |
| DiagonalMatrix (const Scalar &x, const Scalar &y, const Scalar &z) | |
| 3D constructor. More... | |
| template<typename OtherDerived > | |
| DiagonalMatrix (const DiagonalBase< OtherDerived > &other) | |
| Copy constructor. More... | |
| DiagonalMatrix (const DiagonalMatrix &other) | |
| copy constructor. More... | |
| template<typename OtherDerived > | |
| DiagonalMatrix (const MatrixBase< OtherDerived > &other) | |
| generic constructor from expression of the diagonal coefficients | |
| template<typename OtherDerived > | |
| DiagonalMatrix & | operator= (const DiagonalBase< OtherDerived > &other) |
| Copy operator. More... | |
| DiagonalMatrix & | operator= (const DiagonalMatrix &other) |
| This is a special case of the templated operator=. More... | |
| void | resize (Index size) |
| Resizes to given size. More... | |
| void | setZero () |
| Sets all coefficients to zero. More... | |
| void | setZero (Index size) |
| Resizes and sets all coefficients to zero. More... | |
| void | setIdentity () |
| Sets this matrix to be the identity matrix of the current size. More... | |
| void | setIdentity (Index size) |
| Sets this matrix to be the identity matrix of the given size. More... | |
| Public Member Functions inherited from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > > | |
| const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & | derived () const |
| DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & | derived () |
| DenseMatrixType | toDenseMatrix () const |
| void | evalTo (MatrixBase< DenseDerived > &other) const |
| void | addTo (MatrixBase< DenseDerived > &other) const |
| void | subTo (MatrixBase< DenseDerived > &other) const |
| const DiagonalVectorType & | diagonal () const |
| DiagonalVectorType & | diagonal () |
| Index | rows () const |
| Index | cols () const |
| const DiagonalProduct< MatrixDerived, DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >, OnTheLeft > | operator* (const MatrixBase< MatrixDerived > &matrix) const |
| const DiagonalWrapper< const CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const DiagonalVectorType > > | operator* (const Scalar &scalar) const |
| const DiagonalWrapper< const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const DiagonalVectorType > > | inverse () const |
| Public Member Functions inherited from Eigen::EigenBase< Derived > | |
| Derived & | derived () |
| const Derived & | derived () const |
| Derived & | const_cast_derived () const |
| const Derived & | const_derived () const |
| Index | rows () const |
| Index | cols () const |
| Index | size () const |
| template<typename Dest > | |
| void | evalTo (Dest &dst) const |
| template<typename Dest > | |
| void | addTo (Dest &dst) const |
| template<typename Dest > | |
| void | subTo (Dest &dst) const |
| template<typename Dest > | |
| void | applyThisOnTheRight (Dest &dst) const |
| template<typename Dest > | |
| void | applyThisOnTheLeft (Dest &dst) const |
Protected Attributes | |
| DiagonalVectorType | m_diagonal |
Detailed Description
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
class Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >
Represents a diagonal matrix with its storage.
- Parameters
-
_Scalar the type of coefficients SizeAtCompileTime the dimension of the matrix, or Dynamic 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.
- See also
- class DiagonalWrapper
Constructor & Destructor Documentation
§ DiagonalMatrix() [1/4]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
2D constructor.
§ DiagonalMatrix() [2/4]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
3D constructor.
§ DiagonalMatrix() [3/4]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
template<typename OtherDerived >
|
inline |
Copy constructor.
§ DiagonalMatrix() [4/4]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
copy constructor.
prevent a default copy constructor from hiding the other templated constructor
Member Function Documentation
§ diagonal() [1/2]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
const version of diagonal().
§ diagonal() [2/2]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
- Returns
- a reference to the stored vector of diagonal coefficients.
§ operator=() [1/2]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
template<typename OtherDerived >
|
inline |
Copy operator.
§ operator=() [2/2]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
This is a special case of the templated operator=.
Its purpose is to prevent a default operator= from hiding the templated operator=.
§ resize()
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
Resizes to given size.
§ setIdentity() [1/2]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
Sets this matrix to be the identity matrix of the current size.
§ setIdentity() [2/2]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
Sets this matrix to be the identity matrix of the given size.
§ setZero() [1/2]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
Sets all coefficients to zero.
§ setZero() [2/2]
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
|
inline |
Resizes and sets all coefficients to zero.
The documentation for this class was generated from the following file:
- vendor/eigen/Eigen/src/Core/DiagonalMatrix.h
