<agrum/FMDP/learning/datastructure/nodeDatabase.h> More...

#include <nodeDatabase.h>

Collaboration diagram for gum::NodeDatabase< AttributeSelection, isScalar >:

Public Member Functions
Idx	effectif (Idx moda) const

Idx	valueDomain () const

Constructor & destructor.
	NodeDatabase (const Set< const DiscreteVariable * > , const DiscreteVariable =nullptr)
	Default constructor. More...

	~NodeDatabase ()
	Default destructor. More...

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

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

Variable Test Methods
INLINE bool	isTestRelevant (const DiscreteVariable *var) const
	Indicates wether or not, node has sufficient observation so that any statistic is relevant. More...

INLINE double	testValue (const DiscreteVariable *var) const
	Returns the performance of given variables according to selection criterion. More...

INLINE double	testOtherCriterion (const DiscreteVariable *var) const
	Returns the performance of given variables according to selection secondary criterion (to break ties) More...

Aggregation Methods
NodeDatabase< AttributeSelection, isScalar > &	operator+= (const NodeDatabase< AttributeSelection, isScalar > &src)
	Merges given NodeDatabase informations into current nDB. More...

const TestPolicy< ValueType > *	testPolicy (const DiscreteVariable *var) const
	Returns a reference to nDB test policy for given variable (so that test policy information can be merged too) More...

const HashTableConstIteratorSafe< ValueType, Idx >	cbeginValues () const
	Iterators on value count to recopy correctly its content. More...

const HashTableConstIteratorSafe< ValueType, Idx >	cendValues () const
	Merges given NodeDatabase informations into current nDB. More...

Observation handling methods
void	addObservation (const Observation *)
	Nb observation taken into account by this instance. More...

INLINE Idx	nbObservation () const
	Nb observation taken into account by this instance. More...

void	__addObservation (const Observation *, Int2Type< true >)
	Updates database with new observation. More...

void	__addObservation (const Observation *, Int2Type< false >)
	depending on if we're learning reward function or transition probability More...

Detailed Description

template<TESTNAME AttributeSelection, bool isScalar>
class gum::NodeDatabase< AttributeSelection, isScalar >

Definition at line 55 of file nodeDatabase.h.

Member Typedef Documentation

◆ TestPolicy

template<TESTNAME AttributeSelection, bool isScalar>

template<typename GUM_SCALAR >

using gum::NodeDatabase< AttributeSelection, isScalar >::TestPolicy = typename TestSelect< AttributeSelection, GTestPolicy< GUM_SCALAR >, Chi2TestPolicy< GUM_SCALAR >, LeastSquareTestPolicy< GUM_SCALAR > >::type

private

Definition at line 63 of file nodeDatabase.h.

◆ ValueType

template<TESTNAME AttributeSelection, bool isScalar>

typedef ValueSelect< isScalar, double, Idx >::type gum::NodeDatabase< AttributeSelection, isScalar >::ValueType

private

Definition at line 56 of file nodeDatabase.h.

Constructor & Destructor Documentation

◆ NodeDatabase()

template<TESTNAME AttributeSelection, bool isScalar>

gum::NodeDatabase< AttributeSelection, isScalar >::NodeDatabase	(	const Set< const DiscreteVariable * > *	attrSet,
		const DiscreteVariable *	value = `nullptr`
	)

Default constructor.

Definition at line 40 of file nodeDatabase_tpl.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable, gum::NodeDatabase< AttributeSelection, isScalar >::__nbObservation, gum::Set< Key, Alloc >::cbeginSafe(), and gum::Set< Key, Alloc >::cendSafe().

                                                   :
       __value(value) {
     GUM_CONSTRUCTOR(NodeDatabase);
 
     for (SetIteratorSafe< const DiscreteVariable* > varIter =
             attrSet->cbeginSafe();
          varIter != attrSet->cendSafe();
          ++varIter)
       __attrTable.insert(*varIter, new TestPolicy< ValueType >());
 
     __nbObservation = 0;
   }

Here is the call graph for this function:

◆ ~NodeDatabase()

template<TESTNAME AttributeSelection, bool isScalar>

gum::NodeDatabase< AttributeSelection, isScalar >::~NodeDatabase ( )

Default destructor.

Definition at line 60 of file nodeDatabase_tpl.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable.

                                                               {
     for (auto varIter = __attrTable.beginSafe(); varIter != __attrTable.endSafe();
          ++varIter)
       delete varIter.val();
 
     GUM_DESTRUCTOR(NodeDatabase);
   }

Member Function Documentation

◆ __addObservation() [1/2]

template<TESTNAME AttributeSelection, bool isScalar>

void gum::NodeDatabase< AttributeSelection, isScalar >::__addObservation	(	const Observation *	newObs,
		Int2Type< true >
	)

private

Updates database with new observation.

Calls either or

Definition at line 89 of file nodeDatabase_tpl.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable, gum::NodeDatabase< AttributeSelection, isScalar >::__valueCount, gum::Observation::reward(), and gum::Observation::rModality().

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::addObservation(), and gum::NodeDatabase< AttributeSelection, isScalar >::operator delete().

                                                   {
     for (auto varIter = __attrTable.cbeginSafe();
          varIter != __attrTable.cendSafe();
          ++varIter)
       varIter.val()->addObservation(newObs->rModality(varIter.key()),
                                     newObs->reward());
 
     if (__valueCount.exists(newObs->reward()))
       __valueCount[newObs->reward()]++;
     else
       __valueCount.insert(newObs->reward(), 1);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __addObservation() [2/2]

template<TESTNAME AttributeSelection, bool isScalar>

void gum::NodeDatabase< AttributeSelection, isScalar >::__addObservation	(	const Observation *	newObs,
		Int2Type< false >
	)

private

depending on if we're learning reward function or transition probability

Definition at line 104 of file nodeDatabase_tpl.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable, gum::NodeDatabase< AttributeSelection, isScalar >::__value, gum::NodeDatabase< AttributeSelection, isScalar >::__valueCount, gum::Observation::modality(), and gum::NodeDatabase< AttributeSelection, isScalar >::operator+=().

                                                    {
     for (auto varIter = __attrTable.cbeginSafe();
          varIter != __attrTable.cendSafe();
          ++varIter)
       varIter.val()->addObservation(newObs->modality(varIter.key()),
                                     newObs->modality(__value));
 
     if (__valueCount.exists(newObs->modality(__value)))
       __valueCount[newObs->modality(__value)]++;
     else
       __valueCount.insert(newObs->modality(__value), 1);
   }

Here is the call graph for this function:

◆ __valueDomain() [1/2]

template<TESTNAME AttributeSelection, bool isScalar>

Idx gum::NodeDatabase< AttributeSelection, isScalar >::__valueDomain ( Int2Type< true > ) const

inlineprivate

Definition at line 195 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__valueCount.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::valueDomain().

195 { return __valueCount.size(); }

gum::NodeDatabase::__valueCount

HashTable< ValueType, Idx > __valueCount

Definition: nodeDatabase.h:211

Here is the caller graph for this function:

◆ __valueDomain() [2/2]

template<TESTNAME AttributeSelection, bool isScalar>

Idx gum::NodeDatabase< AttributeSelection, isScalar >::__valueDomain ( Int2Type< false > ) const

inlineprivate

Definition at line 196 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__value, gum::DiscreteVariable::domainSize(), and gum::NodeDatabase< AttributeSelection, isScalar >::toString().

196 { return __value->domainSize(); }

gum::NodeDatabase::__value

const DiscreteVariable * __value

So does this reference on the value observed.

Definition: nodeDatabase.h:205

gum::DiscreteVariable::domainSize

virtual Size domainSize() const =0

Here is the call graph for this function:

◆ addObservation()

template<TESTNAME AttributeSelection, bool isScalar>

void gum::NodeDatabase< AttributeSelection, isScalar >::addObservation ( const Observation * newObs )

Nb observation taken into account by this instance.

Definition at line 82 of file nodeDatabase_tpl.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__addObservation(), and gum::NodeDatabase< AttributeSelection, isScalar >::__nbObservation.

Referenced by gum::IncrementalGraphLearner< AttributeSelection, isScalar >::_transpose(), and gum::NodeDatabase< AttributeSelection, isScalar >::operator delete().

                                 {
     __nbObservation++;
     this->__addObservation(newObs, Int2Type< isScalar >());
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cbeginValues()

template<TESTNAME AttributeSelection, bool isScalar>

const HashTableConstIteratorSafe< ValueType, Idx > gum::NodeDatabase< AttributeSelection, isScalar >::cbeginValues ( ) const

inline

Iterators on value count to recopy correctly its content.

Definition at line 174 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__valueCount.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::operator+=().

                                                                             {
       return __valueCount.cbeginSafe();
     }

Here is the caller graph for this function:

◆ cendValues()

template<TESTNAME AttributeSelection, bool isScalar>

const HashTableConstIteratorSafe< ValueType, Idx > gum::NodeDatabase< AttributeSelection, isScalar >::cendValues ( ) const

inline

Merges given NodeDatabase informations into current nDB.

Definition at line 177 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__valueCount.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::operator+=().

                                                                           {
       return __valueCount.cendSafe();
     }

Here is the caller graph for this function:

◆ effectif()

template<TESTNAME AttributeSelection, bool isScalar>

Idx gum::NodeDatabase< AttributeSelection, isScalar >::effectif ( Idx moda ) const

inline

Definition at line 187 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__valueCount.

                                  {
       return __valueCount.exists(ValueType(moda)) ? __valueCount[ValueType(moda)]
                                                   : 0;
     }

◆ isTestRelevant()

template<TESTNAME AttributeSelection, bool isScalar>

INLINE bool gum::NodeDatabase< AttributeSelection, isScalar >::isTestRelevant ( const DiscreteVariable * var ) const

inline

Indicates wether or not, node has sufficient observation so that any statistic is relevant.

Definition at line 130 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable.

                                                                   {
       return __attrTable[var]->isTestRelevant();
     }

◆ nbObservation()

template<TESTNAME AttributeSelection, bool isScalar>

INLINE Idx gum::NodeDatabase< AttributeSelection, isScalar >::nbObservation ( ) const

inline

Nb observation taken into account by this instance.

Definition at line 117 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__nbObservation.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::operator+=(), and gum::NodeDatabase< AttributeSelection, isScalar >::toString().

117 { return __nbObservation; }

gum::NodeDatabase::__nbObservation

Idx __nbObservation

Definition: nodeDatabase.h:208

Here is the caller graph for this function:

◆ operator delete()

template<TESTNAME AttributeSelection, bool isScalar>

void gum::NodeDatabase< AttributeSelection, isScalar >::operator delete ( void * p )

inline

Default constructor.

Definition at line 88 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__addObservation(), gum::NodeDatabase< AttributeSelection, isScalar >::addObservation(), gum::SmallObjectAllocator::deallocate(), and gum::SmallObjectAllocator::instance().

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

Here is the call graph for this function:

◆ operator new()

template<TESTNAME AttributeSelection, bool isScalar>

void* gum::NodeDatabase< AttributeSelection, isScalar >::operator new ( size_t s )

inline

Allocators and Deallocators redefinition.

Definition at line 85 of file nodeDatabase.h.

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

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

Here is the call graph for this function:

◆ operator+=()

template<TESTNAME AttributeSelection, bool isScalar>

NodeDatabase< AttributeSelection, isScalar > & gum::NodeDatabase< AttributeSelection, isScalar >::operator+= ( const NodeDatabase< AttributeSelection, isScalar > & src )

Merges given NodeDatabase informations into current nDB.

Definition at line 130 of file nodeDatabase_tpl.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable, gum::NodeDatabase< AttributeSelection, isScalar >::__nbObservation, gum::NodeDatabase< AttributeSelection, isScalar >::__valueCount, gum::NodeDatabase< AttributeSelection, isScalar >::cbeginValues(), gum::NodeDatabase< AttributeSelection, isScalar >::cendValues(), gum::NodeDatabase< AttributeSelection, isScalar >::nbObservation(), and gum::NodeDatabase< AttributeSelection, isScalar >::testPolicy().

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

                                                                             {
     this->__nbObservation += src.nbObservation();
 
     for (auto varIter = __attrTable.beginSafe(); varIter != __attrTable.endSafe();
          ++varIter)
       varIter.val()->add(*(src.testPolicy(varIter.key())));
 
     for (auto valIter = src.cbeginValues(); valIter != src.cendValues(); ++valIter)
       if (__valueCount.exists(valIter.key()))
         __valueCount[valIter.key()] += valIter.val();
       else
         __valueCount.insert(valIter.key(), valIter.val());
 
     return *this;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ testOtherCriterion()

template<TESTNAME AttributeSelection, bool isScalar>

INLINE double gum::NodeDatabase< AttributeSelection, isScalar >::testOtherCriterion ( const DiscreteVariable * var ) const

inline

Returns the performance of given variables according to selection secondary criterion (to break ties)

Definition at line 146 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable, and gum::NodeDatabase< AttributeSelection, isScalar >::operator+=().

                                                                         {
       return __attrTable[var]->secondaryscore();
     }

Here is the call graph for this function:

◆ testPolicy()

template<TESTNAME AttributeSelection, bool isScalar>

const TestPolicy< ValueType >* gum::NodeDatabase< AttributeSelection, isScalar >::testPolicy ( const DiscreteVariable * var ) const

inline

Returns a reference to nDB test policy for given variable (so that test policy information can be merged too)

Definition at line 167 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::operator+=().

                                                                                  {
       return __attrTable[var];
     }

Here is the caller graph for this function:

◆ testValue()

template<TESTNAME AttributeSelection, bool isScalar>

INLINE double gum::NodeDatabase< AttributeSelection, isScalar >::testValue ( const DiscreteVariable * var ) const

inline

Returns the performance of given variables according to selection criterion.

Definition at line 138 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable.

                                                                {
       return __attrTable[var]->score();
     }

◆ toString()

template<TESTNAME AttributeSelection, bool isScalar>

std::string gum::NodeDatabase< AttributeSelection, isScalar >::toString ( ) const

private

Definition at line 148 of file nodeDatabase_tpl.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable, and gum::NodeDatabase< AttributeSelection, isScalar >::nbObservation().

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::__valueDomain().

                                                                          {
     std::stringstream ss;
 
     ss << "NbObservation : " << this->nbObservation() << std::endl;
     for (auto varIter = __attrTable.beginSafe(); varIter != __attrTable.endSafe();
          ++varIter)
       ss << "\t\tVariable : " << varIter.key()->name()
          << " - Associated Test : " << __attrTable[varIter.key()]->toString()
          << std::endl;
 
     return ss.str();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ valueDomain()

template<TESTNAME AttributeSelection, bool isScalar>

Idx gum::NodeDatabase< AttributeSelection, isScalar >::valueDomain ( ) const

inline

Definition at line 192 of file nodeDatabase.h.

References gum::NodeDatabase< AttributeSelection, isScalar >::__valueDomain().

192 { return __valueDomain(Int2Type< isScalar >()); }

gum::NodeDatabase::__valueDomain

Idx __valueDomain(Int2Type< true >) const

Definition: nodeDatabase.h:195

Here is the call graph for this function:

Member Data Documentation

◆ __attrTable

template<TESTNAME AttributeSelection, bool isScalar>

HashTable< const DiscreteVariable*, TestPolicy< ValueType >* > gum::NodeDatabase< AttributeSelection, isScalar >::__attrTable

private

Table giving for every variables its instantiation.

Definition at line 202 of file nodeDatabase.h.

◆ __nbObservation

template<TESTNAME AttributeSelection, bool isScalar>

Idx gum::NodeDatabase< AttributeSelection, isScalar >::__nbObservation

private

Definition at line 208 of file nodeDatabase.h.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::addObservation(), gum::NodeDatabase< AttributeSelection, isScalar >::nbObservation(), gum::NodeDatabase< AttributeSelection, isScalar >::NodeDatabase(), and gum::NodeDatabase< AttributeSelection, isScalar >::operator+=().

◆ __value

template<TESTNAME AttributeSelection, bool isScalar>

const DiscreteVariable* gum::NodeDatabase< AttributeSelection, isScalar >::__value

private

So does this reference on the value observed.

Definition at line 205 of file nodeDatabase.h.

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

◆ __valueCount

template<TESTNAME AttributeSelection, bool isScalar>

HashTable< ValueType, Idx > gum::NodeDatabase< AttributeSelection, isScalar >::__valueCount

private

Definition at line 211 of file nodeDatabase.h.

Referenced by gum::NodeDatabase< AttributeSelection, isScalar >::__addObservation(), gum::NodeDatabase< AttributeSelection, isScalar >::__valueDomain(), gum::NodeDatabase< AttributeSelection, isScalar >::cbeginValues(), gum::NodeDatabase< AttributeSelection, isScalar >::cendValues(), gum::NodeDatabase< AttributeSelection, isScalar >::effectif(), and gum::NodeDatabase< AttributeSelection, isScalar >::operator+=().

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

agrum/FMDP/learning/datastructure/nodeDatabase.h
agrum/FMDP/learning/datastructure/nodeDatabase_tpl.h

Public Member Functions

Observation handling methods

Detailed Description

template<TESTNAME AttributeSelection, bool isScalar> class gum::NodeDatabase< AttributeSelection, isScalar >

Member Typedef Documentation

◆ TestPolicy

◆ ValueType

Constructor & Destructor Documentation

◆ NodeDatabase()

◆ ~NodeDatabase()

Member Function Documentation

◆ __addObservation() [1/2]

◆ __addObservation() [2/2]

◆ __valueDomain() [1/2]

◆ __valueDomain() [2/2]

◆ addObservation()

◆ cbeginValues()

◆ cendValues()

◆ effectif()

◆ isTestRelevant()

◆ nbObservation()

◆ operator delete()

◆ operator new()

◆ operator+=()

◆ testOtherCriterion()

◆ testPolicy()

◆ testValue()

◆ toString()

◆ valueDomain()

Member Data Documentation

◆ __attrTable

◆ __nbObservation

◆ __value

◆ __valueCount

template<TESTNAME AttributeSelection, bool isScalar>
class gum::NodeDatabase< AttributeSelection, isScalar >