Select Class Template Reference

Inherits ei_no_assignment_operator, and MatrixBase< Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType > >.

List of all members.


Detailed Description

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>
class Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >

Expression of a coefficient wise version of the C++ ternary operator ?:.

This is defined in the Array module.

 #include <Eigen/Array> 

Parameters:
ConditionMatrixType the type of the condition expression which must be a boolean matrix
ThenMatrixType the type of the then expression
ElseMatrixType the type of the else expression
This class represents an expression of a coefficient wise version of the C++ ternary operator ?:. It is the return type of MatrixBase::select() and most of the time this is the only way it is used.

See also:
MatrixBase::select(const MatrixBase<ThenDerived>&, const MatrixBase<ElseDerived>&) const

Public Member Functions

const Scalar coeff (int i) const
const Scalar coeff (int i, int j) const
int cols () const
int rows () const
 Select (const ConditionMatrixType &conditionMatrix, const ThenMatrixType &thenMatrix, const ElseMatrixType &elseMatrix)

Protected Attributes

const ConditionMatrixType::Nested m_condition
const ElseMatrixType::Nested m_else
const ThenMatrixType::Nested m_then

Member Function Documentation

const Scalar coeff ( int  index  )  const [inline]

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

Long version: this function is similar to operator[](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 parameter index is in range.

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

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

Reimplemented from MatrixBase.

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 (  )  const [inline]

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

Reimplemented from MatrixBase.

int rows (  )  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:02 2009 for Eigen by  doxygen 1.5.5