Flagged< ExpressionType, Added, Removed > Class Template Reference

Expression with modified flags. More...

#include <Flagged.h>

Inheritance diagram for Flagged< ExpressionType, Added, Removed >:

[legend]

List of all members.

Public Types
typedef ei_meta_if < ei_must_nest_by_value < ExpressionType >::ret, ExpressionType, const ExpressionType & >::ret	ExpressionTypeNested
typedef ExpressionType::InnerIterator	InnerIterator
Public Member Functions
const ExpressionType &	_expression () const
const Scalar	coeff (int index) const
const Scalar	coeff (int row, int col) const
Scalar &	coeffRef (int index)
Scalar &	coeffRef (int row, int col)
int	cols () const
	Flagged (const ExpressionType &matrix)
template<int LoadMode>
const PacketScalar	packet (int index) const
template<int LoadMode>
const PacketScalar	packet (int row, int col) const
int	rows () const
int	stride () const
template<int LoadMode>
void	writePacket (int index, const PacketScalar &x)
template<int LoadMode>
void	writePacket (int row, int col, const PacketScalar &x)
Protected Attributes
ExpressionTypeNested	m_matrix
Private Member Functions
Flagged &	operator= (const Flagged &)

---

Detailed Description

template<typename ExpressionType, unsigned int Added, unsigned int Removed>
class Flagged< ExpressionType, Added, Removed >

Expression with modified flags.

Parameters:

	ExpressionType	the type of the object of which we are modifying the flags
	Added	the flags added to the expression
	Removed	the flags removed from the expression (has priority over Added).

This class represents an expression whose flags have been modified. It is the return type of MatrixBase::flagged() and most of the time this is the only way it is used.

See also:

MatrixBase::flagged()

Definition at line 48 of file Flagged.h.

---

Member Typedef Documentation

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

typedef ei_meta_if<ei_must_nest_by_value<ExpressionType>::ret, ExpressionType, const ExpressionType&>::ret Flagged< ExpressionType, Added, Removed >::ExpressionTypeNested

Definition at line 55 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

typedef ExpressionType::InnerIterator Flagged< ExpressionType, Added, Removed >::InnerIterator

Definition at line 56 of file Flagged.h.

---

Constructor & Destructor Documentation

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

Flagged< ExpressionType, Added, Removed >::Flagged

(

const ExpressionType &

matrix

)

[inline]

Definition at line 58 of file Flagged.h.

---

Member Function Documentation

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

const ExpressionType& Flagged< ExpressionType, Added, Removed >::_expression

(

)

const [inline]

Definition at line 108 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

const Scalar Flagged< ExpressionType, Added, Removed >::coeff

(

int

index

)

const [inline]

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 74 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

const Scalar Flagged< ExpressionType, Added, Removed >::coeff	(	int	row,
		int	col
	)			const [inline]

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 64 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

Scalar& Flagged< ExpressionType, Added, Removed >::coeffRef

(

int

index

)

[inline]

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 79 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

Scalar& Flagged< ExpressionType, Added, Removed >::coeffRef	(	int	row,
		int	col
	)			[inline]

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 69 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

int Flagged< ExpressionType, Added, Removed >::cols

(

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 61 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

Flagged& Flagged< ExpressionType, Added, Removed >::operator=

(

const Flagged< ExpressionType, Added, Removed > &

)

[private]

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

template<int LoadMode>

const PacketScalar Flagged< ExpressionType, Added, Removed >::packet

(

int

index

)

const [inline]

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 97 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

template<int LoadMode>

const PacketScalar Flagged< ExpressionType, Added, Removed >::packet	(	int	row,
		int	col
	)			const [inline]

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 85 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

int Flagged< ExpressionType, Added, Removed >::rows

(

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 60 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

int Flagged< ExpressionType, Added, Removed >::stride

(

void

)

const [inline]

Returns:

number of elements to skip to pass from one row (resp. column) to another for a row-major (resp. column-major) matrix. Combined with coeffRef() and the flags flags, it allows a direct access to the data of the underlying matrix.

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 62 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

template<int LoadMode>

void Flagged< ExpressionType, Added, Removed >::writePacket	(	int	index,
		const PacketScalar &	x
	)			[inline]

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 103 of file Flagged.h.

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

template<int LoadMode>

void Flagged< ExpressionType, Added, Removed >::writePacket	(	int	row,
		int	col,
		const PacketScalar &	x
	)			[inline]

Reimplemented from MatrixBase< Flagged< ExpressionType, Added, Removed > >.

Definition at line 91 of file Flagged.h.

---

Member Data Documentation

template<typename ExpressionType, unsigned int Added, unsigned int Removed>

ExpressionTypeNested Flagged< ExpressionType, Added, Removed >::m_matrix [protected]

Definition at line 111 of file Flagged.h.

---

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

• Flagged.h