DiagonalMatrix Class Template Reference

Inherits ei_no_assignment_operator, and MatrixBase< Eigen::DiagonalMatrix< CoeffsVectorType > >.

List of all members.


Detailed Description

template<typename CoeffsVectorType>
class Eigen::DiagonalMatrix< CoeffsVectorType >

Expression of a diagonal matrix.

Warning:
This is not considered to be part of the stable public API yet. Changes may happen in future releases. See Experimental parts of Eigen
Parameters:
CoeffsVectorType the type of the vector of diagonal coefficients
This class is an expression of a diagonal matrix with given vector of diagonal coefficients. It is the return type of MatrixBase::diagonal(const OtherDerived&) and most of the time this is the only way it is used.

See also:
MatrixBase::diagonal(const OtherDerived&)

Public Member Functions

const Scalar coeff (int row, int col) const
int cols () const
const CoeffsVectorType & diagonal () const
 DiagonalMatrix (const CoeffsVectorType &coeffs)
template<typename OtherCoeffsVectorType>
 DiagonalMatrix (const DiagonalMatrix< OtherCoeffsVectorType > &other)
int rows () const

Protected Attributes

const CoeffsVectorType::Nested m_coeffs

Member Function Documentation

const Scalar coeff ( int  row,
int  col 
) const [inline]

Short version: don't use this function, use operator()(int,int) const instead.

Long version: this function is similar to operator()(int,int) const , but without the assertion. Use this for limiting the performance cost of debugging code when doing repeated coefficient access. Only use this when it is guaranteed that the parameters row and col are in range.

If EIGEN_INTERNAL_DEBUGGING is defined, an assertion will be made, making this function equivalent to operator()(int,int) const .

See also:
operator()(int,int) const, coeffRef(int,int), coeff(int) const

Reimplemented from MatrixBase.

int cols ( void   )  const [inline]

Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented from MatrixBase.

const CoeffsVectorType& diagonal (  )  const [inline]

This is the const version of diagonal().

Reimplemented from MatrixBase.

int rows ( void   )  const [inline]

Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented from MatrixBase.


The documentation for this class was generated from the following file:

Generated on Thu Apr 9 10:10:01 2009 for Eigen by  doxygen 1.5.5