Eigen::NestByValue< ExpressionType > Class Template Reference

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

#include <NestByValue.h>

List of all members.

Public Types
typedef internal::dense_xpr_base< NestByValue >::type	Base
Public Member Functions
	NestByValue (const ExpressionType &matrix)
Index	rows () const
Index	cols () const
Index	outerStride () const
Index	innerStride () const
const CoeffReturnType	coeff (Index row, Index col) const
Scalar &	coeffRef (Index row, Index col)
const CoeffReturnType	coeff (Index index) const
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)
	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.

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

---

Member Typedef Documentation

template<typename ExpressionType>

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

Definition at line 40 of file NestByValue.h.

---

Constructor & Destructor Documentation

template<typename ExpressionType>

Eigen::NestByValue< ExpressionType >::NestByValue

(

const ExpressionType &

matrix

)

[inline]

Definition at line 43 of file NestByValue.h.

---

Member Function Documentation

template<typename ExpressionType>

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

(

Index

index

)

const [inline]

Definition at line 60 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

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

Definition at line 50 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

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

(

Index

index

)

[inline]

Definition at line 65 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

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

Definition at line 55 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

Index Eigen::NestByValue< ExpressionType >::cols

(

void

)

const [inline]

Definition at line 46 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

Index Eigen::NestByValue< ExpressionType >::innerStride

(

)

const [inline]

Definition at line 48 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

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

(

)

const [inline]

Definition at line 94 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

Index Eigen::NestByValue< ExpressionType >::outerStride

(

)

const [inline]

Definition at line 47 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

template<int LoadMode>

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

(

Index

index

)

const [inline]

Definition at line 83 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

template<int LoadMode>

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

Definition at line 71 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

Index Eigen::NestByValue< ExpressionType >::rows

(

void

)

const [inline]

Definition at line 45 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

template<int LoadMode>

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

Definition at line 89 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

template<typename ExpressionType>

template<int LoadMode>

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

Definition at line 77 of file NestByValue.h.

References Eigen::NestByValue< ExpressionType >::m_expression.

---

Member Data Documentation

template<typename ExpressionType>

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

Definition at line 97 of file NestByValue.h.

Referenced by Eigen::NestByValue< ExpressionType >::coeff(), Eigen::NestByValue< ExpressionType >::coeffRef(), Eigen::NestByValue< ExpressionType >::cols(), Eigen::NestByValue< ExpressionType >::innerStride(), Eigen::NestByValue< ExpressionType >::operator const ExpressionType &(), Eigen::NestByValue< ExpressionType >::outerStride(), Eigen::NestByValue< ExpressionType >::packet(), Eigen::NestByValue< ExpressionType >::rows(), and Eigen::NestByValue< ExpressionType >::writePacket().

---

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

• Eigen/include/src/Core/NestByValue.h

---