gum::VariableSelector Class Reference

<agrum/FMDP/planning/FunctionGraph/variableselector.h> More...

#include <variableselector.h>

Collaboration diagram for gum::VariableSelector:

Public Member Functions
Constructor & destructor.
	VariableSelector (const gum::VariableSet &startingSet)
	Default constructor.
	~VariableSelector ()
	Default destructor.
gum::VariableSet	_remainingVars_
	The set of remaining vars to select among.
SetIteratorSafe< const DiscreteVariable * >	_rvi_
	The set of remaining vars to select among.
MultiPriorityQueue< double, double, std::greater< double > >	_remainingScores_
	Heap keeping best score on top for immediate access.
HashTable< double, gum::VariableSet * >	_remainingVarsByScore_
	HashTable associating to each score the set of variable having that score.
HashTable< const DiscreteVariable *, double >	_remainingVarsScore_
	HashTable associating to each variable its score.
HashTable< const DiscreteVariable *, double >	_remainingVarsOtherScore_
	HashTable associating to each variable its 2nd score.
void	updateScore (const DiscreteVariable *var, double score, double secondaryscore)
	The set of remaining vars to select among.
void	downdateScore (const DiscreteVariable *var, double score, double secondaryscore)
	The set of remaining vars to select among.
const DiscreteVariable *	select ()
	Select the most relevant variable.
bool	isEmpty () const
	The set of remaining vars to select among.
void	begin ()
	The set of remaining vars to select among.
bool	hasNext () const
	The set of remaining vars to select among.
void	next ()
	The set of remaining vars to select among.
const DiscreteVariable *	current () const
	The set of remaining vars to select among.
void	_addVar_ (const DiscreteVariable *var)
	The set of remaining vars to select among.
void	_removeVar_ (const DiscreteVariable *var)
	The set of remaining vars to select among.

Detailed Description

<agrum/FMDP/planning/FunctionGraph/variableselector.h>

Definition at line 71 of file variableselector.h.

Constructor & Destructor Documentation

VariableSelector()

gum::VariableSelector::VariableSelector ( const gum::VariableSet & startingSet )

explicit

Default constructor.

Definition at line 66 of file variableselector.cpp.

                                                                      :
      _remainingVars_(startingSet) {
    GUM_CONSTRUCTOR(VariableSelector)
    _remainingScores_.insert(0.0, 0.0);
    _remainingVarsByScore_.insert(0.0, new gum::VariableSet(_remainingVars_));
 
    for (auto varIter = _remainingVars_.cbeginSafe(); varIter != _remainingVars_.cendSafe();
         ++varIter) {
      _remainingVarsScore_.insert(*varIter, 0.0);
      _remainingVarsOtherScore_.insert(*varIter, 0.0);
    }
  }

References VariableSelector(), _remainingScores_, _remainingVars_, _remainingVarsByScore_, _remainingVarsOtherScore_, and _remainingVarsScore_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

~VariableSelector()

gum::VariableSelector::~VariableSelector

(

)

Default destructor.

Definition at line 82 of file variableselector.cpp.

{ GUM_DESTRUCTOR(VariableSelector) }

References VariableSelector().

Here is the call graph for this function:

Member Function Documentation

_addVar_()

void gum::VariableSelector::_addVar_ ( const DiscreteVariable * var )

private

The set of remaining vars to select among.

Definition at line 131 of file variableselector.cpp.

                                                             {
    double varScore = _remainingVarsScore_[var];
 
    if (!_remainingVarsByScore_.exists(varScore)) {
      _remainingVarsByScore_.insert(varScore, new gum::VariableSet());
      _remainingScores_.insert(varScore, varScore);
    }
    _remainingVarsByScore_[varScore]->insert(var);
  }

References _remainingScores_, _remainingVarsByScore_, and _remainingVarsScore_.

Referenced by downdateScore(), and updateScore().

Here is the caller graph for this function:

_removeVar_()

void gum::VariableSelector::_removeVar_ ( const DiscreteVariable * var )

private

The set of remaining vars to select among.

Definition at line 144 of file variableselector.cpp.

                                                                {
    double            varScore = _remainingVarsScore_[var];
    gum::VariableSet* varSet   = _remainingVarsByScore_[varScore];
    *varSet >> var;
    if (varSet->empty()) {
      _remainingScores_.erase(varScore);
      _remainingVarsByScore_.erase(varScore);
      delete varSet;
    }
  }

References _remainingScores_, _remainingVarsByScore_, _remainingVarsScore_, and gum::Set< Key >::empty().

Referenced by downdateScore(), select(), and updateScore().

Here is the call graph for this function:

Here is the caller graph for this function:

begin()

INLINE void gum::VariableSelector::begin

(

)

The set of remaining vars to select among.

Definition at line 50 of file variableselector_inl.h.

{ _rvi_ = _remainingVars_.beginSafe(); }

References _remainingVars_, and _rvi_.

Referenced by gum::IMDDI< AttributeSelection, isScalar >::_updateNodeSet_(), and gum::IMDDI< AttributeSelection, isScalar >::updateGraph().

Here is the caller graph for this function:

current()

INLINE const DiscreteVariable * gum::VariableSelector::current

(

)

const

The set of remaining vars to select among.

Definition at line 56 of file variableselector_inl.h.

{ return *_rvi_; }

References _rvi_.

Referenced by gum::IMDDI< AttributeSelection, isScalar >::_updateNodeSet_(), and gum::IMDDI< AttributeSelection, isScalar >::updateGraph().

Here is the caller graph for this function:

downdateScore()

void gum::VariableSelector::downdateScore	(	const DiscreteVariable *	var,
		double	score,
		double	secondaryscore )

The set of remaining vars to select among.

Definition at line 99 of file variableselector.cpp.

                                                                               {
    _removeVar_(var);
    _remainingVarsScore_[var] -= score;
    _addVar_(var);
    _remainingVarsOtherScore_[var] -= secondaryscore;
  }

References _addVar_(), _remainingVarsOtherScore_, _remainingVarsScore_, and _removeVar_().

Referenced by gum::IMDDI< AttributeSelection, isScalar >::_downdateScore_().

Here is the call graph for this function:

Here is the caller graph for this function:

hasNext()

INLINE bool gum::VariableSelector::hasNext

(

)

const

The set of remaining vars to select among.

Definition at line 52 of file variableselector_inl.h.

{ return _rvi_ != _remainingVars_.endSafe(); }

References _remainingVars_, and _rvi_.

Referenced by gum::IMDDI< AttributeSelection, isScalar >::_updateNodeSet_(), and gum::IMDDI< AttributeSelection, isScalar >::updateGraph().

Here is the caller graph for this function:

isEmpty()

INLINE bool gum::VariableSelector::isEmpty

(

)

const

The set of remaining vars to select among.

Definition at line 48 of file variableselector_inl.h.

{ return _remainingVars_.empty(); }

References _remainingVars_.

Referenced by gum::IMDDI< AttributeSelection, isScalar >::updateGraph().

Here is the caller graph for this function:

next()

INLINE void gum::VariableSelector::next

(

)

The set of remaining vars to select among.

Definition at line 54 of file variableselector_inl.h.

{ ++_rvi_; }

References _rvi_.

Referenced by gum::IMDDI< AttributeSelection, isScalar >::_updateNodeSet_(), and gum::IMDDI< AttributeSelection, isScalar >::updateGraph().

Here is the caller graph for this function:

select()

const DiscreteVariable * gum::VariableSelector::select

(

)

Select the most relevant variable.

Definition at line 111 of file variableselector.cpp.

                                                   {
    double                  bestScore = _remainingScores_.top();
    const gum::VariableSet* bestSet   = _remainingVarsByScore_[bestScore];
    const DiscreteVariable* bestVar   = nullptr;
 
    for (auto varIter = bestSet->beginSafe(); varIter != bestSet->endSafe(); ++varIter) {
      if (bestVar == nullptr
          || _remainingVarsOtherScore_[bestVar] < _remainingVarsOtherScore_[*varIter]
          || (_remainingVarsOtherScore_[bestVar] == _remainingVarsOtherScore_[*varIter]
              && bestVar->domainSize() < (*varIter)->domainSize()))
        bestVar = *varIter;
    }
    _removeVar_(bestVar);
    _remainingVars_ >> bestVar;
    return bestVar;
  }

References _remainingScores_, _remainingVars_, _remainingVarsByScore_, _remainingVarsOtherScore_, _removeVar_(), gum::Set< Key >::beginSafe(), gum::DiscreteVariable::domainSize(), and gum::Set< Key >::endSafe().

Referenced by gum::IMDDI< AttributeSelection, isScalar >::updateGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

updateScore()

void gum::VariableSelector::updateScore	(	const DiscreteVariable *	var,
		double	score,
		double	secondaryscore )

The set of remaining vars to select among.

Definition at line 87 of file variableselector.cpp.

                                                                             {
    _removeVar_(var);
    _remainingVarsScore_[var] += score;
    _addVar_(var);
    _remainingVarsOtherScore_[var] += secondaryscore;
  }

References _addVar_(), _remainingVarsOtherScore_, _remainingVarsScore_, and _removeVar_().

Referenced by gum::IMDDI< AttributeSelection, isScalar >::_updateScore_().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_remainingScores_

MultiPriorityQueue< double, double, std::greater< double > > gum::VariableSelector::_remainingScores_

private

Heap keeping best score on top for immediate access.

Definition at line 126 of file variableselector.h.

Referenced by VariableSelector(), _addVar_(), _removeVar_(), and select().

_remainingVars_

gum::VariableSet gum::VariableSelector::_remainingVars_

private

The set of remaining vars to select among.

Definition at line 122 of file variableselector.h.

Referenced by VariableSelector(), begin(), hasNext(), isEmpty(), and select().

_remainingVarsByScore_

HashTable< double, gum::VariableSet* > gum::VariableSelector::_remainingVarsByScore_

private

HashTable associating to each score the set of variable having that score.

Definition at line 130 of file variableselector.h.

Referenced by VariableSelector(), _addVar_(), _removeVar_(), and select().

_remainingVarsOtherScore_

HashTable< const DiscreteVariable*, double > gum::VariableSelector::_remainingVarsOtherScore_

private

HashTable associating to each variable its 2nd score.

Definition at line 136 of file variableselector.h.

Referenced by VariableSelector(), downdateScore(), select(), and updateScore().

_remainingVarsScore_

HashTable< const DiscreteVariable*, double > gum::VariableSelector::_remainingVarsScore_

private

HashTable associating to each variable its score.

Definition at line 133 of file variableselector.h.

Referenced by VariableSelector(), _addVar_(), _removeVar_(), downdateScore(), and updateScore().

_rvi_

SetIteratorSafe< const DiscreteVariable* > gum::VariableSelector::_rvi_

private

The set of remaining vars to select among.

Definition at line 123 of file variableselector.h.

Referenced by begin(), current(), hasNext(), and next().

---

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

• agrum/FMDP/learning/datastructure/variableselector.h
• agrum/FMDP/learning/datastructure/variableselector.cpp
• agrum/FMDP/learning/datastructure/variableselector_inl.h