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

Detailed Description

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

Definition at line 51 of file variableselector.h.

Constructor & Destructor Documentation

VariableSelector()

gum::VariableSelector::VariableSelector

(

Set< const DiscreteVariable * > &

startingSet

)

Default constructor.

Definition at line 41 of file variableselector.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                                :
      _remainingVars_(startingSet) {
    GUM_CONSTRUCTOR(VariableSelector);
    _remainingScores_.insert(0.0, 0.0);
    _remainingVarsByScore_.insert(0.0, new Set< const DiscreteVariable* >(_remainingVars_));

    for (auto varIter = _remainingVars_.cbeginSafe(); varIter != _remainingVars_.cendSafe();
         ++varIter) {
      _remainingVarsScore_.insert(*varIter, 0.0);
      _remainingVarsOtherScore_.insert(*varIter, 0.0);
    }
  }

Here is the call graph for this function:

~VariableSelector()

gum::VariableSelector::~VariableSelector

(

)

Default destructor.

Definition at line 57 of file variableselector.cpp.

References gum::Set< Key, Alloc >::emplace().

                                      {
    GUM_DESTRUCTOR(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 113 of file variableselector.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                             {
    double varScore = _remainingVarsScore_[var];

    if (!_remainingVarsByScore_.exists(varScore)) {
      _remainingVarsByScore_.insert(varScore, new Set< const DiscreteVariable* >());
      _remainingScores_.insert(varScore, varScore);
    }
    _remainingVarsByScore_[varScore]->insert(var);
  }

Here is the call graph for this function:

_removeVar_()

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

private

The set of remaining vars to select among.

Definition at line 127 of file variableselector.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                                {
    double                          varScore = _remainingVarsScore_[var];
    Set< const DiscreteVariable* >* varSet   = _remainingVarsByScore_[varScore];
    *varSet >> var;
    if (varSet->empty()) {
      _remainingScores_.erase(varScore);
      _remainingVarsByScore_.erase(varScore);
      delete varSet;
    }
  }

Here is the call graph for this function:

begin()

void gum::VariableSelector::begin ( )

inline

The set of remaining vars to select among.

Definition at line 89 of file variableselector.h.

{ _rvi_ = _remainingVars_.beginSafe(); }

current()

const DiscreteVariable* gum::VariableSelector::current ( )

inline

The set of remaining vars to select among.

Definition at line 92 of file variableselector.h.

{ return *_rvi_; }

downdateScore()

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

The set of remaining vars to select among.

Definition at line 79 of file variableselector.cpp.

References gum::Set< Key, Alloc >::emplace().

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

Here is the call graph for this function:

hasNext()

bool gum::VariableSelector::hasNext ( )

inline

The set of remaining vars to select among.

Definition at line 90 of file variableselector.h.

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

isEmpty()

bool gum::VariableSelector::isEmpty ( )

inline

The set of remaining vars to select among.

Definition at line 87 of file variableselector.h.

{ return _remainingVars_.empty(); }

next()

void gum::VariableSelector::next ( )

inline

The set of remaining vars to select among.

Definition at line 91 of file variableselector.h.

{ ++_rvi_; }

select()

const DiscreteVariable * gum::VariableSelector::select

(

)

Select the most relevant variable.

Definition at line 92 of file variableselector.cpp.

References gum::Set< Key, Alloc >::emplace().

                                                   {
    double                          bestScore = _remainingScores_.top();
    Set< const DiscreteVariable* >* 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;
  }

Here is the call 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 66 of file variableselector.cpp.

References gum::Set< Key, Alloc >::emplace().

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

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

_remainingVars_

Set< const DiscreteVariable* > gum::VariableSelector::_remainingVars_

private

The set of remaining vars to select among.

Definition at line 99 of file variableselector.h.

_remainingVarsByScore_

HashTable< double, Set< const DiscreteVariable* >* > gum::VariableSelector::_remainingVarsByScore_

private

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

Definition at line 107 of file variableselector.h.

_remainingVarsOtherScore_

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

private

HashTable associating to each variable its 2nd score.

Definition at line 113 of file variableselector.h.

_remainingVarsScore_

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

private

HashTable associating to each variable its score.

Definition at line 110 of file variableselector.h.

_rvi_

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

private

The set of remaining vars to select among.

Definition at line 100 of file variableselector.h.

---

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

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