gum::ActionSet Class Reference

A class to store the optimal actions. More...

#include <agrum/FMDP/planning/actionSet.h>

Collaboration diagram for gum::ActionSet:

Public Member Functions
Size	size () const
	Gives the size. More...
bool	exists (const Idx &elem) const
CNL
	ActionSet ()
	Constructor. More...
	ActionSet (const ActionSet &src)
	Constructor. More...
ActionSet &	operator= (const ActionSet &src)
	Constructor. More...
	~ActionSet ()
	Destructor. More...
void *	operator new (size_t s)
	Allocators and Deallocators redefinition. More...
void	operator delete (void *p)
	Constructor. More...
Iterators
SequenceIteratorSafe< Idx >	beginSafe () const
	Iterator beginning. More...
SequenceIteratorSafe< Idx >	endSafe () const
	Iterator end. More...
Operators
ActionSet &	operator+= (const Idx &elem)
	Ajout d'un élément. More...
ActionSet &	operator+= (const ActionSet &src)
	Use to insert the content of another set inside this one. More...
ActionSet &	operator-= (const ActionSet &src)
	Use to insert the content of another set inside this one. More...
const Idx &	operator[] (const Idx i) const
	Gives the ith element. More...
bool	operator== (const ActionSet &compared) const
	Compares two ActionSet to check if they are equals. More...
bool	operator!= (const ActionSet &compared) const
	Ajout d'un élément. More...

Friends
std::ostream &	operator<< (std::ostream &streamy, const ActionSet &objy)

Detailed Description

A class to store the optimal actions.

Stores the ids of optimal actions. To be used as leaves on optimal policy tree or function graph

Definition at line 88 of file actionSet.h.

Constructor & Destructor Documentation

ActionSet() [1/2]

gum::ActionSet::ActionSet ( )

inline

Constructor.

Definition at line 98 of file actionSet.h.

                {
      GUM_CONSTRUCTOR(ActionSet);
      __actionSeq = new Sequence< Idx >();
    }

ActionSet() [2/2]

gum::ActionSet::ActionSet ( const ActionSet &  src )

inline

Constructor.

Definition at line 103 of file actionSet.h.

References beginSafe(), endSafe(), and gum::SequenceImplementation< Key, Alloc, Gen >::insert().

                                    {
      GUM_CONSTRUCTOR(ActionSet);
      __actionSeq = new Sequence< Idx >();
      for (auto idi = src.beginSafe(); idi != src.endSafe(); ++idi)
        __actionSeq->insert(*idi);
    }

Here is the call graph for this function:

~ActionSet()

gum::ActionSet::~ActionSet ( )

inline

Destructor.

Definition at line 120 of file actionSet.h.

                 {
      GUM_DESTRUCTOR(ActionSet);
      delete __actionSeq;
    }

Member Function Documentation

beginSafe()

SequenceIteratorSafe< Idx > gum::ActionSet::beginSafe ( ) const

inline

Iterator beginning.

Definition at line 145 of file actionSet.h.

Referenced by ActionSet(), operator+=(), operator-=(), operator=(), operator==(), and gum::StructuredPlaner< double >::optimalPolicy2String().

                                                  {
      return __actionSeq->beginSafe();
    }

Here is the caller graph for this function:

endSafe()

SequenceIteratorSafe< Idx > gum::ActionSet::endSafe ( ) const

inline

Iterator end.

Definition at line 152 of file actionSet.h.

Referenced by ActionSet(), operator+=(), operator-=(), operator=(), operator==(), and gum::StructuredPlaner< double >::optimalPolicy2String().

{ return __actionSeq->endSafe(); }

Here is the caller graph for this function:

exists()

bool gum::ActionSet::exists ( const Idx &  elem ) const

inline

Definition at line 213 of file actionSet.h.

Referenced by operator==().

{ return __actionSeq->exists(elem); }

Here is the caller graph for this function:

operator delete()

void gum::ActionSet::operator delete ( void *  p )

inline

Constructor.

Definition at line 131 of file actionSet.h.

References gum::SmallObjectAllocator::deallocate(), and gum::SmallObjectAllocator::instance().

                                  {
      SmallObjectAllocator::instance().deallocate(p, sizeof(ActionSet));
    }

Here is the call graph for this function:

operator new()

void* gum::ActionSet::operator new ( size_t  s )

inline

Allocators and Deallocators redefinition.

Definition at line 128 of file actionSet.h.

References gum::SmallObjectAllocator::allocate(), and gum::SmallObjectAllocator::instance().

                                 {
      return SmallObjectAllocator::instance().allocate(s);
    }

Here is the call graph for this function:

operator!=()

bool gum::ActionSet::operator!= ( const ActionSet &  compared ) const

inline

Ajout d'un élément.

Definition at line 202 of file actionSet.h.

                                                     {
      return !(*this == compared);
    }

operator+=() [1/2]

ActionSet& gum::ActionSet::operator+= ( const Idx &  elem )

inline

Ajout d'un élément.

Definition at line 164 of file actionSet.h.

                                           {
      __actionSeq->insert(elem);
      return *this;
    }

operator+=() [2/2]

ActionSet& gum::ActionSet::operator+= ( const ActionSet &  src )

inline

Use to insert the content of another set inside this one.

Definition at line 172 of file actionSet.h.

References beginSafe(), and endSafe().

                                                {
      for (auto iter = src.beginSafe(); iter != src.endSafe(); ++iter)
        if (!__actionSeq->exists(*iter)) __actionSeq->insert(*iter);
      return *this;
    }

Here is the call graph for this function:

operator-=()

ActionSet& gum::ActionSet::operator-= ( const ActionSet &  src )

inline

Use to insert the content of another set inside this one.

Definition at line 181 of file actionSet.h.

References beginSafe(), and endSafe().

                                                {
      for (auto iter = src.beginSafe(); iter != src.endSafe(); ++iter)
        if (__actionSeq->exists(*iter)) __actionSeq->erase(*iter);
      return *this;
    }

Here is the call graph for this function:

operator=()

ActionSet& gum::ActionSet::operator= ( const ActionSet &  src )

inline

Constructor.

Definition at line 110 of file actionSet.h.

References beginSafe(), endSafe(), and gum::SequenceImplementation< Key, Alloc, Gen >::insert().

                                               {
      __actionSeq = new Sequence< Idx >();
      for (auto idi = src.beginSafe(); idi != src.endSafe(); ++idi)
        __actionSeq->insert(*idi);
      return *this;
    }

Here is the call graph for this function:

operator==()

bool gum::ActionSet::operator== ( const ActionSet &  compared ) const

inline

Compares two ActionSet to check if they are equals.

Definition at line 195 of file actionSet.h.

References beginSafe(), endSafe(), and exists().

                                                     {
      for (auto iter = compared.beginSafe(); iter != compared.endSafe(); ++iter)
        if (!__actionSeq->exists(*iter)) return false;
      for (auto iter = this->beginSafe(); iter != this->endSafe(); ++iter)
        if (!compared.exists(*iter)) return false;
      return true;
    }

Here is the call graph for this function:

operator[]()

const Idx& gum::ActionSet::operator[] ( const Idx  i ) const

inline

Gives the ith element.

Definition at line 190 of file actionSet.h.

{ return __actionSeq->atPos(i); }

size()

Size gum::ActionSet::size ( ) const

inline

Gives the size.

Definition at line 211 of file actionSet.h.

Referenced by gum::IDecisionStrategy::initialize(), gum::E_GreedyDecider::stateOptimalPolicy(), and gum::SDYNA::takeAction().

{ return __actionSeq->size(); }

Here is the caller graph for this function:

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  streamy, const ActionSet &  objy  )

friend

Definition at line 219 of file actionSet.h.

                                                                              {
      streamy << objy.__actionSeq->toString();
      return streamy;
    }

Member Data Documentation

__actionSeq

Sequence< Idx >* gum::ActionSet::__actionSeq

private

The very bone of the ActionSet.

Definition at line 217 of file actionSet.h.

---

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

• agrum/FMDP/planning/actionSet.h