#include <agrum/FMDP/learning/observation.h>

Collaboration diagram for gum::Observation:

Public Member Functions
std::string	toString () const

Constructor & destructor.
	Observation ()
	Default constructor. More...

	~Observation ()
	Default destructor. More...

void *	operator new (size_t s)
	Allocators and Deallocators redefinition. More...

void	operator delete (void *p)
	Default constructor. More...

Observation Handlers
INLINE Idx	modality (const DiscreteVariable *var) const
	Returns the modality assumed by the given variable in this observation. More...

INLINE Idx	rModality (const DiscreteVariable *var) const
	Returns the modality assumed by the given variable in this observation. More...

INLINE void	setModality (const DiscreteVariable *var, Idx modality)
	Sets the modality assumed by the given variable in this observation. More...

INLINE void	setRModality (const DiscreteVariable *var, Idx modality)
	Returns the modality assumed by the given variable in this observation. More...

double	reward () const
	Returns the modality assumed by the given variable in this observation. More...

void	setReward (double reward)
	Returns the modality assumed by the given variable in this observation. More...

Iterators on Variables
HashTableConstIteratorSafe< const DiscreteVariable *, Idx >	cbeginVariablesSafe () const
	Returns an const safe iterator on the beginning of the list of variables in this observation. More...

HashTableConstIteratorSafe< const DiscreteVariable *, Idx >	cendVariablesSafe () const
	Returns an const safe iterator on the end of the list of variables in this observation. More...

Detailed Description

Definition at line 50 of file observation.h.

Constructor & Destructor Documentation

◆ Observation()

gum::Observation::Observation ( )

inline

Default constructor.

Definition at line 60 of file observation.h.

60 { GUM_CONSTRUCTOR(Observation); }

gum::Observation::Observation

Observation()

Default constructor.

Definition: observation.h:60

◆ ~Observation()

gum::Observation::~Observation ( )

inline

Default destructor.

Definition at line 65 of file observation.h.

65 { GUM_DESTRUCTOR(Observation); }

gum::Observation::Observation

Observation()

Default constructor.

Definition: observation.h:60

Member Function Documentation

◆ cbeginVariablesSafe()

HashTableConstIteratorSafe< const DiscreteVariable*, Idx > gum::Observation::cbeginVariablesSafe ( ) const

inline

Returns an const safe iterator on the beginning of the list of variables in this observation.

Definition at line 137 of file observation.h.

References __varInst.

                                    {
       return __varInst.cbeginSafe();
     }

◆ cendVariablesSafe()

HashTableConstIteratorSafe< const DiscreteVariable*, Idx > gum::Observation::cendVariablesSafe ( ) const

inline

Returns an const safe iterator on the end of the list of variables in this observation.

Definition at line 146 of file observation.h.

References __varInst.

                                  {
       return __varInst.cendSafe();
     }

◆ modality()

INLINE Idx gum::Observation::modality ( const DiscreteVariable * var ) const

inline

Returns the modality assumed by the given variable in this observation.

Exceptions

NotFound if variable is not in this observation

Definition at line 91 of file observation.h.

References __varInst.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::__addObservation(), gum::IncrementalGraphLearner< AttributeSelection, isScalar >::__assumeValue(), and gum::IncrementalGraphLearner< AttributeSelection, isScalar >::__branchObs().

                                                            {
       return __varInst[var];
     }

Here is the caller graph for this function:

◆ operator delete()

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

inline

Default constructor.

Definition at line 73 of file observation.h.

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

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

Here is the call graph for this function:

◆ operator new()

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

inline

Allocators and Deallocators redefinition.

Definition at line 70 of file observation.h.

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

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

Here is the call graph for this function:

◆ reward()

double gum::Observation::reward ( ) const

inline

Returns the modality assumed by the given variable in this observation.

Exceptions

NotFound if variable is not in this observation

Definition at line 116 of file observation.h.

References __reward.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::__addObservation(), gum::IncrementalGraphLearner< AttributeSelection, isScalar >::__assumeValue(), gum::FMDPLearner< VariableAttributeSelection, RewardAttributeSelection, LearnerSelection >::addObservation(), and setReward().

116 { return __reward; }

gum::Observation::__reward

double __reward

The reward associated to this transition.

Definition: observation.h:158

Here is the caller graph for this function:

◆ rModality()

INLINE Idx gum::Observation::rModality ( const DiscreteVariable * var ) const

inline

Returns the modality assumed by the given variable in this observation.

Exceptions

NotFound if variable is not in this observation

Definition at line 94 of file observation.h.

References __rInst.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::__addObservation(), and gum::IncrementalGraphLearner< AttributeSelection, isScalar >::__branchObs().

                                                             {
       return __rInst[var];
     }

Here is the caller graph for this function:

◆ setModality()

INLINE void gum::Observation::setModality	(	const DiscreteVariable *	var,
		Idx	modality
	)

inline

Sets the modality assumed by the given variable in this observation.

Exceptions

DuplicateElement if a value has already be assigned to this variable

Definition at line 106 of file observation.h.

References __varInst.

Referenced by gum::SDYNA::feedback().

                                                                        {
       __varInst.insert(var, modality);
     }

Here is the caller graph for this function:

◆ setReward()

void gum::Observation::setReward ( double reward )

inline

Returns the modality assumed by the given variable in this observation.

Exceptions

NotFound if variable is not in this observation

Definition at line 121 of file observation.h.

References __reward, reward(), and toString().

Referenced by gum::SDYNA::feedback().

121 { __reward = reward; }

gum::Observation::__reward

double __reward

The reward associated to this transition.

Definition: observation.h:158

gum::Observation::reward

double reward() const

Returns the modality assumed by the given variable in this observation.

Definition: observation.h:116

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRModality()

INLINE void gum::Observation::setRModality	(	const DiscreteVariable *	var,
		Idx	modality
	)

inline

Returns the modality assumed by the given variable in this observation.

Exceptions

NotFound if variable is not in this observation

Definition at line 109 of file observation.h.

References __rInst.

Referenced by gum::SDYNA::feedback().

                                                                         {
       __rInst.insert(var, modality);
     }

Here is the caller graph for this function:

◆ toString()

std::string gum::Observation::toString ( ) const

Definition at line 25 of file observation.cpp.

References __rInst, and __varInst.

Referenced by setReward().

                                         {
     std::stringstream status;
     for (auto varIter = __varInst.beginSafe(); varIter != __varInst.endSafe();
          ++varIter)
       if (__rInst.exists(varIter.key()))
         status << "| " << varIter.key()->name() << " : " << varIter.val() << " -> "
                << __rInst[varIter.key()] << " |";
     status << std::endl;
     return status.str();
   }

Here is the caller graph for this function:

Member Data Documentation

◆ __reward

double gum::Observation::__reward

private

The reward associated to this transition.

Definition at line 158 of file observation.h.

Referenced by reward(), and setReward().

◆ __rInst

HashTable< const DiscreteVariable*, Idx > gum::Observation::__rInst

private

Definition at line 155 of file observation.h.

Referenced by rModality(), setRModality(), and toString().

◆ __varInst

HashTable< const DiscreteVariable*, Idx > gum::Observation::__varInst

private

Table giving for every variables its instantiation.

Definition at line 154 of file observation.h.

Referenced by cbeginVariablesSafe(), cendVariablesSafe(), modality(), setModality(), and toString().

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

agrum/FMDP/learning/observation.h
agrum/FMDP/learning/observation.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Observation()

◆ ~Observation()

Member Function Documentation

◆ cbeginVariablesSafe()

◆ cendVariablesSafe()

◆ modality()

◆ operator delete()

◆ operator new()

◆ reward()

◆ rModality()

◆ setModality()

◆ setReward()

◆ setRModality()

◆ toString()

Member Data Documentation

◆ __reward

◆ __rInst

◆ __varInst