gum::AbstractSimulator Class Reference

<agrum/FMDP/simulation/abstractSimulator.h> More...

#include <abstractSimulator.h>

Inheritance diagram for gum::AbstractSimulator:

Collaboration diagram for gum::AbstractSimulator:

Public Attributes
Instantiation	_currentState
	Tha state in which the system currently is. More...
Instantiation	_endState

Public Member Functions
Constructors, Destructors.
	AbstractSimulator ()
	Default constructor. More...
virtual	~AbstractSimulator ()
	Default destructor. More...
Variables
virtual const DiscreteVariable *	primeVar (const DiscreteVariable *mainVar)=0
	Iteration over the variables of the simulated probleme. More...
virtual SequenceIteratorSafe< const DiscreteVariable *>	beginVariables ()=0
	Iteration over the variables of the simulated probleme. More...
virtual SequenceIteratorSafe< const DiscreteVariable *>	endVariables ()=0
	Iteration over the variables of the simulated probleme. More...
Actions
virtual const std::string &	actionName (Idx)=0
	Iteration over the variables of the simulated probleme. More...
virtual SequenceIteratorSafe< Idx >	beginActions ()=0
	Iteration over the variables of the simulated probleme. More...
virtual SequenceIteratorSafe< Idx >	endActions ()=0
	Iteration over the variables of the simulated probleme. More...
INLINE void	setInitialState (const Instantiation &initialState)
	Sets the intial statefrom which we begun the simulation. More...
void	setInitialStateRandomly ()
	Sets the intial statefrom which we begun the simulation. More...
INLINE void	setEndState (const Instantiation &endState)
	Sets the final states upon which a run is over. More...
virtual bool	hasReachEnd ()
	Tests if end state has been reached. More...
INLINE const Instantiation &	currentState ()
	Sets the intial statefrom which we begun the simulation. More...
virtual double	reward ()=0
	Sets the intial statefrom which we begun the simulation. More...
virtual void	perform (Idx)=0
	Sets the intial statefrom which we begun the simulation. More...
virtual Instantiation	_randomState ()
	Choses a random state as the first test for a run. More...

Detailed Description

<agrum/FMDP/simulation/abstractSimulator.h>

A class to simulate a reinforcement learning problem.

Definition at line 48 of file abstractSimulator.h.

Constructor & Destructor Documentation

AbstractSimulator()

gum::AbstractSimulator::AbstractSimulator

(

)

Default constructor.

Definition at line 46 of file abstractSimulator.cpp.

{ GUM_CONSTRUCTOR(AbstractSimulator); }

~AbstractSimulator()

gum::AbstractSimulator::~AbstractSimulator ( )

virtual

Default destructor.

Definition at line 51 of file abstractSimulator.cpp.

{ GUM_DESTRUCTOR(AbstractSimulator); }

Member Function Documentation

_randomState()

Instantiation gum::AbstractSimulator::_randomState ( )

protectedvirtual

Choses a random state as the first test for a run.

Reimplemented in gum::FactorySimulator, and gum::TaxiSimulator.

Definition at line 66 of file abstractSimulator.cpp.

References gum::Instantiation::add(), beginVariables(), gum::Instantiation::chgVal(), and endVariables().

Referenced by gum::TaxiSimulator::_randomState(), setInitialState(), and setInitialStateRandomly().

                                                {
    Instantiation retState;
    for (auto varIter = this->beginVariables(); varIter != this->endVariables();
         ++varIter) {
      retState.add(**varIter);
      retState.chgVal(*varIter,
                      (Idx)(((double)std::rand() / (double)RAND_MAX)
                            * (double)(*varIter)->domainSize()));
    }
    return retState;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

actionName()

virtual const std::string& gum::AbstractSimulator::actionName ( Idx  )

pure virtual

Iteration over the variables of the simulated probleme.

Implemented in gum::FactorySimulator, gum::TaxiSimulator, and gum::FMDPSimulator.

Referenced by currentState().

Here is the caller graph for this function:

beginActions()

virtual SequenceIteratorSafe< Idx > gum::AbstractSimulator::beginActions ( )

pure virtual

Iteration over the variables of the simulated probleme.

Implemented in gum::FactorySimulator, gum::TaxiSimulator, and gum::FMDPSimulator.

Referenced by currentState().

Here is the caller graph for this function:

beginVariables()

virtual SequenceIteratorSafe< const DiscreteVariable* > gum::AbstractSimulator::beginVariables ( )

pure virtual

Iteration over the variables of the simulated probleme.

Implemented in gum::FactorySimulator, gum::TaxiSimulator, and gum::FMDPSimulator.

Referenced by _randomState(), and currentState().

Here is the caller graph for this function:

currentState()

INLINE const Instantiation& gum::AbstractSimulator::currentState ( )

inline

Sets the intial statefrom which we begun the simulation.

Definition at line 92 of file abstractSimulator.h.

References _currentState, actionName(), beginActions(), beginVariables(), endActions(), endVariables(), perform(), primeVar(), and reward().

{ return _currentState; }

Here is the call graph for this function:

endActions()

virtual SequenceIteratorSafe< Idx > gum::AbstractSimulator::endActions ( )

pure virtual

Iteration over the variables of the simulated probleme.

Implemented in gum::FactorySimulator, gum::TaxiSimulator, and gum::FMDPSimulator.

Referenced by currentState().

Here is the caller graph for this function:

endVariables()

virtual SequenceIteratorSafe< const DiscreteVariable* > gum::AbstractSimulator::endVariables ( )

pure virtual

Iteration over the variables of the simulated probleme.

Implemented in gum::FactorySimulator, gum::TaxiSimulator, and gum::FMDPSimulator.

Referenced by _randomState(), and currentState().

Here is the caller graph for this function:

hasReachEnd()

bool gum::AbstractSimulator::hasReachEnd ( )

virtual

Tests if end state has been reached.

Reimplemented in gum::FactorySimulator, and gum::TaxiSimulator.

Definition at line 79 of file abstractSimulator.cpp.

References _currentState, _endState, gum::Instantiation::empty(), gum::Instantiation::val(), and gum::Instantiation::variablesSequence().

Referenced by setEndState(), and setInitialStateRandomly().

                                      {
    if (_endState.empty()) return false;

    for (auto varIter = _endState.variablesSequence().beginSafe();
         varIter != _endState.variablesSequence().endSafe();
         ++varIter)
      if (_endState.val(**varIter) != _currentState.val(**varIter)) return false;
    return true;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

perform()

virtual void gum::AbstractSimulator::perform ( Idx  )

pure virtual

Sets the intial statefrom which we begun the simulation.

Implemented in gum::TaxiSimulator, gum::FactorySimulator, and gum::FMDPSimulator.

Referenced by currentState().

Here is the caller graph for this function:

primeVar()

virtual const DiscreteVariable* gum::AbstractSimulator::primeVar ( const DiscreteVariable *  mainVar )

pure virtual

Iteration over the variables of the simulated probleme.

Implemented in gum::FactorySimulator, gum::TaxiSimulator, and gum::FMDPSimulator.

Referenced by currentState().

Here is the caller graph for this function:

reward()

virtual double gum::AbstractSimulator::reward ( )

pure virtual

Sets the intial statefrom which we begun the simulation.

Implemented in gum::TaxiSimulator, gum::FactorySimulator, and gum::FMDPSimulator.

Referenced by currentState().

Here is the caller graph for this function:

setEndState()

INLINE void gum::AbstractSimulator::setEndState ( const Instantiation &  endState )

inline

Sets the final states upon which a run is over.

Definition at line 84 of file abstractSimulator.h.

References _endState, and hasReachEnd().

                                                           {
      _endState = endState;
    }

Here is the call graph for this function:

setInitialState()

INLINE void gum::AbstractSimulator::setInitialState ( const Instantiation &  initialState )

inline

Sets the intial statefrom which we begun the simulation.

Definition at line 73 of file abstractSimulator.h.

References _currentState, _randomState(), and setInitialStateRandomly().

                                                                   {
      _currentState = initialState;
    }

Here is the call graph for this function:

setInitialStateRandomly()

void gum::AbstractSimulator::setInitialStateRandomly

(

)

Sets the intial statefrom which we begun the simulation.

Definition at line 58 of file abstractSimulator.cpp.

References _currentState, _randomState(), and hasReachEnd().

Referenced by setInitialState().

                                                  {
    bool hre = true;
    while (hre) {
      _currentState = _randomState();
      hre = hasReachEnd();
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_currentState

Instantiation gum::AbstractSimulator::_currentState

Tha state in which the system currently is.

Definition at line 130 of file abstractSimulator.h.

Referenced by gum::TaxiSimulator::__evalReward(), gum::TaxiSimulator::__performFillUp(), gum::TaxiSimulator::__performGoEast(), gum::TaxiSimulator::__performGoNorth(), gum::TaxiSimulator::__performGoSouth(), gum::TaxiSimulator::__performGoWest(), gum::TaxiSimulator::__performPickUp(), gum::TaxiSimulator::__performPutDown(), currentState(), hasReachEnd(), gum::FMDPSimulator::perform(), gum::TaxiSimulator::perform(), gum::FMDPSimulator::reward(), setInitialState(), and setInitialStateRandomly().

_endState

Instantiation gum::AbstractSimulator::_endState

Definition at line 130 of file abstractSimulator.h.

Referenced by hasReachEnd(), and setEndState().

---

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

• agrum/FMDP/simulation/abstractSimulator.h
• agrum/FMDP/simulation/abstractSimulator.cpp