Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType > Class Template Reference

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

#include <Select.h>

Inheritance diagram for Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >:

Collaboration diagram for Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >:

List of all members.

Public Types
typedef internal::dense_xpr_base < Select >::type	Base
Public Member Functions
EIGEN_DEVICE_FUNC	Select (const ConditionMatrixType &a_conditionMatrix, const ThenMatrixType &a_thenMatrix, const ElseMatrixType &a_elseMatrix)
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC const Scalar	coeff (Index i, Index j) const
EIGEN_DEVICE_FUNC const Scalar	coeff (Index i) const
EIGEN_DEVICE_FUNC const ConditionMatrixType &	conditionMatrix () const
EIGEN_DEVICE_FUNC const ThenMatrixType &	thenMatrix () const
EIGEN_DEVICE_FUNC const ElseMatrixType &	elseMatrix () const
Protected Attributes
ConditionMatrixType::Nested	m_condition
ThenMatrixType::Nested	m_then
ElseMatrixType::Nested	m_else

---

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 ?:

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 DenseBase::select() and most of the time this is the only way it is used.

See also:

DenseBase::select(const DenseBase<ThenDerived>&, const DenseBase<ElseDerived>&) const

Definition at line 52 of file Select.h.

---

Member Typedef Documentation

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

typedef internal::dense_xpr_base<Select>::type Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::Base

Definition at line 57 of file Select.h.

---

Constructor & Destructor Documentation

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

EIGEN_DEVICE_FUNC Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::Select	(	const ConditionMatrixType &	a_conditionMatrix,
		const ThenMatrixType &	a_thenMatrix,
		const ElseMatrixType &	a_elseMatrix
	)		[inline]

Definition at line 61 of file Select.h.

      : m_condition(a_conditionMatrix), m_then(a_thenMatrix), m_else(a_elseMatrix)
    {
      eigen_assert(m_condition.rows() == m_then.rows() && m_condition.rows() == m_else.rows());
      eigen_assert(m_condition.cols() == m_then.cols() && m_condition.cols() == m_else.cols());
    }

---

Member Function Documentation

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

EIGEN_DEVICE_FUNC const Scalar Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::coeff	(	Index	i,
		Index	j
	)		const [inline]

Definition at line 74 of file Select.h.

    {
      if (m_condition.coeff(i,j))
        return m_then.coeff(i,j);
      else
        return m_else.coeff(i,j);
    }

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

EIGEN_DEVICE_FUNC const Scalar Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::coeff

(

Index

i

)

const [inline]

Definition at line 83 of file Select.h.

    {
      if (m_condition.coeff(i))
        return m_then.coeff(i);
      else
        return m_else.coeff(i);
    }

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

EIGEN_DEVICE_FUNC Index Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::cols

(

void

)

const [inline]

Definition at line 71 of file Select.h.

{ return m_condition.cols(); }

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

EIGEN_DEVICE_FUNC const ConditionMatrixType& Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::conditionMatrix

(

)

const [inline]

Definition at line 91 of file Select.h.

    {
      return m_condition;
    }

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

EIGEN_DEVICE_FUNC const ElseMatrixType& Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::elseMatrix

(

)

const [inline]

Definition at line 101 of file Select.h.

    {
      return m_else;
    }

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

EIGEN_DEVICE_FUNC Index Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::rows

(

void

)

const [inline]

Definition at line 70 of file Select.h.

{ return m_condition.rows(); }

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

EIGEN_DEVICE_FUNC const ThenMatrixType& Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::thenMatrix

(

)

const [inline]

Definition at line 96 of file Select.h.

    {
      return m_then;
    }

---

Member Data Documentation

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

ConditionMatrixType::Nested Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::m_condition [protected]

Definition at line 107 of file Select.h.

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

ElseMatrixType::Nested Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::m_else [protected]

Definition at line 109 of file Select.h.

template<typename ConditionMatrixType, typename ThenMatrixType, typename ElseMatrixType>

ThenMatrixType::Nested Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::m_then [protected]

Definition at line 108 of file Select.h.

---

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

• Select.h