Eigen::Flagged< ExpressionType, Added, Removed > Class Template Reference

Expression with modified flags. More...

#include <Flagged.h>

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

List of all members.

Public Types
typedef MatrixBase< Flagged >	Base
typedef internal::conditional < internal::must_nest_by_value < ExpressionType >::ret, ExpressionType, const ExpressionType & >::type	ExpressionTypeNested
typedef ExpressionType::InnerIterator	InnerIterator
Public Member Functions
const ExpressionType &	_expression () const
CoeffReturnType	coeff (Index row, Index col) const
CoeffReturnType	coeff (Index index) const
const Scalar &	coeffRef (Index row, Index col) const
const Scalar &	coeffRef (Index index) const
Scalar &	coeffRef (Index row, Index col)
Scalar &	coeffRef (Index index)
Index	cols () const
	Flagged (const ExpressionType &matrix)
Index	innerStride () const
Index	outerStride () const
template<int LoadMode>
const PacketScalar	packet (Index row, Index col) const
template<int LoadMode>
const PacketScalar	packet (Index index) const
Index	rows () const
template<typename OtherDerived >
ExpressionType::PlainObject	solveTriangular (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
void	solveTriangularInPlace (const MatrixBase< OtherDerived > &other) const
template<int LoadMode>
void	writePacket (Index row, Index col, const PacketScalar &x)
template<int LoadMode>
void	writePacket (Index index, const PacketScalar &x)
Protected Attributes
ExpressionTypeNested	m_matrix

---

Detailed Description

template<typename ExpressionType, unsigned int Added, unsigned int Removed>
class Eigen::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 39 of file Flagged.h.

---

Member Typedef Documentation

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

typedef MatrixBase<Flagged> Eigen::Flagged< ExpressionType, Added, Removed >::Base

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

Definition at line 44 of file Flagged.h.

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

typedef internal::conditional<internal::must_nest_by_value<ExpressionType>::ret, ExpressionType, const ExpressionType&>::type Eigen::Flagged< ExpressionType, Added, Removed >::ExpressionTypeNested

Definition at line 48 of file Flagged.h.

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

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

Definition at line 49 of file Flagged.h.

---

Constructor & Destructor Documentation

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

Eigen::Flagged< ExpressionType, Added, Removed >::Flagged

(

const ExpressionType &

matrix

)

[inline]

Definition at line 51 of file Flagged.h.

---

Member Function Documentation

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

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

(

)

const [inline]

Definition at line 112 of file Flagged.h.

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

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

Definition at line 58 of file Flagged.h.

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

CoeffReturnType Eigen::Flagged< ExpressionType, Added, Removed >::coeff

(

Index

index

)

const [inline]

Definition at line 63 of file Flagged.h.

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

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

Definition at line 68 of file Flagged.h.

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

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

(

Index

index

)

const [inline]

Definition at line 73 of file Flagged.h.

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

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

Definition at line 78 of file Flagged.h.

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

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

(

Index

index

)

[inline]

Definition at line 83 of file Flagged.h.

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

Index Eigen::Flagged< ExpressionType, Added, Removed >::cols

(

void

)

const [inline]

Definition at line 54 of file Flagged.h.

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

Index Eigen::Flagged< ExpressionType, Added, Removed >::innerStride

(

)

const [inline]

Definition at line 56 of file Flagged.h.

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

Index Eigen::Flagged< ExpressionType, Added, Removed >::outerStride

(

)

const [inline]

Definition at line 55 of file Flagged.h.

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

template<int LoadMode>

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

Definition at line 89 of file Flagged.h.

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

template<int LoadMode>

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

(

Index

index

)

const [inline]

Definition at line 101 of file Flagged.h.

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

Index Eigen::Flagged< ExpressionType, Added, Removed >::rows

(

void

)

const [inline]

Definition at line 53 of file Flagged.h.

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

template<typename OtherDerived >

ExpressionType::PlainObject Eigen::Flagged< ExpressionType, Added, Removed >::solveTriangular

(

const MatrixBase< OtherDerived > &

other

)

const

Definition at line 28 of file Eigen2Support/TriangularSolver.h.

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

template<typename OtherDerived >

void Eigen::Flagged< ExpressionType, Added, Removed >::solveTriangularInPlace

(

const MatrixBase< OtherDerived > &

other

)

const

Definition at line 35 of file Eigen2Support/TriangularSolver.h.

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

template<int LoadMode>

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

Definition at line 95 of file Flagged.h.

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

template<int LoadMode>

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

Definition at line 107 of file Flagged.h.

---

Member Data Documentation

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

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

Definition at line 121 of file Flagged.h.

---

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

• Flagged.h
• Eigen2Support/TriangularSolver.h