Eigen::NestByValue< ExpressionType > Class Template Reference

Expression which must be nested by value. More...

Inherits internal::dense_xpr_base::type.

Public Types

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

Public Member Functions

EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
std::enable_if< HasDirectAccess, const Scalar * >::type data () const
 
std::enable_if< HasDirectAccess, Index >::type innerStride () const
 
 NestByValue (const ExpressionType &matrix)
 
const ExpressionType & nestedExpression () const
 
 operator const ExpressionType & () const
 
std::enable_if< HasDirectAccess, Index >::type outerStride () const
 
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 

Static Public Attributes

static constexpr bool HasDirectAccess
 

Protected Attributes

const ExpressionType m_expression
 

Detailed Description

template<typename ExpressionType>
class Eigen::NestByValue< ExpressionType >

Expression which must be nested by value.

Template Parameters
ExpressionTypethe type of the object of which we are requiring nesting-by-value

This class is the return type of MatrixBase::nestByValue() and most of the time this is the only way it is used.

See also
MatrixBase::nestByValue()

Definition at line 40 of file NestByValue.h.

Member Typedef Documentation

◆ Base

template<typename ExpressionType >
typedef internal::dense_xpr_base<NestByValue>::type Eigen::NestByValue< ExpressionType >::Base

Definition at line 45 of file NestByValue.h.

Constructor & Destructor Documentation

◆ NestByValue()

template<typename ExpressionType >
Eigen::NestByValue< ExpressionType >::NestByValue ( const ExpressionType &  matrix)
inlineexplicit

Definition at line 50 of file NestByValue.h.

50 : m_expression(matrix) {}
const ExpressionType m_expression
Definition: NestByValue.h:72

Member Function Documentation

◆ cols()

template<typename ExpressionType >
EIGEN_CONSTEXPR Index Eigen::NestByValue< ExpressionType >::cols ( void  ) const
inline

Definition at line 53 of file NestByValue.h.

53 { return m_expression.cols(); }

◆ data()

template<typename ExpressionType >
std::enable_if<HasDirectAccess, const Scalar*>::type Eigen::NestByValue< ExpressionType >::data ( ) const
inline

Definition at line 59 of file NestByValue.h.

59  {
60  return m_expression.data();
61  }

◆ innerStride()

template<typename ExpressionType >
std::enable_if<HasDirectAccess, Index>::type Eigen::NestByValue< ExpressionType >::innerStride ( ) const
inline

Definition at line 63 of file NestByValue.h.

63  {
64  return m_expression.innerStride();
65  }

◆ nestedExpression()

template<typename ExpressionType >
const ExpressionType& Eigen::NestByValue< ExpressionType >::nestedExpression ( ) const
inline

Definition at line 57 of file NestByValue.h.

57 { return m_expression; }

◆ operator const ExpressionType &()

template<typename ExpressionType >
Eigen::NestByValue< ExpressionType >::operator const ExpressionType & ( ) const
inline

Definition at line 55 of file NestByValue.h.

55 { return m_expression; }

◆ outerStride()

template<typename ExpressionType >
std::enable_if<HasDirectAccess, Index>::type Eigen::NestByValue< ExpressionType >::outerStride ( ) const
inline

Definition at line 67 of file NestByValue.h.

67  {
68  return m_expression.outerStride();
69  }

◆ rows()

template<typename ExpressionType >
EIGEN_CONSTEXPR Index Eigen::NestByValue< ExpressionType >::rows ( void  ) const
inline

Definition at line 52 of file NestByValue.h.

52 { return m_expression.rows(); }

Member Data Documentation

◆ HasDirectAccess

template<typename ExpressionType >
constexpr bool Eigen::NestByValue< ExpressionType >::HasDirectAccess
staticconstexpr

Definition at line 46 of file NestByValue.h.

◆ m_expression

template<typename ExpressionType >
const ExpressionType Eigen::NestByValue< ExpressionType >::m_expression
protected

Definition at line 72 of file NestByValue.h.


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