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

#include <GTestPolicy.h>

Inheritance diagram for gum::GTestPolicy< GUM_SCALAR >:

Collaboration diagram for gum::GTestPolicy< GUM_SCALAR >:

Public Member Functions
Constructor/Destrcutor
	GTestPolicy ()
	Constructor.
virtual	~GTestPolicy ()
	Destructor.
void *	operator new (size_t s)
	Allocators and Deallocators redefinition.
void	operator delete (void *p)
	Constructor.
Observation insertion
void	addObservation (Idx iattr, GUM_SCALAR ivalue)
	Comptabilizes the new observation.
Test methods
bool	isTestRelevant () const
	Returns true if enough observation were made so that the test can be relevant.
void	computeScore () const
	Computes the GStat of current variable according to the test.
double	score () const
	Returns the performance of current variable according to the test.
double	secondaryscore () const
	Returns a second criterion to severe ties.
Fusion Methods
void	add (const GTestPolicy< GUM_SCALAR > &src)
	Performs the merging of current GTestPolicy instance with given instance.
const ContingencyTable< Idx, GUM_SCALAR > &	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_SCALAR > &src)

Protected Member Functions
bool	isModified_ () const

Private Attributes
ContingencyTable< Idx, GUM_SCALAR >	_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_SCALAR>
class gum::GTestPolicy< GUM_SCALAR >

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_SCALAR>

gum::GTestPolicy< GUM_SCALAR >::GTestPolicy ( )

inline

Constructor.

Definition at line 84 of file GTestPolicy.h.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~GTestPolicy()

template<typename GUM_SCALAR>

virtual gum::GTestPolicy< GUM_SCALAR >::~GTestPolicy ( )

inlinevirtual

Destructor.

Definition at line 91 of file GTestPolicy.h.

                           {
      GUM_DESTRUCTOR(GTestPolicy);
      ;
    }

References GTestPolicy().

Here is the call graph for this function:

Member Function Documentation

◆ add() [1/2]

template<typename GUM_SCALAR>

void gum::GTestPolicy< GUM_SCALAR >::add ( const GTestPolicy< GUM_SCALAR > & src )

Performs the merging of current GTestPolicy instance with given instance.

Definition at line 129 of file GTestPolicy_tpl.h.

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

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

Here is the call graph for this function:

◆ add() [2/2]

template<typename GUM_SCALAR>

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

inlineinherited

Definition at line 161 of file ITestPolicy.h.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addObservation()

template<typename GUM_SCALAR>

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

virtual

Comptabilizes the new observation.

Reimplemented from gum::ITestPolicy< GUM_SCALAR >.

Definition at line 68 of file GTestPolicy_tpl.h.

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

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

Here is the call graph for this function:

◆ computeScore()

template<typename GUM_SCALAR>

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

virtual

Computes the GStat of current variable according to the test.

Reimplemented from gum::ITestPolicy< GUM_SCALAR >.

Definition at line 81 of file GTestPolicy_tpl.h.

                                                     {
    ITestPolicy< GUM_SCALAR >::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_SCALAR >::computeScore(), and gum::ITestPolicy< GUM_SCALAR >::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_SCALAR>

const ContingencyTable< Idx, GUM_SCALAR > & gum::GTestPolicy< GUM_SCALAR >::ct ( ) const

inline

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

Definition at line 166 of file GTestPolicy.h.

166{ return _conTab_; }

References _conTab_.

Referenced by add().

Here is the caller graph for this function:

◆ isModified_()

template<typename GUM_SCALAR>

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

inlineprotectedinherited

Definition at line 186 of file ITestPolicy.h.

186{ return _isModified_; }

References _isModified_.

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

Here is the caller graph for this function:

◆ isTestRelevant()

template<typename GUM_SCALAR>

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

inlinevirtual

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

Implements gum::ITestPolicy< GUM_SCALAR >.

Definition at line 129 of file GTestPolicy.h.

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

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

Here is the call graph for this function:

◆ nbObservation()

template<typename GUM_SCALAR>

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

inlineinherited

Comptabilizes the new observation.

Definition at line 119 of file ITestPolicy.h.

119{ return _nbObs_; }

References _nbObs_.

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

Here is the caller graph for this function:

◆ operator delete()

template<typename GUM_SCALAR>

void gum::GTestPolicy< GUM_SCALAR >::operator delete ( void * p )

inline

Constructor.

Definition at line 101 of file GTestPolicy.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_SCALAR>

void * gum::GTestPolicy< GUM_SCALAR >::operator new ( size_t s )

inline

Allocators and Deallocators redefinition.

Definition at line 99 of file GTestPolicy.h.

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

gum::SmallObjectAllocator::allocate

void * allocate(const size_t &objectSize)

Allocates a block.

Definition smallObjectAllocator_inl.h:108

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

Here is the call graph for this function:

◆ score()

template<typename GUM_SCALAR>

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

virtual

Returns the performance of current variable according to the test.

Implements gum::ITestPolicy< GUM_SCALAR >.

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

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

virtual

Returns a second criterion to severe ties.

Implements gum::ITestPolicy< GUM_SCALAR >.

Definition at line 123 of file GTestPolicy_tpl.h.

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

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

Referenced by toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

template<typename GUM_SCALAR>

std::string gum::GTestPolicy< GUM_SCALAR >::toString ( ) const

inline

Definition at line 176 of file GTestPolicy.h.

                               {
      std::stringstream ss;
      ss << ITestPolicy< GUM_SCALAR >::toString() << "\t\t\tContingency Table : " << std::endl
         << _conTab_.toString() << std::endl
         << "\t\t\tGStat : " << _GStat_ << std::endl
         << "\t\t\tGStat : " << this->secondaryscore() << std::endl;
      return ss.str();
    }

References _conTab_, _GStat_, and secondaryscore().

Here is the call graph for this function:

Member Data Documentation

◆ _conTab_

template<typename GUM_SCALAR>

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

private

The contingency table used to keeps records of all observation.

Definition at line 189 of file GTestPolicy.h.

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

◆ _GStat_

template<typename GUM_SCALAR>

double gum::GTestPolicy< GUM_SCALAR >::_GStat_

mutableprivate

Definition at line 190 of file GTestPolicy.h.

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

◆ _isModified_

template<typename GUM_SCALAR>

bool gum::ITestPolicy< GUM_SCALAR >::_isModified_

mutableprivateinherited

Booleans indicating if we have to re eval test.

Definition at line 190 of file ITestPolicy.h.

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

◆ _nbObs_

template<typename GUM_SCALAR>

Idx gum::ITestPolicy< GUM_SCALAR >::_nbObs_

privateinherited

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GTestPolicy()

◆ ~GTestPolicy()

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ addObservation()

◆ computeScore()

◆ ct()

◆ isModified_()

◆ isTestRelevant()

◆ nbObservation()

◆ operator delete()

◆ operator new()

◆ score()

◆ secondaryscore()

◆ toString()

Member Data Documentation

◆ _conTab_

◆ _GStat_

◆ _isModified_

◆ _nbObs_