faudes::StateSetOperator Class Reference

Detailed Description

Operator on state sets

Light weight base class to be used in fixpoint iterations. See faudes::CtrlPfxOperator for an example of a derived class.

Definition at line 39 of file syn_ctrlpfx.h.

#include <syn_ctrlpfx.h>

Public Member Functions
	StateSetOperator (void)
	StateSetOperator (const StateSetOperator &)=delete
	~StateSetOperator (void)
virtual const StateSet &	Domain (void) const
void	Evaluate (StateSetVector &rArgs, StateSet &rRes) const
void	Evaluate (StateSet &rArg, StateSet &rRes) const
void	Evaluate (StateSet &rRes) const
StateSetVector::Position	ArgCount (void) const
const std::string &	ArgName (StateSetVector::Position pos) const
std::string	ArgStatistics (const StateSetVector &rArgs) const
virtual const std::string &	Indent (void) const
virtual void	Indent (const std::string &indent) const
Public Member Functions inherited from faudes::ExtType
	ExtType (void)
	ExtType (const ExtType &rType)
virtual	~ExtType (void)
const std::string &	Name (void) const
void	Name (const std::string &rName)
virtual const std::string &	TypeName (void) const
virtual void	TypeName (const std::string &rType)
virtual const std::string &	ElementTag (void) const
virtual void	ElementTag (const std::string &rTag)
virtual const std::string &	ElementType (void) const
virtual const TypeDefinition *	TypeDefinitionp (void) const
Type &	operator= (const Type &rSrc)
bool	operator== (const Type &rOther) const
bool	operator!= (const Type &rOther) const
Public Member Functions inherited from faudes::AttrType
	AttrType (void)
	AttrType (const AttrType &rSrc)
virtual	~AttrType (void)
virtual bool	IsDefault (void) const
Type &	operator= (const Type &rSrc)
bool	operator== (const Type &rOther) const
bool	operator!= (const Type &rOther) const
Public Member Functions inherited from faudes::Type
	Type (void)
	Type (const Type &rType)
virtual	~Type (void)
virtual Type *	New (void) const
virtual Type *	Copy (void) const
virtual const Type *	Cast (const Type *pOther) const
virtual void	Clear (void)
virtual Type &	Assign (const Type &rSrc)
Type &	operator= (const Type &rSrc)
virtual bool	Equal (const Type &rOther) const
bool	operator== (const Type &rOther) const
bool	operator!= (const Type &rOther) const
void	Write (const Type *pContext=0) const
void	Write (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
void	Write (const std::string &pFileName, std::ios::openmode openmode) const
void	Write (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	XWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0) const
void	XWrite (const Type *pContext=0) const
void	XWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
std::string	ToString (const std::string &rLabel="", const Type *pContext=0) const
std::string	ToText (const std::string &rLabel="", const Type *pContext=0) const
void	DWrite (const Type *pContext=0) const
void	DWrite (const std::string &pFileName, const std::string &rLabel="", const Type *pContext=0, std::ios::openmode openmode=std::ios::out|std::ios::trunc) const
void	DWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
void	SWrite (TokenWriter &rTw) const
void	SWrite (void) const
std::string	ToSText (void) const
void	Read (const std::string &rFileName, const std::string &rLabel="", const Type *pContext=0)
void	FromString (const std::string &rString, const std::string &rLabel="", const Type *pContext=0)
void	Read (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)

Protected Member Functions
virtual void	DoEvaluate (StateSetVector &rArgs, StateSet &rRes)=0
Protected Member Functions inherited from faudes::AttrType
void	DoAssign (const AttrType &rSrc)
bool	DoEqual (const AttrType &rOther) const
Protected Member Functions inherited from faudes::Type
void	DoAssign (const Type &rSrc)
bool	DoEqual (const Type &rOther) const
virtual void	DoRead (TokenReader &rTr, const std::string &rLabel="", const Type *pContext=0)
virtual void	DoWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	DoXWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	DoDWrite (TokenWriter &rTw, const std::string &rLabel="", const Type *pContext=0) const
virtual void	DoSWrite (TokenWriter &rTw) const
virtual Token	XBeginTag (const std::string &rLabel="", const std::string &rFallbackLabel="") const

Protected Attributes
StateSetVector::Position	mArgCount
std::vector< std::string >	mArgNames
std::string	mIndent
Protected Attributes inherited from faudes::ExtType
std::string	mElementType
std::string	mElementTagDef
std::string	mObjectName

Additional Inherited Members
Static Public Member Functions inherited from faudes::AttrType
static void	Skip (TokenReader &rTr)

Constructor & Destructor Documentation

StateSetOperator() [1/2]

faudes::StateSetOperator::StateSetOperator ( void  )

inline

construct

Definition at line 44 of file syn_ctrlpfx.h.

StateSetOperator() [2/2]

faudes::StateSetOperator::StateSetOperator ( const StateSetOperator &  )

delete

disable copy construct

~StateSetOperator()

faudes::StateSetOperator::~StateSetOperator ( void  )

inline

destruct

Definition at line 50 of file syn_ctrlpfx.h.

Member Function Documentation

ArgCount()

StateSetVector::Position faudes::StateSetOperator::ArgCount

(

void

)

const

signature, i.e., the number of arguments we expect

Definition at line 79 of file syn_ctrlpfx.cpp.

ArgName()

const std::string & faudes::StateSetOperator::ArgName

(

StateSetVector::Position

pos

)

const

signature, i.e., argument names (cosmetic)

Definition at line 84 of file syn_ctrlpfx.cpp.

ArgStatistics()

std::string faudes::StateSetOperator::ArgStatistics

(

const StateSetVector &

rArgs

)

const

argument stats (debugging/development)

Definition at line 91 of file syn_ctrlpfx.cpp.

DoEvaluate()

virtual void faudes::StateSetOperator::DoEvaluate ( StateSetVector &  rArgs, StateSet &  rRes  )

protectedpure virtual

Evaluate opertor on arguments (protected virtual)

The arguments are given as a vector of state sets. For fixpoint iterations, the last entry in the vector becomes the iteration variable, while the remaining entries are constant parameters. Re-implement this function for the oparater you want to iterate on. See faudes::CtrlPfxOperator for a derived class.

Parameters

rAggs	State-set valued arguments the operator performs on
rRes	Resulting state set

Implemented in faudes::NuIteration, faudes::MuIteration, faudes::CtrlPfxOperator, faudes::RabinInvDynCtrlWithRanking, faudes::RabinInvDynCtrl_RK, faudes::RabinInvDynCtrlCore_RK, faudes::RabinInvDynPReach_RK, faudes::RabinInvDynPReachCore_RK, faudes::RabinInvDynThetaTilde_RK, faudes::RabinInvDynThetaTildeCore_RK, faudes::RabinInvDynTheta_RK, faudes::RabinInvDynCtrl, faudes::RabinInvDynCtrlInner, faudes::RabinInvDynCtrlCore, faudes::RabinInvDynPReach, faudes::RabinInvDynPReachCore, faudes::RabinInvDynThetaTilde, faudes::RabinInvDynThetaTildeInner, faudes::RabinInvDynThetaTildeCore, and faudes::RabinInvDynTheta.

Domain()

const StateSet & faudes::StateSetOperator::Domain ( void  ) const

virtual

Domain

Some operations need to take complements and thus refer to the full state set. The base class returns the empty set as a dummy. Reimplement this function if you need that extra functionality. See faudes::CtrlPfxOperator for a derived class.

Returns

Full state set.

Reimplemented in faudes::NuIteration, faudes::MuIteration, faudes::CtrlPfxOperator, faudes::RabinInvDynOperator_RK, and faudes::RabinInvDynOperator.

Definition at line 37 of file syn_ctrlpfx.cpp.

Evaluate() [1/3]

void faudes::StateSetOperator::Evaluate	(	StateSet &	rArg,
		StateSet &	rRes
	)		const

Evaluate opertor on arguments

This is a convenience wrapper for the protected method DoEvaluate for operators with only one argument.

Parameters

rArg	State-set valued argument
rRes	Resulting state set

Definition at line 54 of file syn_ctrlpfx.cpp.

Evaluate() [2/3]

void faudes::StateSetOperator::Evaluate

(

StateSet &

rRes

)

const

Evaluate opertor on arguments

This is a convenience wrapper for the protected method DoEvaluate for operators with no arguments.

Parameters

rRes	Resulting state set

Definition at line 67 of file syn_ctrlpfx.cpp.

Evaluate() [3/3]

void faudes::StateSetOperator::Evaluate	(	StateSetVector &	rArgs,
		StateSet &	rRes
	)		const

Evaluate opertor on arguments

This is a wrapper for the protected method DoEvaluate. The latter should be re-implemented by derived classes to encode the actual operator.

Parameters

rArgs	State-set valued arguments the operator performs on
rRes	Resulting state set

Definition at line 43 of file syn_ctrlpfx.cpp.

Indent() [1/2]

void faudes::StateSetOperator::Indent ( const std::string &  indent ) const

virtual

indent (cosmetic)

Reimplemented in faudes::NuIteration, and faudes::MuIteration.

Definition at line 105 of file syn_ctrlpfx.cpp.

Indent() [2/2]

const std::string & faudes::StateSetOperator::Indent ( void  ) const

virtual

indent (cosmetic)

Reimplemented in faudes::NuIteration, faudes::MuIteration, faudes::NuIteration, and faudes::MuIteration.

Definition at line 100 of file syn_ctrlpfx.cpp.

Member Data Documentation

mArgCount

StateSetVector::Position faudes::StateSetOperator::mArgCount

protected

signature

Definition at line 119 of file syn_ctrlpfx.h.

mArgNames

std::vector<std::string> faudes::StateSetOperator::mArgNames

protected

support cosmetic siganture

Definition at line 122 of file syn_ctrlpfx.h.

mIndent

std::string faudes::StateSetOperator::mIndent

protected

support cosmetic

Definition at line 125 of file syn_ctrlpfx.h.

---

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

• syn_ctrlpfx.h
• syn_ctrlpfx.cpp