Minor Class Template Reference

Inherits MatrixBase< Eigen::Minor< MatrixType > >.

List of all members.


Detailed Description

template<typename MatrixType>
class Eigen::Minor< MatrixType >

Expression of a minor.

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:
MatrixType the type of the object in which we are taking a minor
This class represents an expression of a minor. It is the return type of MatrixBase::minor() and most of the time this is the only way it is used.

See also:
MatrixBase::minor()

Public Member Functions

const Scalar coeff (int row, int col) const
Scalar & coeffRef (int row, int col)
int cols () const
 Minor (const MatrixType &matrix, int row, int col)
int rows () const

Protected Attributes

const int m_col
const MatrixType::Nested m_matrix
const int m_row

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.

Scalar& coeffRef ( int  row,
int  col 
) [inline]

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

Long version: this function is similar to operator()(int,int), 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).

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

Reimplemented from MatrixBase.

int cols ( void   )  const [inline]

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

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