gum::FMDPSimulator Class Reference

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

#include <fmdpSimulator.h>

Inheritance diagram for gum::FMDPSimulator:

Collaboration diagram for gum::FMDPSimulator:

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

Public Member Functions
Constructors, Destructors.
	FMDPSimulator (const FMDP< double > *fmdp)
	Default constructor. More...
	FMDPSimulator (const std::string &resource)
	Default constructor. More...
	~FMDPSimulator ()
	Default destructor. More...
double	reward ()
	Sets the intial statefrom which we begun the simulation. More...
void	perform (Idx)
	Sets the intial statefrom which we begun the simulation. More...
const DiscreteVariable *	primeVar (const DiscreteVariable *mainVar)
	Iteration over the variables of the simulated probleme. More...
SequenceIteratorSafe< const DiscreteVariable *>	beginVariables ()
	Iteration over the variables of the simulated probleme. More...
SequenceIteratorSafe< const DiscreteVariable *>	endVariables ()
	Iteration over the variables of the simulated probleme. More...
virtual const std::string &	actionName (Idx actionId)
	Iteration over the variables of the simulated probleme. More...
SequenceIteratorSafe< Idx >	beginActions ()
	Iteration over the variables of the simulated probleme. More...
SequenceIteratorSafe< Idx >	endActions ()
	Iteration over the variables of the simulated probleme. More...

Protected Member Functions
virtual double	_transitionProbability (const DiscreteVariable *var, const Instantiation &transit, Idx actionId)
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 Instantiation	_randomState ()
	Choses a random state as the first test for a run. More...

Detailed Description

<agrum/FMDP/simulation/fmdpSimulator.h>

A class to simulate a Factored Markov Decision Process.

Definition at line 48 of file fmdpSimulator.h.

Constructor & Destructor Documentation

FMDPSimulator() [1/2]

gum::FMDPSimulator::FMDPSimulator

(

const FMDP< double > *

fmdp

)

Default constructor.

Definition at line 47 of file fmdpSimulator.cpp.

                                                         :
      AbstractSimulator(), __fmdp(const_cast< FMDP< double >* >(fmdp)),
      __loaded(false) {
    GUM_CONSTRUCTOR(FMDPSimulator);
  }

FMDPSimulator() [2/2]

gum::FMDPSimulator::FMDPSimulator

(

const std::string &

resource

)

Default constructor.

Definition at line 53 of file fmdpSimulator.cpp.

References __fmdp.

                                                         :
      AbstractSimulator(), __loaded(true) {
    GUM_CONSTRUCTOR(FMDPSimulator);

    __fmdp = new FMDP< double >(true);
    FMDPDatReader< double > reader(__fmdp, ressource);
    reader.trace(false);
    reader.proceed();
  }

~FMDPSimulator()

gum::FMDPSimulator::~FMDPSimulator

(

)

Default destructor.

Definition at line 66 of file fmdpSimulator.cpp.

References __fmdp, and __loaded.

                                {
    GUM_DESTRUCTOR(FMDPSimulator);
    if (__loaded) delete __fmdp;
  }

Member Function Documentation

_randomState()

Instantiation gum::AbstractSimulator::_randomState ( )

protectedvirtualinherited

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(), gum::AbstractSimulator::beginVariables(), gum::Instantiation::chgVal(), and gum::AbstractSimulator::endVariables().

Referenced by gum::TaxiSimulator::_randomState(), gum::AbstractSimulator::setInitialState(), and gum::AbstractSimulator::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:

_transitionProbability()

virtual double gum::FMDPSimulator::_transitionProbability ( const DiscreteVariable *  var, const Instantiation &  transit, Idx  actionId  )

inlineprotectedvirtual

Definition at line 114 of file fmdpSimulator.h.

References __fmdp, and gum::FMDP< GUM_SCALAR >::transition().

Referenced by perform().

                                                                            {
      return reinterpret_cast< const MultiDimFunctionGraph< double >* >(
                __fmdp->transition(actionId, var))
         ->get(transit);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

actionName()

virtual const std::string& gum::FMDPSimulator::actionName ( Idx  actionId )

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 104 of file fmdpSimulator.h.

References __fmdp, and gum::FMDP< GUM_SCALAR >::actionName().

                                                      {
      return __fmdp->actionName(actionId);
    }

Here is the call graph for this function:

beginActions()

SequenceIteratorSafe< Idx > gum::FMDPSimulator::beginActions ( )

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 109 of file fmdpSimulator.h.

References __fmdp, and gum::FMDP< GUM_SCALAR >::beginActions().

{ return __fmdp->beginActions(); }

Here is the call graph for this function:

beginVariables()

SequenceIteratorSafe< const DiscreteVariable* > gum::FMDPSimulator::beginVariables ( )

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 90 of file fmdpSimulator.h.

References __fmdp, and gum::FMDP< GUM_SCALAR >::beginVariables().

Referenced by perform().

                                                                     {
      return __fmdp->beginVariables();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

currentState()

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

inlineinherited

Sets the intial statefrom which we begun the simulation.

Definition at line 92 of file abstractSimulator.h.

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

{ return _currentState; }

Here is the call graph for this function:

endActions()

SequenceIteratorSafe< Idx > gum::FMDPSimulator::endActions ( )

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 110 of file fmdpSimulator.h.

References __fmdp, and gum::FMDP< GUM_SCALAR >::endActions().

{ return __fmdp->endActions(); }

Here is the call graph for this function:

endVariables()

SequenceIteratorSafe< const DiscreteVariable* > gum::FMDPSimulator::endVariables ( )

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 93 of file fmdpSimulator.h.

References __fmdp, and gum::FMDP< GUM_SCALAR >::endVariables().

Referenced by perform().

                                                                   {
      return __fmdp->endVariables();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasReachEnd()

bool gum::AbstractSimulator::hasReachEnd ( )

virtualinherited

Tests if end state has been reached.

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

Definition at line 79 of file abstractSimulator.cpp.

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

Referenced by gum::AbstractSimulator::setEndState(), and gum::AbstractSimulator::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()

void gum::FMDPSimulator::perform ( Idx  )

virtual

Sets the intial statefrom which we begun the simulation.

Implements gum::AbstractSimulator.

Definition at line 76 of file fmdpSimulator.cpp.

References gum::AbstractSimulator::_currentState, _transitionProbability(), gum::Instantiation::add(), beginVariables(), gum::Instantiation::chgVal(), gum::Instantiation::end(), endVariables(), gum::Instantiation::incOut(), primeVar(), gum::Instantiation::setFirstOut(), and gum::Instantiation::val().

Referenced by reward().

                                          {
    Instantiation newState;
    for (auto varIter = this->beginVariables(); varIter != this->endVariables();
         ++varIter) {
      newState.add(**varIter);
      Instantiation transit(_currentState);
      transit.add(*(this->primeVar(*varIter)));

      double proba = (double)std::rand() / (double)RAND_MAX;
      double cdd = 0.0;
      for (transit.setFirstOut(_currentState); !transit.end();
           transit.incOut(_currentState)) {
        cdd += this->_transitionProbability(*varIter, transit, actionId);
        if (proba <= cdd) {
          newState.chgVal(**varIter, transit.val(*(this->primeVar(*varIter))));
          break;
        }
      }
    }
    _currentState = newState;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

primeVar()

const DiscreteVariable* gum::FMDPSimulator::primeVar ( const DiscreteVariable *  mainVar )

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 85 of file fmdpSimulator.h.

References __fmdp, and gum::FMDP< GUM_SCALAR >::main2prime().

Referenced by perform().

                                                                      {
      return __fmdp->main2prime(mainVar);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reward()

double gum::FMDPSimulator::reward ( )

inlinevirtual

Sets the intial statefrom which we begun the simulation.

Implements gum::AbstractSimulator.

Definition at line 74 of file fmdpSimulator.h.

References __fmdp, gum::AbstractSimulator::_currentState, perform(), and gum::FMDP< GUM_SCALAR >::reward().

{ return __fmdp->reward()->get(this->_currentState); }

Here is the call graph for this function:

setEndState()

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

inlineinherited

Sets the final states upon which a run is over.

Definition at line 84 of file abstractSimulator.h.

References gum::AbstractSimulator::_endState, and gum::AbstractSimulator::hasReachEnd().

                                                           {
      _endState = endState;
    }

Here is the call graph for this function:

setInitialState()

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

inlineinherited

Sets the intial statefrom which we begun the simulation.

Definition at line 73 of file abstractSimulator.h.

References gum::AbstractSimulator::_currentState, gum::AbstractSimulator::_randomState(), and gum::AbstractSimulator::setInitialStateRandomly().

                                                                   {
      _currentState = initialState;
    }

Here is the call graph for this function:

setInitialStateRandomly()

void gum::AbstractSimulator::setInitialStateRandomly ( )

inherited

Sets the intial statefrom which we begun the simulation.

Definition at line 58 of file abstractSimulator.cpp.

References gum::AbstractSimulator::_currentState, gum::AbstractSimulator::_randomState(), and gum::AbstractSimulator::hasReachEnd().

Referenced by gum::AbstractSimulator::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

__fmdp

FMDP< double >* gum::FMDPSimulator::__fmdp

private

The Factored Markov Decision Process that describes how the system evolves.

Definition at line 125 of file fmdpSimulator.h.

Referenced by _transitionProbability(), actionName(), beginActions(), beginVariables(), endActions(), endVariables(), FMDPSimulator(), primeVar(), reward(), and ~FMDPSimulator().

__loaded

const bool gum::FMDPSimulator::__loaded

private

Just to know if it should be deleted in the end.

Definition at line 128 of file fmdpSimulator.h.

Referenced by ~FMDPSimulator().

_currentState

Instantiation gum::AbstractSimulator::_currentState

inherited

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(), gum::AbstractSimulator::currentState(), gum::AbstractSimulator::hasReachEnd(), perform(), gum::TaxiSimulator::perform(), reward(), gum::AbstractSimulator::setInitialState(), and gum::AbstractSimulator::setInitialStateRandomly().

_endState

Instantiation gum::AbstractSimulator::_endState

inherited

Definition at line 130 of file abstractSimulator.h.

Referenced by gum::AbstractSimulator::hasReachEnd(), and gum::AbstractSimulator::setEndState().

---

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

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