<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 gum::VariableSet , const DiscreteVariable =nullptr)
	Default constructor.
	~NodeDatabase ()
	Default destructor.
void *	operator new (size_t s)
	Allocators and Deallocators redefinition.
void	operator delete (void *p)
	Default constructor.
Variable Test Methods
INLINE bool	isTestRelevant (const DiscreteVariable *var) const
	Indicates wether or not, node has sufficient observation so that any statistic is relevant.
INLINE double	testValue (const DiscreteVariable *var) const
	Returns the performance of given variables according to selection criterion.
INLINE double	testOtherCriterion (const DiscreteVariable *var) const
	Returns the performance of given variables according to selection secondary criterion (to break ties).
Aggregation Methods
NodeDatabase< AttributeSelection, isScalar > &	operator+= (const NodeDatabase< AttributeSelection, isScalar > &src)
	Merges given NodeDatabase informations into current nDB.
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).
const HashTableConstIteratorSafe< ValueType, Idx >	cbeginValues () const
	Iterators on value count to recopy correctly its content.
const HashTableConstIteratorSafe< ValueType, Idx >	cendValues () const
	Merges given NodeDatabase informations into current nDB.

Private Types
using	ValueType = typename ValueSelect< isScalar, double, Idx >::type
template<typename GUM_ELEMENT>
using	TestPolicy

Private Member Functions
Idx	_valueDomain_ (Int2Type< true >) const
Idx	_valueDomain_ (Int2Type< false >) const
std::string	toString () const

Private Attributes
HashTable< const DiscreteVariable , TestPolicy< ValueType > >	_attrTable_
	Table giving for every variables its instantiation.
const DiscreteVariable *	_value_
	So does this reference on the value observed.
Idx	_nbObservation_
HashTable< ValueType, Idx >	_valueCount_

Observation handling methods
void	addObservation (const Observation *)
	Nb observation taken into account by this instance.
INLINE Idx	nbObservation () const
	Nb observation taken into account by this instance.
void	_addObservation_ (const Observation *, Int2Type< true >)
	Updates database with new observation.
void	_addObservation_ (const Observation *, Int2Type< false >)
	depending on if we're learning reward function or transition probability

Detailed Description

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

Definition at line 75 of file nodeDatabase.h.

Member Typedef Documentation

◆ TestPolicy

template<TESTNAME AttributeSelection, bool isScalar>

template<typename GUM_ELEMENT>

using gum::NodeDatabase< AttributeSelection, isScalar >::TestPolicy

private

Initial value:

typename TestSelect< AttributeSelection,
                                           GTestPolicy< GUM_ELEMENT >,
                                           Chi2TestPolicy< GUM_ELEMENT >,
                                           LeastSquareTestPolicy< GUM_ELEMENT > >::type

Definition at line 79 of file nodeDatabase.h.

◆ ValueType

template<TESTNAME AttributeSelection, bool isScalar>

using gum::NodeDatabase< AttributeSelection, isScalar >::ValueType = typename ValueSelect< isScalar, double, Idx >::type

private

Definition at line 76 of file nodeDatabase.h.

Constructor & Destructor Documentation

◆ NodeDatabase()

template<TESTNAME AttributeSelection, bool isScalar>

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

Default constructor.

Definition at line 65 of file nodeDatabase_tpl.h.

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

References NodeDatabase(), _attrTable_, _nbObservation_, _value_, gum::Set< Key >::cbeginSafe(), and gum::Set< Key >::cendSafe().

Referenced by NodeDatabase(), ~NodeDatabase(), operator delete(), operator new(), and operator+=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~NodeDatabase()

template<TESTNAME AttributeSelection, bool isScalar>

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

Default destructor.

Definition at line 82 of file nodeDatabase_tpl.h.

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

References NodeDatabase(), and _attrTable_.

Here is the call graph for this function:

Member Function Documentation

◆ _addObservation_() [1/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 118 of file nodeDatabase_tpl.h.

                                                                                         {
    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);
  }

References _attrTable_, _value_, and gum::Observation::modality().

Here is the call graph for this function:

◆ _addObservation_() [2/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 108 of file nodeDatabase_tpl.h.

                                                                                        {
    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);
  }

References _attrTable_, _valueCount_, gum::Observation::reward(), and gum::Observation::rModality().

Here is the call graph for this function:

◆ _valueDomain_() [1/2]

template<TESTNAME AttributeSelection, bool isScalar>

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

private

Definition at line 244 of file nodeDatabase_tpl.h.

                                                                                         {
    return _value_->domainSize();
  }

References _value_.

◆ _valueDomain_() [2/2]

template<TESTNAME AttributeSelection, bool isScalar>

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

private

Definition at line 239 of file nodeDatabase_tpl.h.

                                                                                        {
    return _valueCount_.size();
  }

References _valueCount_.

Referenced by valueDomain().

Here is the caller 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 102 of file nodeDatabase_tpl.h.

                                                                                             {
    _nbObservation_++;
    this->_addObservation_(newObs, Int2Type< isScalar >());
  }

◆ cbeginValues()

template<TESTNAME AttributeSelection, bool isScalar>

auto gum::NodeDatabase< AttributeSelection, isScalar >::cbeginValues ( ) const

Iterators on value count to recopy correctly its content.

Definition at line 217 of file nodeDatabase_tpl.h.

                                                            {
    return _valueCount_.cbeginSafe();
  }

References _valueCount_.

Referenced by operator+=().

Here is the caller graph for this function:

◆ cendValues()

template<TESTNAME AttributeSelection, bool isScalar>

auto gum::NodeDatabase< AttributeSelection, isScalar >::cendValues ( ) const

Merges given NodeDatabase informations into current nDB.

Definition at line 223 of file nodeDatabase_tpl.h.

                                                            {
    return _valueCount_.cendSafe();
  }

References _valueCount_.

Referenced by operator+=().

Here is the caller graph for this function:

◆ effectif()

template<TESTNAME AttributeSelection, bool isScalar>

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

Definition at line 229 of file nodeDatabase_tpl.h.

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

References _valueCount_.

◆ isTestRelevant()

template<TESTNAME AttributeSelection, bool isScalar>

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

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

Definition at line 189 of file nodeDatabase_tpl.h.

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

◆ nbObservation()

template<TESTNAME AttributeSelection, bool isScalar>

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

Nb observation taken into account by this instance.

Definition at line 180 of file nodeDatabase_tpl.h.

                                                                        {
    return _nbObservation_;
  }

Referenced by operator+=(), and toString().

Here is the caller graph for this function:

◆ operator delete()

template<TESTNAME AttributeSelection, bool isScalar>

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

Default constructor.

Definition at line 171 of file nodeDatabase_tpl.h.

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

References NodeDatabase(), gum::SmallObjectAllocator::deallocate(), and gum::SmallObjectAllocator::instance().

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 )

Allocators and Deallocators redefinition.

Definition at line 166 of file nodeDatabase_tpl.h.

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

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

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 137 of file nodeDatabase_tpl.h.

                                                                   {
    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;
  }

References NodeDatabase(), _attrTable_, _nbObservation_, cbeginValues(), cendValues(), nbObservation(), and testPolicy().

Here is the call graph for this function:

◆ testOtherCriterion()

template<TESTNAME AttributeSelection, bool isScalar>

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

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

Definition at line 201 of file nodeDatabase_tpl.h.

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

References _attrTable_.

◆ testPolicy()

template<TESTNAME AttributeSelection, bool isScalar>

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

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

Definition at line 211 of file nodeDatabase_tpl.h.

                                        {
    return _attrTable_[var];
  }

References _attrTable_.

Referenced by operator+=().

Here is the caller graph for this function:

◆ testValue()

template<TESTNAME AttributeSelection, bool isScalar>

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

Returns the performance of given variables according to selection criterion.

Definition at line 196 of file nodeDatabase_tpl.h.

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

◆ toString()

template<TESTNAME AttributeSelection, bool isScalar>

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

private

Definition at line 152 of file nodeDatabase_tpl.h.

                                                                         {
    std::string ss = std::format("NbObservation : {}\n", this->nbObservation());
    for (auto varIter = _attrTable_.beginSafe(); varIter != _attrTable_.endSafe(); ++varIter)
      ss += std::format("\t\tVariable : {} - Associated Test : {}\n",
                        varIter.key()->name(),
                        _attrTable_[varIter.key()]->toString());
    return ss;
  }

References _attrTable_, and nbObservation().

Here is the call graph for this function:

◆ valueDomain()

template<TESTNAME AttributeSelection, bool isScalar>

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

Definition at line 234 of file nodeDatabase_tpl.h.

                                                                      {
    return _valueDomain_(Int2Type< isScalar >());
  }

References _valueDomain_().

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 204 of file nodeDatabase.h.

Referenced by NodeDatabase(), ~NodeDatabase(), _addObservation_(), _addObservation_(), operator+=(), testOtherCriterion(), testPolicy(), and toString().

◆ _nbObservation_

template<TESTNAME AttributeSelection, bool isScalar>

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

private

Definition at line 210 of file nodeDatabase.h.

Referenced by NodeDatabase(), and 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 207 of file nodeDatabase.h.

Referenced by NodeDatabase(), _addObservation_(), and _valueDomain_().

◆ _valueCount_

template<TESTNAME AttributeSelection, bool isScalar>

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

private

Definition at line 213 of file nodeDatabase.h.

Referenced by _addObservation_(), _valueDomain_(), cbeginValues(), cendValues(), and effectif().

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

Private Types

Private Member Functions

Private Attributes

Observation handling methods

Detailed Description

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_