Public Types | Public Member Functions | Protected Attributes | List of all members
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 >:
Inheritance graph
[legend]

Public Types

typedef internal::dense_xpr_base< Select >::type Base
 

Public Member Functions

EIGEN_DEVICE_FUNC const Scalar coeff (Index i, Index j) const
 
EIGEN_DEVICE_FUNC const Scalar coeff (Index i) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC const ConditionMatrixType & conditionMatrix () const
 
EIGEN_DEVICE_FUNC const ElseMatrixType & elseMatrix () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC Select (const ConditionMatrixType &a_conditionMatrix, const ThenMatrixType &a_thenMatrix, const ElseMatrixType &a_elseMatrix)
 
EIGEN_DEVICE_FUNC const ThenMatrixType & thenMatrix () const
 

Protected Attributes

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

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
ConditionMatrixTypethe type of the condition expression which must be a boolean matrix
ThenMatrixTypethe type of the then expression
ElseMatrixTypethe 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

◆ Base

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

◆ Select()

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.

Member Function Documentation

◆ coeff() [1/2]

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 76 of file Select.h.

◆ coeff() [2/2]

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 85 of file Select.h.

◆ cols()

template<typename ConditionMatrixType , typename ThenMatrixType , typename ElseMatrixType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::cols ( void  ) const
inline

Definition at line 73 of file Select.h.

◆ conditionMatrix()

template<typename ConditionMatrixType , typename ThenMatrixType , typename ElseMatrixType >
EIGEN_DEVICE_FUNC const ConditionMatrixType& Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::conditionMatrix ( ) const
inline

Definition at line 93 of file Select.h.

◆ elseMatrix()

template<typename ConditionMatrixType , typename ThenMatrixType , typename ElseMatrixType >
EIGEN_DEVICE_FUNC const ElseMatrixType& Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::elseMatrix ( ) const
inline

Definition at line 103 of file Select.h.

◆ rows()

template<typename ConditionMatrixType , typename ThenMatrixType , typename ElseMatrixType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::rows ( void  ) const
inline

Definition at line 71 of file Select.h.

◆ thenMatrix()

template<typename ConditionMatrixType , typename ThenMatrixType , typename ElseMatrixType >
EIGEN_DEVICE_FUNC const ThenMatrixType& Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::thenMatrix ( ) const
inline

Definition at line 98 of file Select.h.

Member Data Documentation

◆ m_condition

template<typename ConditionMatrixType , typename ThenMatrixType , typename ElseMatrixType >
ConditionMatrixType::Nested Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::m_condition
protected

Definition at line 109 of file Select.h.

◆ m_else

template<typename ConditionMatrixType , typename ThenMatrixType , typename ElseMatrixType >
ElseMatrixType::Nested Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::m_else
protected

Definition at line 111 of file Select.h.

◆ m_then

template<typename ConditionMatrixType , typename ThenMatrixType , typename ElseMatrixType >
ThenMatrixType::Nested Eigen::Select< ConditionMatrixType, ThenMatrixType, ElseMatrixType >::m_then
protected

Definition at line 110 of file Select.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:43:05