WPILibC++ 2023.4.3-108-ge5452e3
Eigen::NestByValue< ExpressionType > Class Template Reference

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

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/NestByValue.h>

Inheritance diagram for Eigen::NestByValue< ExpressionType >:

Public Types

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

Public Member Functions

EIGEN_DEVICE_FUNC NestByValue (const ExpressionType &matrix)
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC operator const ExpressionType & () const
 
EIGEN_DEVICE_FUNC const ExpressionType & nestedExpression () const
 

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()

Member Typedef Documentation

◆ Base

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

Constructor & Destructor Documentation

◆ NestByValue()

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

Member Function Documentation

◆ cols()

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

◆ nestedExpression()

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

◆ operator const ExpressionType &()

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

◆ rows()

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

Member Data Documentation

◆ m_expression

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

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