gum::GTestPolicy< GUM_ELEMENT > Class Template Reference

<agrum/base/multidim/core/testPolicies/GTestPolicy.h> More...

#include <GTestPolicy.h>

Inheritance diagram for gum::GTestPolicy< GUM_ELEMENT >:

Collaboration diagram for gum::GTestPolicy< GUM_ELEMENT >:

Public Member Functions
Constructor/Destrcutor
	GTestPolicy ()
	Constructor.
	~GTestPolicy () override
	Destructor.
void *	operator new (size_t s)
	Allocators and Deallocators redefinition.
void	operator delete (void *p)
	Constructor.
Observation insertion
void	addObservation (Idx iattr, GUM_ELEMENT ivalue) override
	Comptabilizes the new observation.
Test methods
bool	isTestRelevant () const override
	Returns true if enough observation were made so that the test can be relevant.
void	computeScore () const override
	Computes the GStat of current variable according to the test.
double	score () const override
	Returns the performance of current variable according to the test.
double	secondaryscore () const override
	Returns a second criterion to severe ties.
Fusion Methods
void	add (const GTestPolicy< GUM_ELEMENT > &src)
	Performs the merging of current GTestPolicy instance with given instance.
const ContingencyTable< Idx, GUM_ELEMENT > &	ct () const
	Returns contingency table (needed for the merging of GTestPolicy instances).
Miscelleanous Methods
std::string	toString () const
Observation methods
Idx	nbObservation () const
	Comptabilizes the new observation.
Fusion Methods
void	add (const ITestPolicy< GUM_ELEMENT > &src)

Protected Member Functions
bool	isModified_ () const

Private Attributes
ContingencyTable< Idx, GUM_ELEMENT >	_conTab_
	The contingency table used to keeps records of all observation.
double	_GStat_
bool	_isModified_
	Booleans indicating if we have to re eval test.
Idx	_nbObs_

Detailed Description

template<typename GUM_ELEMENT>
class gum::GTestPolicy< GUM_ELEMENT >

<agrum/base/multidim/core/testPolicies/GTestPolicy.h>

G implements a test policy that follows the G statistic

Definition at line 74 of file GTestPolicy.h.

Constructor & Destructor Documentation

GTestPolicy()

template<typename GUM_ELEMENT>

gum::GTestPolicy< GUM_ELEMENT >::GTestPolicy

(

)

Constructor.

Definition at line 136 of file GTestPolicy_tpl.h.

                                          : ITestPolicy< GUM_ELEMENT >(), _conTab_(), _GStat_(0) {
    GUM_CONSTRUCTOR(GTestPolicy);
  }

References GTestPolicy(), gum::ITestPolicy< GUM_ELEMENT >::ITestPolicy(), _conTab_, and _GStat_.

Referenced by GTestPolicy(), ~GTestPolicy(), add(), operator delete(), and operator new().

Here is the call graph for this function:

Here is the caller graph for this function:

~GTestPolicy()

template<typename GUM_ELEMENT>

gum::GTestPolicy< GUM_ELEMENT >::~GTestPolicy ( )

override

Destructor.

Definition at line 141 of file GTestPolicy_tpl.h.

                                           {
    GUM_DESTRUCTOR(GTestPolicy);
    ;
  }

References GTestPolicy().

Here is the call graph for this function:

Member Function Documentation

add() [1/2]

template<typename GUM_ELEMENT>

void gum::GTestPolicy< GUM_ELEMENT >::add

(

const GTestPolicy< GUM_ELEMENT > &

src

)

Performs the merging of current GTestPolicy instance with given instance.

Definition at line 130 of file GTestPolicy_tpl.h.

                                                                            {
    ITestPolicy< GUM_ELEMENT >::add(src);
    _conTab_ += src.ct();
  }

References GTestPolicy(), _conTab_, gum::ITestPolicy< GUM_ELEMENT >::add(), and ct().

Here is the call graph for this function:

add() [2/2]

template<typename GUM_ELEMENT>

void gum::ITestPolicy< GUM_ELEMENT >::add ( const ITestPolicy< GUM_ELEMENT > & src )

inherited

Definition at line 86 of file ITestPolicy_tpl.h.

                                                                            {
    _isModified_ = true;
    _nbObs_ += src.nbObservation();
  }

References ITestPolicy(), _isModified_, _nbObs_, and nbObservation().

Referenced by gum::Chi2TestPolicy< GUM_ELEMENT >::add(), gum::GTestPolicy< GUM_ELEMENT >::add(), and gum::LeastSquareTestPolicy< GUM_ELEMENT >::add().

Here is the call graph for this function:

Here is the caller graph for this function:

addObservation()

template<typename GUM_ELEMENT>

void gum::GTestPolicy< GUM_ELEMENT >::addObservation ( Idx iattr, GUM_ELEMENT ivalue )

overridevirtual

Comptabilizes the new observation.

Reimplemented from gum::ITestPolicy< GUM_ELEMENT >.

Definition at line 69 of file GTestPolicy_tpl.h.

                                                                               {
    ITestPolicy< GUM_ELEMENT >::addObservation(iattr, ivalue);
    _conTab_.add(iattr, ivalue);
  }

References _conTab_, and gum::ITestPolicy< GUM_ELEMENT >::addObservation().

Here is the call graph for this function:

computeScore()

template<typename GUM_ELEMENT>

void gum::GTestPolicy< GUM_ELEMENT >::computeScore ( ) const

overridevirtual

Computes the GStat of current variable according to the test.

Reimplemented from gum::ITestPolicy< GUM_ELEMENT >.

Definition at line 82 of file GTestPolicy_tpl.h.

                                                      {
    ITestPolicy< GUM_ELEMENT >::computeScore();
    _GStat_ = 0;
 
    // Itération sur l'axe 1 du tableau
    for (auto attrIter = _conTab_.attrABeginSafe(); attrIter != _conTab_.attrAEndSafe();
         ++attrIter) {
      // Mise en cache de valeur utile
      double semiExpected = (double)(attrIter.val()) / (double)this->nbObservation();
 
      // Itération sur l'axe 2 du tableau
      for (auto valIter = _conTab_.attrBBeginSafe(); valIter != _conTab_.attrBEndSafe();
           ++valIter) {
        // Récupération de la valeur en cellule
        Idx cell = _conTab_.joint(attrIter.key(), valIter.key());
        if (cell < 5) continue;
 
        // Récupération de la valeur en axe 2
        double expected = semiExpected * (double)valIter.val();
 
        _GStat_ += 2 * cell * log(cell / expected);
      }
    }
  }

References _conTab_, _GStat_, gum::ITestPolicy< GUM_ELEMENT >::computeScore(), and gum::ITestPolicy< GUM_ELEMENT >::nbObservation().

Referenced by score(), and secondaryscore().

Here is the call graph for this function:

Here is the caller graph for this function:

ct()

template<typename GUM_ELEMENT>

const ContingencyTable< Idx, GUM_ELEMENT > & gum::GTestPolicy< GUM_ELEMENT >::ct

(

)

const

Returns contingency table (needed for the merging of GTestPolicy instances).

Definition at line 162 of file GTestPolicy_tpl.h.

                                                                                   {
    return _conTab_;
  }

References _conTab_.

Referenced by add().

Here is the caller graph for this function:

isModified_()

template<typename GUM_ELEMENT>

bool gum::ITestPolicy< GUM_ELEMENT >::isModified_ ( ) const

protectedinherited

Definition at line 97 of file ITestPolicy_tpl.h.

                                                     {
    return _isModified_;
  }

References _isModified_.

Referenced by gum::Chi2TestPolicy< GUM_ELEMENT >::score(), gum::GTestPolicy< GUM_ELEMENT >::score(), gum::LeastSquareTestPolicy< GUM_ELEMENT >::score(), gum::Chi2TestPolicy< GUM_ELEMENT >::secondaryscore(), gum::GTestPolicy< GUM_ELEMENT >::secondaryscore(), and gum::LeastSquareTestPolicy< GUM_ELEMENT >::secondaryscore().

Here is the caller graph for this function:

isTestRelevant()

template<typename GUM_ELEMENT>

bool gum::GTestPolicy< GUM_ELEMENT >::isTestRelevant ( ) const

overridevirtual

Returns true if enough observation were made so that the test can be relevant.

Implements gum::ITestPolicy< GUM_ELEMENT >.

Definition at line 157 of file GTestPolicy_tpl.h.

                                                        {
    return (this->nbObservation() > 20 && this->nbObservation() > _conTab_.attrASize() * 5);
  }

References _conTab_, and gum::ITestPolicy< GUM_ELEMENT >::nbObservation().

Here is the call graph for this function:

nbObservation()

template<typename GUM_ELEMENT>

Idx gum::ITestPolicy< GUM_ELEMENT >::nbObservation ( ) const

inherited

Comptabilizes the new observation.

Definition at line 76 of file ITestPolicy_tpl.h.

                                                      {
    return _nbObs_;
  }

References _nbObs_.

Referenced by add(), gum::Chi2TestPolicy< GUM_ELEMENT >::computeScore(), gum::GTestPolicy< GUM_ELEMENT >::computeScore(), gum::LeastSquareTestPolicy< GUM_ELEMENT >::computeScore(), gum::Chi2TestPolicy< GUM_ELEMENT >::isTestRelevant(), gum::GTestPolicy< GUM_ELEMENT >::isTestRelevant(), and gum::LeastSquareTestPolicy< GUM_ELEMENT >::isTestRelevant().

Here is the caller graph for this function:

operator delete()

template<typename GUM_ELEMENT>

void gum::GTestPolicy< GUM_ELEMENT >::operator delete

(

void *

p

)

Constructor.

Definition at line 152 of file GTestPolicy_tpl.h.

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

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

Here is the call graph for this function:

operator new()

template<typename GUM_ELEMENT>

void * gum::GTestPolicy< GUM_ELEMENT >::operator new

(

size_t

s

)

Allocators and Deallocators redefinition.

Definition at line 147 of file GTestPolicy_tpl.h.

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

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

Here is the call graph for this function:

score()

template<typename GUM_ELEMENT>

double gum::GTestPolicy< GUM_ELEMENT >::score ( ) const

overridevirtual

Returns the performance of current variable according to the test.

Implements gum::ITestPolicy< GUM_ELEMENT >.

Definition at line 111 of file GTestPolicy_tpl.h.

                                                 {
    if (this->isModified_()) computeScore();
    //      std::cout << this->toString() << std::endl;
    double score
        = 1
        - ChiSquare::probaChi2(_GStat_, (_conTab_.attrASize() - 1) * (_conTab_.attrBSize() - 1));
    return score;
  }

References _conTab_, _GStat_, computeScore(), gum::ITestPolicy< GUM_ELEMENT >::isModified_(), gum::ChiSquare::probaChi2(), and score().

Referenced by score().

Here is the call graph for this function:

Here is the caller graph for this function:

secondaryscore()

template<typename GUM_ELEMENT>

double gum::GTestPolicy< GUM_ELEMENT >::secondaryscore ( ) const

overridevirtual

Returns a second criterion to severe ties.

Implements gum::ITestPolicy< GUM_ELEMENT >.

Definition at line 124 of file GTestPolicy_tpl.h.

                                                          {
    if (this->isModified_()) computeScore();
    return _GStat_;
  }

References _GStat_, computeScore(), and gum::ITestPolicy< GUM_ELEMENT >::isModified_().

Here is the call graph for this function:

toString()

template<typename GUM_ELEMENT>

std::string gum::GTestPolicy< GUM_ELEMENT >::toString

(

)

const

Definition at line 167 of file GTestPolicy_tpl.h.

                                                       {
    return std::format("{}\t\t\tContingency Table : \n{}\n\t\t\tGStat : {}\n\t\t\tGStat : {}\n",
                       ITestPolicy< GUM_ELEMENT >::toString(),
                       _conTab_.toString(),
                       _GStat_,
                       this->secondaryscore());
  }

References _conTab_, _GStat_, and gum::ITestPolicy< GUM_ELEMENT >::toString().

Here is the call graph for this function:

Member Data Documentation

_conTab_

template<typename GUM_ELEMENT>

ContingencyTable< Idx, GUM_ELEMENT > gum::GTestPolicy< GUM_ELEMENT >::_conTab_

private

The contingency table used to keeps records of all observation.

Definition at line 173 of file GTestPolicy.h.

Referenced by GTestPolicy(), add(), addObservation(), computeScore(), ct(), isTestRelevant(), score(), and toString().

_GStat_

template<typename GUM_ELEMENT>

double gum::GTestPolicy< GUM_ELEMENT >::_GStat_

mutableprivate

Definition at line 174 of file GTestPolicy.h.

Referenced by GTestPolicy(), computeScore(), score(), secondaryscore(), and toString().

_isModified_

template<typename GUM_ELEMENT>

bool gum::ITestPolicy< GUM_ELEMENT >::_isModified_

mutableprivateinherited

Booleans indicating if we have to re eval test.

Definition at line 175 of file ITestPolicy.h.

Referenced by ITestPolicy(), add(), addObservation(), computeScore(), and isModified_().

_nbObs_

template<typename GUM_ELEMENT>

Idx gum::ITestPolicy< GUM_ELEMENT >::_nbObs_

privateinherited

Definition at line 178 of file ITestPolicy.h.

Referenced by ITestPolicy(), add(), addObservation(), nbObservation(), and toString().

---

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

• agrum/FMDP/learning/core/testPolicy/GTestPolicy.h
• agrum/FMDP/learning/core/testPolicy/GTestPolicy_tpl.h