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 60 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 116 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:

begin()

void gum::VariableSelector::begin ( )

inline

The set of remaining vars to select among.

Definition at line 93 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 96 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 94 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 91 of file variableselector.h.

{ return remainingVars__.empty(); }

next()

void gum::VariableSelector::next ( )

inline

The set of remaining vars to select among.

Definition at line 95 of file variableselector.h.

{ ++rvi__; }

removeVar__()

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

private

The set of remaining vars to select among.

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

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 107 of file variableselector.h.

remainingVars__

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

private

The set of remaining vars to select among.

Definition at line 103 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 111 of file variableselector.h.

remainingVarsOtherScore__

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

private

HashTable associating to each variable its 2nd score.

Definition at line 117 of file variableselector.h.

remainingVarsScore__

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

private

HashTable associating to each variable its score.

Definition at line 114 of file variableselector.h.

rvi__

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

private

The set of remaining vars to select among.

Definition at line 104 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