Represents a diagonal matrix with its storage. More...
#include <DiagonalMatrix.h>
Public Types | |
| typedef internal::traits < DiagonalMatrix > ::DiagonalVectorType | DiagonalVectorType |
| typedef internal::traits < DiagonalMatrix >::Index | Index |
| typedef const DiagonalMatrix & | Nested |
| typedef _Scalar | Scalar |
| typedef internal::traits < DiagonalMatrix > ::StorageKind | StorageKind |
Public Member Functions | |
| const DiagonalVectorType & | diagonal () const |
| DiagonalVectorType & | diagonal () |
| DiagonalMatrix () | |
| DiagonalMatrix (Index dim) | |
| DiagonalMatrix (const Scalar &x, const Scalar &y) | |
| DiagonalMatrix (const Scalar &x, const Scalar &y, const Scalar &z) | |
| template<typename OtherDerived > | |
| DiagonalMatrix (const DiagonalBase< OtherDerived > &other) | |
| DiagonalMatrix (const DiagonalMatrix &other) | |
| template<typename OtherDerived > | |
| DiagonalMatrix (const MatrixBase< OtherDerived > &other) | |
| template<typename OtherDerived > | |
| DiagonalMatrix & | operator= (const DiagonalBase< OtherDerived > &other) |
| DiagonalMatrix & | operator= (const DiagonalMatrix &other) |
| void | resize (Index size) |
| void | setIdentity () |
| void | setIdentity (Index size) |
| void | setZero () |
| void | setZero (Index size) |
Protected Attributes | |
| DiagonalVectorType | m_diagonal |
Detailed Description
template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
class 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
Definition at line 131 of file DiagonalMatrix.h.
Member Typedef Documentation
| typedef internal::traits<DiagonalMatrix>::DiagonalVectorType DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalVectorType |
Reimplemented from DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.
Definition at line 136 of file DiagonalMatrix.h.
| typedef internal::traits<DiagonalMatrix>::Index DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::Index |
Reimplemented from DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.
Definition at line 140 of file DiagonalMatrix.h.
| typedef const DiagonalMatrix& DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::Nested |
Definition at line 137 of file DiagonalMatrix.h.
| typedef _Scalar DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::Scalar |
Reimplemented from DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.
Definition at line 138 of file DiagonalMatrix.h.
| typedef internal::traits<DiagonalMatrix>::StorageKind DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::StorageKind |
Reimplemented from DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.
Definition at line 139 of file DiagonalMatrix.h.
Constructor & Destructor Documentation
| DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix | ( | ) | [inline] |
Default constructor without initialization
Definition at line 155 of file DiagonalMatrix.h.
| DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix | ( | Index | dim | ) | [inline] |
Constructs a diagonal matrix with given dimension
Definition at line 158 of file DiagonalMatrix.h.
| DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix | ( | const Scalar & | x, |
| const Scalar & | y | ||
| ) | [inline] |
2D constructor.
Definition at line 161 of file DiagonalMatrix.h.
| DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix | ( | const Scalar & | x, |
| const Scalar & | y, | ||
| const Scalar & | z | ||
| ) | [inline] |
3D constructor.
Definition at line 164 of file DiagonalMatrix.h.
| DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix | ( | const DiagonalBase< OtherDerived > & | other | ) | [inline] |
Copy constructor.
Definition at line 168 of file DiagonalMatrix.h.
| DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix | ( | const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & | other | ) | [inline] |
copy constructor. prevent a default copy constructor from hiding the other templated constructor
Definition at line 172 of file DiagonalMatrix.h.
| DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix | ( | const MatrixBase< OtherDerived > & | other | ) | [inline, explicit] |
generic constructor from expression of the diagonal coefficients
Definition at line 177 of file DiagonalMatrix.h.
Member Function Documentation
| const DiagonalVectorType& DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal | ( | ) | const [inline] |
const version of diagonal().
Reimplemented from DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.
Definition at line 150 of file DiagonalMatrix.h.
| DiagonalVectorType& DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal | ( | ) | [inline] |
- Returns:
- a reference to the stored vector of diagonal coefficients.
Reimplemented from DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.
Definition at line 152 of file DiagonalMatrix.h.
| DiagonalMatrix& DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator= | ( | const DiagonalBase< OtherDerived > & | other | ) | [inline] |
Copy operator.
Definition at line 182 of file DiagonalMatrix.h.
| DiagonalMatrix& DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator= | ( | const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & | other | ) | [inline] |
This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.
Definition at line 192 of file DiagonalMatrix.h.
| void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::resize | ( | Index | size | ) | [inline] |
Resizes to given size.
Definition at line 200 of file DiagonalMatrix.h.
| void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity | ( | ) | [inline] |
Sets this matrix to be the identity matrix of the current size.
Definition at line 206 of file DiagonalMatrix.h.
| void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity | ( | Index | size | ) | [inline] |
Sets this matrix to be the identity matrix of the given size.
Definition at line 208 of file DiagonalMatrix.h.
| void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero | ( | ) | [inline] |
Sets all coefficients to zero.
Definition at line 202 of file DiagonalMatrix.h.
| void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero | ( | Index | size | ) | [inline] |
Resizes and sets all coefficients to zero.
Definition at line 204 of file DiagonalMatrix.h.
Member Data Documentation
DiagonalVectorType DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal [protected] |
Definition at line 145 of file DiagonalMatrix.h.
The documentation for this class was generated from the following file: