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

#include <fmdpSimulator.h>

Inheritance diagram for gum::FMDPSimulator:

Collaboration diagram for gum::FMDPSimulator:

Public Member Functions
Constructors, Destructors.
	FMDPSimulator (const FMDP< double > *fmdp)
	Default constructor.
	FMDPSimulator (const std::string &resource)
	Default constructor.
	~FMDPSimulator ()
	Default destructor.

double	reward ()
	Sets the intial statefrom which we begun the simulation.
void	perform (Idx)
	Sets the intial statefrom which we begun the simulation.

const DiscreteVariable *	primeVar (const DiscreteVariable *mainVar)
	Iteration over the variables of the simulated probleme.
SequenceIteratorSafe< const DiscreteVariable * >	beginVariables ()
	Iteration over the variables of the simulated probleme.
SequenceIteratorSafe< const DiscreteVariable * >	endVariables ()
	Iteration over the variables of the simulated probleme.

virtual const std::string &	actionName (Idx actionId)
	Iteration over the variables of the simulated probleme.
SequenceIteratorSafe< Idx >	beginActions ()
	Iteration over the variables of the simulated probleme.
SequenceIteratorSafe< Idx >	endActions ()
	Iteration over the variables of the simulated probleme.

Public Attributes
Instantiation	currentState_
	Tha state in which the system currently is.
Instantiation	endState_

Protected Member Functions
virtual double	transitionProbability_ (const DiscreteVariable *var, const Instantiation &transit, Idx actionId)

Private Attributes
FMDP< double > *	_fmdp_
	The Factored Markov Decision Process that describes how the system evolves.
const bool	_loaded_
	Just to know if it should be deleted in the end.
INLINE void	setInitialState (const Instantiation &initialState)
	Sets the intial statefrom which we begun the simulation.
void	setInitialStateRandomly ()
	Sets the intial statefrom which we begun the simulation.
INLINE void	setEndState (const Instantiation &endState)
	Sets the final states upon which a run is over.
virtual bool	hasReachEnd ()
	Tests if end state has been reached.
INLINE const Instantiation &	currentState ()
	Sets the intial statefrom which we begun the simulation.
virtual Instantiation	randomState_ ()
	Choses a random state as the first test for a run.

Detailed Description

A class to simulate a Factored Markov Decision Process.

Definition at line 67 of file fmdpSimulator.h.

Constructor & Destructor Documentation

◆ FMDPSimulator() [1/2]

gum::FMDPSimulator::FMDPSimulator ( const FMDP< double > * fmdp )

Default constructor.

Definition at line 69 of file fmdpSimulator.cpp.

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

References gum::AbstractSimulator::AbstractSimulator(), FMDPSimulator(), _fmdp_, and _loaded_.

Referenced by FMDPSimulator(), FMDPSimulator(), and ~FMDPSimulator().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FMDPSimulator() [2/2]

gum::FMDPSimulator::FMDPSimulator ( const std::string & resource )

Default constructor.

Definition at line 74 of file fmdpSimulator.cpp.

                                                         : AbstractSimulator(), _loaded_(true) {
    GUM_CONSTRUCTOR(FMDPSimulator);
 
    _fmdp_ = new FMDP< double >(true);
    FMDPDatReader< double > reader(_fmdp_, ressource);
    reader.trace(false);
    reader.proceed();
  }

References gum::AbstractSimulator::AbstractSimulator(), FMDPSimulator(), _fmdp_, _loaded_, gum::FMDPDatReader< GUM_SCALAR >::proceed(), and gum::FMDPDatReader< GUM_SCALAR >::trace().

Here is the call graph for this function:

◆ ~FMDPSimulator()

gum::FMDPSimulator::~FMDPSimulator ( )

Default destructor.

Definition at line 86 of file fmdpSimulator.cpp.

                                {
    GUM_DESTRUCTOR(FMDPSimulator);
    if (_loaded_) delete _fmdp_;
  }

References FMDPSimulator(), _fmdp_, and _loaded_.

Here is the call graph for this function:

Member Function Documentation

◆ 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 124 of file fmdpSimulator.h.

124{ return _fmdp_->actionName(actionId); }

References _fmdp_.

◆ beginActions()

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

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 127 of file fmdpSimulator.h.

127{ return _fmdp_->beginActions(); }

References _fmdp_.

◆ beginVariables()

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

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 109 of file fmdpSimulator.h.

                                                                     {
      return _fmdp_->beginVariables();
    }

References _fmdp_.

Referenced by perform().

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 108 of file abstractSimulator.h.

108{ return currentState_; }

gum::AbstractSimulator::currentState_

Instantiation currentState_

Tha state in which the system currently is.

Definition abstractSimulator.h:146

References currentState_.

◆ endActions()

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

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 129 of file fmdpSimulator.h.

129{ return _fmdp_->endActions(); }

References _fmdp_.

◆ endVariables()

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

inlinevirtual

Iteration over the variables of the simulated probleme.

Implements gum::AbstractSimulator.

Definition at line 113 of file fmdpSimulator.h.

                                                                   {
      return _fmdp_->endVariables();
    }

References _fmdp_.

Referenced by perform().

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 100 of file abstractSimulator.cpp.

                                      {
    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;
  }

References currentState_, and endState_.

Referenced by setInitialStateRandomly().

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 95 of file fmdpSimulator.cpp.

                                          {
    Instantiation newState;
    for (auto varIter = this->beginVariables(); varIter != this->endVariables(); ++varIter) {
      newState.add(**varIter);
      Instantiation transit(currentState_);
      transit.add(*(this->primeVar(*varIter)));
 
      double proba = randomProba();
      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;
  }

References gum::Instantiation::add(), beginVariables(), gum::Instantiation::chgVal(), gum::AbstractSimulator::currentState_, gum::Instantiation::end(), endVariables(), gum::Instantiation::incOut(), primeVar(), gum::randomProba(), gum::Instantiation::setFirstOut(), transitionProbability_(), and gum::Instantiation::val().

Here is the call 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 104 of file fmdpSimulator.h.

                                                                      {
      return _fmdp_->main2prime(mainVar);
    }

References _fmdp_.

Referenced by perform().

Here is the caller graph for this function:

◆ 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 90 of file abstractSimulator.cpp.

                                                {
    Instantiation retState;
    for (auto varIter = this->beginVariables(); varIter != this->endVariables(); ++varIter) {
      retState.add(**varIter);
      retState.chgVal(**varIter, randomValue((*varIter)->domainSize()));
    }
    return retState;
  }

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

Referenced by gum::TaxiSimulator::randomState_(), and setInitialStateRandomly().

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 93 of file fmdpSimulator.h.

93{ return _fmdp_->reward()->get(this->currentState_); }

References _fmdp_, and gum::AbstractSimulator::currentState_.

◆ setEndState()

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

inlineinherited

Sets the final states upon which a run is over.

Definition at line 102 of file abstractSimulator.h.

102{ endState_ = endState; }

References endState_.

◆ setInitialState()

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

inlineinherited

Sets the intial statefrom which we begun the simulation.

Definition at line 92 of file abstractSimulator.h.

92{ currentState_ = initialState; }

References currentState_.

◆ setInitialStateRandomly()

void gum::AbstractSimulator::setInitialStateRandomly ( )

inherited

Sets the intial statefrom which we begun the simulation.

Definition at line 82 of file abstractSimulator.cpp.

                                                  {
    bool hre = true;
    while (hre) {
      currentState_ = randomState_();
      hre           = hasReachEnd();
    }
  }

References currentState_, hasReachEnd(), and randomState_().

Here is the call graph for this function:

◆ transitionProbability_()

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

inlineprotectedvirtual

Definition at line 134 of file fmdpSimulator.h.

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

References _fmdp_, and gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >::get().

Referenced by perform().

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 145 of file fmdpSimulator.h.

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

◆ _loaded_

const bool gum::FMDPSimulator::_loaded_

private

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

Definition at line 148 of file fmdpSimulator.h.

Referenced by FMDPSimulator(), FMDPSimulator(), and ~FMDPSimulator().

◆ currentState_

Instantiation gum::AbstractSimulator::currentState_

inherited

Tha state in which the system currently is.

Definition at line 146 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_

inherited

Definition at line 146 of file abstractSimulator.h.

Referenced by hasReachEnd(), and setEndState().

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FMDPSimulator() [1/2]

◆ FMDPSimulator() [2/2]

◆ ~FMDPSimulator()

Member Function Documentation

◆ actionName()

◆ beginActions()

◆ beginVariables()

◆ currentState()

◆ endActions()

◆ endVariables()

◆ hasReachEnd()

◆ perform()

◆ primeVar()

◆ randomState_()

◆ reward()

◆ setEndState()

◆ setInitialState()

◆ setInitialStateRandomly()

◆ transitionProbability_()

Member Data Documentation

◆ _fmdp_

◆ _loaded_

◆ currentState_

◆ endState_