Eigen::NestByValue< ExpressionType > Class Template Reference

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

#include <NestByValue.h>

Inheritance diagram for Eigen::NestByValue< ExpressionType >:

Collaboration diagram for Eigen::NestByValue< ExpressionType >:

List of all members.

Public Types
typedef internal::dense_xpr_base < NestByValue >::type	Base
Public Member Functions
EIGEN_DEVICE_FUNC	NestByValue (const ExpressionType &matrix)
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC Index	outerStride () const
EIGEN_DEVICE_FUNC Index	innerStride () const
EIGEN_DEVICE_FUNC const CoeffReturnType	coeff (Index row, Index col) const
EIGEN_DEVICE_FUNC Scalar &	coeffRef (Index row, Index col)
EIGEN_DEVICE_FUNC const CoeffReturnType	coeff (Index index) const
EIGEN_DEVICE_FUNC Scalar &	coeffRef (Index index)
template<int LoadMode>
const PacketScalar	packet (Index row, Index col) const
template<int LoadMode>
void	writePacket (Index row, Index col, const PacketScalar &x)
template<int LoadMode>
const PacketScalar	packet (Index index) const
template<int LoadMode>
void	writePacket (Index index, const PacketScalar &x)
EIGEN_DEVICE_FUNC	operator const ExpressionType & () 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:

ExpressionType

the 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 34 of file NestByValue.h.

---

Member Typedef Documentation

template<typename ExpressionType >

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

Definition at line 39 of file NestByValue.h.

---

Constructor & Destructor Documentation

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Eigen::NestByValue< ExpressionType >::NestByValue

(

const ExpressionType &

matrix

)

[inline, explicit]

Definition at line 42 of file NestByValue.h.

: m_expression(matrix) {}

---

Member Function Documentation

template<typename ExpressionType >

EIGEN_DEVICE_FUNC const CoeffReturnType Eigen::NestByValue< ExpressionType >::coeff	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 49 of file NestByValue.h.

    {
      return m_expression.coeff(row, col);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC const CoeffReturnType Eigen::NestByValue< ExpressionType >::coeff

(

Index

index

)

const [inline]

Definition at line 59 of file NestByValue.h.

    {
      return m_expression.coeff(index);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Scalar& Eigen::NestByValue< ExpressionType >::coeffRef	(	Index	row,
		Index	col
	)		[inline]

Definition at line 54 of file NestByValue.h.

    {
      return m_expression.const_cast_derived().coeffRef(row, col);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Scalar& Eigen::NestByValue< ExpressionType >::coeffRef

(

Index

index

)

[inline]

Definition at line 64 of file NestByValue.h.

    {
      return m_expression.const_cast_derived().coeffRef(index);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Index Eigen::NestByValue< ExpressionType >::cols

(

void

)

const [inline]

Definition at line 45 of file NestByValue.h.

{ return m_expression.cols(); }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Index Eigen::NestByValue< ExpressionType >::innerStride

(

)

const [inline]

Definition at line 47 of file NestByValue.h.

{ return m_expression.innerStride(); }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Eigen::NestByValue< ExpressionType >::operator const ExpressionType &

(

)

const [inline]

Definition at line 93 of file NestByValue.h.

{ return m_expression; }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Index Eigen::NestByValue< ExpressionType >::outerStride

(

)

const [inline]

Definition at line 46 of file NestByValue.h.

{ return m_expression.outerStride(); }

template<typename ExpressionType >

template<int LoadMode>

const PacketScalar Eigen::NestByValue< ExpressionType >::packet	(	Index	row,
		Index	col
	)		const [inline]

Definition at line 70 of file NestByValue.h.

    {
      return m_expression.template packet<LoadMode>(row, col);
    }

template<typename ExpressionType >

template<int LoadMode>

const PacketScalar Eigen::NestByValue< ExpressionType >::packet

(

Index

index

)

const [inline]

Definition at line 82 of file NestByValue.h.

    {
      return m_expression.template packet<LoadMode>(index);
    }

template<typename ExpressionType >

EIGEN_DEVICE_FUNC Index Eigen::NestByValue< ExpressionType >::rows

(

void

)

const [inline]

Definition at line 44 of file NestByValue.h.

{ return m_expression.rows(); }

template<typename ExpressionType >

template<int LoadMode>

void Eigen::NestByValue< ExpressionType >::writePacket	(	Index	row,
		Index	col,
		const PacketScalar &	x
	)		[inline]

Definition at line 76 of file NestByValue.h.

    {
      m_expression.const_cast_derived().template writePacket<LoadMode>(row, col, x);
    }

template<typename ExpressionType >

template<int LoadMode>

void Eigen::NestByValue< ExpressionType >::writePacket	(	Index	index,
		const PacketScalar &	x
	)		[inline]

Definition at line 88 of file NestByValue.h.

    {
      m_expression.const_cast_derived().template writePacket<LoadMode>(index, x);
    }

---

Member Data Documentation

template<typename ExpressionType >

const ExpressionType Eigen::NestByValue< ExpressionType >::m_expression [protected]

Definition at line 96 of file NestByValue.h.

---

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

• NestByValue.h