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

Constructor & Destructor Documentation

VariableSelector()

gum::VariableSelector::VariableSelector

(

Set< const DiscreteVariable * > &

startingSet

)

Default constructor.

Definition at line 42 of file variableselector.cpp.

References __remainingScores, __remainingVars, __remainingVarsByScore, __remainingVarsOtherScore, __remainingVarsScore, and gum::MultiPriorityQueue< Val, Priority, Cmp, Alloc >::insert().

                                                                                :
      __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.

{ GUM_DESTRUCTOR(VariableSelector); }

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 __remainingScores, __remainingVarsByScore, __remainingVarsScore, and gum::MultiPriorityQueue< Val, Priority, Cmp, Alloc >::insert().

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

                                                             {
    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:

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 131 of file variableselector.cpp.

References __remainingScores, __remainingVarsByScore, __remainingVarsScore, gum::Set< Key, Alloc >::empty(), and gum::MultiPriorityQueue< Val, Priority, Cmp, Alloc >::erase().

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

                                                                {
    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:

Here is the caller graph for this function:

begin()

void gum::VariableSelector::begin ( )

inline

The set of remaining vars to select among.

Definition at line 94 of file variableselector.h.

References __remainingVars, and __rvi.

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

{ __rvi = __remainingVars.beginSafe(); }

Here is the caller graph for this function:

current()

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

inline

The set of remaining vars to select among.

Definition at line 97 of file variableselector.h.

References __addVar(), __removeVar(), and __rvi.

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

{ return *__rvi; }

Here is the call graph for this function:

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 79 of file variableselector.cpp.

References __addVar(), __remainingVarsOtherScore, __remainingVarsScore, and __removeVar().

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

                                                                               {
    __removeVar(var);
    __remainingVarsScore[var] -= score;
    __addVar(var);
    __remainingVarsOtherScore[var] -= secondaryscore;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

hasNext()

bool gum::VariableSelector::hasNext ( )

inline

The set of remaining vars to select among.

Definition at line 95 of file variableselector.h.

References __remainingVars, and __rvi.

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

{ return __rvi != __remainingVars.endSafe(); }

Here is the caller graph for this function:

isEmpty()

bool gum::VariableSelector::isEmpty ( )

inline

The set of remaining vars to select among.

Definition at line 92 of file variableselector.h.

References __remainingVars.

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

{ return __remainingVars.empty(); }

Here is the caller graph for this function:

next()

void gum::VariableSelector::next ( )

inline

The set of remaining vars to select among.

Definition at line 96 of file variableselector.h.

References __rvi.

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

{ ++__rvi; }

Here is the caller graph for this function:

select()

const DiscreteVariable * gum::VariableSelector::select

(

)

Select the most relevant variable.

Definition at line 92 of file variableselector.cpp.

References __remainingScores, __remainingVars, __remainingVarsByScore, __remainingVarsOtherScore, __removeVar(), gum::Set< Key, Alloc >::beginSafe(), gum::DiscreteVariable::domainSize(), gum::Set< Key, Alloc >::endSafe(), and gum::MultiPriorityQueue< Val, Priority, Cmp, Alloc >::top().

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

                                                   {
    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:

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 66 of file variableselector.cpp.

References __addVar(), __remainingVarsOtherScore, __remainingVarsScore, and __removeVar().

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

                                                                             {
    __removeVar(var);
    __remainingVarsScore[var] += score;
    __addVar(var);
    __remainingVarsOtherScore[var] += secondaryscore;
  }

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

Referenced by __addVar(), __removeVar(), select(), and VariableSelector().

__remainingVars

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

private

The set of remaining vars to select among.

Definition at line 104 of file variableselector.h.

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

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

Referenced by __addVar(), __removeVar(), select(), and VariableSelector().

__remainingVarsOtherScore

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

private

HashTable associating to each variable its 2nd score.

Definition at line 118 of file variableselector.h.

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

__remainingVarsScore

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

private

HashTable associating to each variable its score.

Definition at line 115 of file variableselector.h.

Referenced by __addVar(), __removeVar(), downdateScore(), updateScore(), and VariableSelector().

__rvi

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

private

The set of remaining vars to select among.

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