Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Protected Attributes
Eigen::DiagonalMatrix Class Reference

Detailed Description

Represents a diagonal matrix with its storage.

Parameters:
_Scalarthe type of coefficients
SizeAtCompileTimethe dimension of the matrix, or Dynamic
MaxSizeAtCompileTimethe 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

List of all members.

Public Member Functions

const DiagonalVectorType & diagonal () const
 const version of diagonal().
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.
 DiagonalMatrix (const Scalar &x, const Scalar &y, const Scalar &z)
 3D constructor.
template<typename OtherDerived >
 DiagonalMatrix (const DiagonalBase< OtherDerived > &other)
 Copy constructor.
template<typename OtherDerived >
 DiagonalMatrix (const MatrixBase< OtherDerived > &other)
 generic constructor from expression of the diagonal coefficients
template<typename OtherDerived >
DiagonalMatrixoperator= (const DiagonalBase< OtherDerived > &other)
 Copy operator.
void resize (Index size)
 Resizes to given size.
void setZero ()
 Sets all coefficients to zero.
void setZero (Index size)
 Resizes and sets all coefficients to zero.
void setIdentity ()
 Sets this matrix to be the identity matrix of the current size.
void setIdentity (Index size)
 Sets this matrix to be the identity matrix of the given size.

Protected Attributes

DiagonalVectorType m_diagonal

Constructor & Destructor Documentation

Eigen::DiagonalMatrix::DiagonalMatrix ( ) [inline]

Default constructor without initialization.

Definition at line 156 of file Core.

Eigen::DiagonalMatrix::DiagonalMatrix ( Index  dim) [inline]

Constructs a diagonal matrix with given dimension.

Definition at line 159 of file Core.

Eigen::DiagonalMatrix::DiagonalMatrix ( const Scalar &  x,
const Scalar &  y 
) [inline]

2D constructor.

Definition at line 162 of file Core.

Eigen::DiagonalMatrix::DiagonalMatrix ( const Scalar &  x,
const Scalar &  y,
const Scalar &  z 
) [inline]

3D constructor.

Definition at line 165 of file Core.

template<typename OtherDerived >
Eigen::DiagonalMatrix::DiagonalMatrix ( const DiagonalBase< OtherDerived > &  other) [inline]

Copy constructor.

Definition at line 169 of file Core.

template<typename OtherDerived >
Eigen::DiagonalMatrix::DiagonalMatrix ( const MatrixBase< OtherDerived > &  other) [inline, explicit]

generic constructor from expression of the diagonal coefficients

Definition at line 178 of file Core.


Member Function Documentation

const DiagonalVectorType& Eigen::DiagonalMatrix::diagonal ( ) const [inline]

const version of diagonal().

Definition at line 151 of file Core.

DiagonalVectorType& Eigen::DiagonalMatrix::diagonal ( ) [inline]
Returns:
a reference to the stored vector of diagonal coefficients.

Definition at line 153 of file Core.

template<typename OtherDerived >
DiagonalMatrix& Eigen::DiagonalMatrix::operator= ( const DiagonalBase< OtherDerived > &  other) [inline]

Copy operator.

Definition at line 183 of file Core.

void Eigen::DiagonalMatrix::resize ( Index  size) [inline]

Resizes to given size.

Definition at line 201 of file Core.

void Eigen::DiagonalMatrix::setIdentity ( ) [inline]

Sets this matrix to be the identity matrix of the current size.

Definition at line 207 of file Core.

void Eigen::DiagonalMatrix::setIdentity ( Index  size) [inline]

Sets this matrix to be the identity matrix of the given size.

Definition at line 209 of file Core.

void Eigen::DiagonalMatrix::setZero ( ) [inline]

Sets all coefficients to zero.

Definition at line 203 of file Core.

void Eigen::DiagonalMatrix::setZero ( Index  size) [inline]

Resizes and sets all coefficients to zero.

Definition at line 205 of file Core.


Member Data Documentation

DiagonalVectorType Eigen::DiagonalMatrix::m_diagonal [protected]

Definition at line 146 of file Core.




Page generated by Doxygen 1.7.5 for MRPT 0.9.5 SVN: at Thu Oct 13 21:25:36 UTC 2011