gum::AbstractSimulator Class Reference

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

#include <abstractSimulator.h>

Inheritance diagram for gum::AbstractSimulator:

Collaboration diagram for gum::AbstractSimulator:

Public Member Functions
Constructors, Destructors.
	AbstractSimulator ()
	Default constructor.
virtual	~AbstractSimulator ()
	Default destructor.
Variables
virtual const DiscreteVariable *	primeVar (const DiscreteVariable *mainVar)=0
	Iteration over the variables of the simulated probleme.
virtual SequenceIteratorSafe< const DiscreteVariable * >	beginVariables ()=0
	Iteration over the variables of the simulated probleme.
virtual SequenceIteratorSafe< const DiscreteVariable * >	endVariables ()=0
	Iteration over the variables of the simulated probleme.
Actions
virtual const std::string &	actionName (Idx)=0
	Iteration over the variables of the simulated probleme.
virtual SequenceIteratorSafe< Idx >	beginActions ()=0
	Iteration over the variables of the simulated probleme.
virtual SequenceIteratorSafe< Idx >	endActions ()=0
	Iteration over the variables of the simulated probleme.

Public Attributes
Instantiation	currentState_
	Tha state in which the system currently is.
Instantiation	endState_
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.
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.
const Instantiation &	currentState ()
	Sets the intial statefrom which we begun the simulation.
virtual double	reward ()=0
	Sets the intial statefrom which we begun the simulation.
virtual void	perform (Idx)=0
	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

<agrum/FMDP/simulation/abstractSimulator.h>

A class to simulate a reinforcement learning problem.

Definition at line 67 of file abstractSimulator.h.

Constructor & Destructor Documentation

AbstractSimulator()

gum::AbstractSimulator::AbstractSimulator

(

)

Default constructor.

Definition at line 69 of file abstractSimulator.cpp.

                                       {
    GUM_CONSTRUCTOR(AbstractSimulator);
    ;
  }

References AbstractSimulator().

Referenced by AbstractSimulator(), gum::FMDPSimulator::FMDPSimulator(), gum::FMDPSimulator::FMDPSimulator(), gum::TaxiSimulator::TaxiSimulator(), and ~AbstractSimulator().

Here is the call graph for this function:

Here is the caller graph for this function:

~AbstractSimulator()

gum::AbstractSimulator::~AbstractSimulator ( )

virtual

Default destructor.

Definition at line 77 of file abstractSimulator.cpp.

                                        {
    GUM_DESTRUCTOR(AbstractSimulator);
    ;
  }

References AbstractSimulator().

Here is the call graph for this function:

Member Function Documentation

actionName()

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

pure virtual

Iteration over the variables of the simulated probleme.

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

beginActions()

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

pure virtual

Iteration over the variables of the simulated probleme.

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

beginVariables()

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

pure virtual

Iteration over the variables of the simulated probleme.

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

Referenced by randomState_().

Here is the caller graph for this function:

currentState()

INLINE const Instantiation & gum::AbstractSimulator::currentState

(

)

Sets the intial statefrom which we begun the simulation.

Definition at line 56 of file abstractSimulator_inl.h.

{ return currentState_; }

References currentState_.

endActions()

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

pure virtual

Iteration over the variables of the simulated probleme.

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

endVariables()

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

pure virtual

Iteration over the variables of the simulated probleme.

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

Referenced by randomState_().

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 104 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()

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

pure virtual

Sets the intial statefrom which we begun the simulation.

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

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::FMDPSimulator, and gum::TaxiSimulator.

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 94 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()

virtual double gum::AbstractSimulator::reward ( )

pure virtual

Sets the intial statefrom which we begun the simulation.

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

setEndState()

INLINE void gum::AbstractSimulator::setEndState

(

const Instantiation &

endState

)

Sets the final states upon which a run is over.

Definition at line 52 of file abstractSimulator_inl.h.

                                                                          {
    endState_ = endState;
  }

References endState_.

setInitialState()

INLINE void gum::AbstractSimulator::setInitialState

(

const Instantiation &

initialState

)

Sets the intial statefrom which we begun the simulation.

Definition at line 48 of file abstractSimulator_inl.h.

                                                                                  {
    currentState_ = initialState;
  }

References currentState_.

setInitialStateRandomly()

void gum::AbstractSimulator::setInitialStateRandomly

(

)

Sets the intial statefrom which we begun the simulation.

Definition at line 86 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:

Member Data Documentation

currentState_

Instantiation gum::AbstractSimulator::currentState_

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_

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/abstractSimulator.h
• agrum/FMDP/simulation/abstractSimulator.cpp
• agrum/FMDP/simulation/abstractSimulator_inl.h