gum::GTestPolicy< GUM_SCALAR > Class Template Reference

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

Protected Member Functions
bool	_isModified () const

Detailed Description

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

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

G implements a test policy that follows the G statistic

Definition at line 53 of file GTestPolicy.h.

Constructor & Destructor Documentation

GTestPolicy()

template<typename GUM_SCALAR>

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

inline

Constructor.

Definition at line 63 of file GTestPolicy.h.

                  : ITestPolicy< GUM_SCALAR >(), __conTab(), __GStat(0) {
      GUM_CONSTRUCTOR(GTestPolicy);
    }

~GTestPolicy()

template<typename GUM_SCALAR>

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

inlinevirtual

Destructor.

Definition at line 70 of file GTestPolicy.h.

{ GUM_DESTRUCTOR(GTestPolicy); }

Member Function Documentation

_isModified()

template<typename GUM_SCALAR>

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

inlineprotectedinherited

Definition at line 165 of file ITestPolicy.h.

References gum::ITestPolicy< GUM_SCALAR >::__isModified.

{ return __isModified; }

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

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

Referenced by gum::GTestPolicy< GUM_SCALAR >::isTestRelevant().

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

Here is the call graph for this function:

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

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

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

                                                   {
      __isModified = true;
      __nbObs += src.nbObservation();
    }

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 46 of file GTestPolicy_tpl.h.

References gum::ITestPolicy< GUM_SCALAR >::addObservation().

Referenced by gum::GTestPolicy< GUM_SCALAR >::operator delete().

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

Here is the call graph for this function:

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

References gum::ITestPolicy< GUM_SCALAR >::computeScore().

Referenced by gum::GTestPolicy< GUM_SCALAR >::isTestRelevant().

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

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 145 of file GTestPolicy.h.

References gum::GTestPolicy< GUM_SCALAR >::__conTab.

Referenced by gum::GTestPolicy< GUM_SCALAR >::add().

{ return __conTab; }

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 107 of file GTestPolicy.h.

References gum::GTestPolicy< GUM_SCALAR >::__conTab, gum::GTestPolicy< GUM_SCALAR >::add(), gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrASize(), gum::GTestPolicy< GUM_SCALAR >::computeScore(), gum::ITestPolicy< GUM_SCALAR >::nbObservation(), gum::GTestPolicy< GUM_SCALAR >::score(), and gum::GTestPolicy< GUM_SCALAR >::secondaryscore().

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

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 98 of file ITestPolicy.h.

References gum::ITestPolicy< GUM_SCALAR >::__nbObs, and gum::ITestPolicy< GUM_SCALAR >::isTestRelevant().

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

{ return __nbObs; }

Here is the call graph for this function:

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 79 of file GTestPolicy.h.

References gum::GTestPolicy< GUM_SCALAR >::addObservation(), gum::SmallObjectAllocator::deallocate(), and gum::SmallObjectAllocator::instance().

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

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 75 of file GTestPolicy.h.

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

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

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 92 of file GTestPolicy_tpl.h.

References gum::ChiSquare::probaChi2().

Referenced by gum::GTestPolicy< GUM_SCALAR >::isTestRelevant().

                                                {
    if (this->_isModified()) computeScore();
    //      std::cout << this->toString() << std::endl;
    double score =
       1
       - ChiSquare::probaChi2(
          __GStat, (__conTab.attrASize() - 1) * (__conTab.attrBSize() - 1));
    return 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 106 of file GTestPolicy_tpl.h.

Referenced by gum::GTestPolicy< GUM_SCALAR >::isTestRelevant(), and gum::GTestPolicy< GUM_SCALAR >::toString().

                                                         {
    if (this->_isModified()) computeScore();
    return __GStat;
  }

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 156 of file GTestPolicy.h.

References gum::GTestPolicy< GUM_SCALAR >::__conTab, gum::GTestPolicy< GUM_SCALAR >::__GStat, gum::GTestPolicy< GUM_SCALAR >::secondaryscore(), and gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::toString().

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

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 170 of file GTestPolicy.h.

Referenced by gum::GTestPolicy< GUM_SCALAR >::ct(), gum::GTestPolicy< GUM_SCALAR >::isTestRelevant(), and gum::GTestPolicy< GUM_SCALAR >::toString().

__GStat

template<typename GUM_SCALAR>

double gum::GTestPolicy< GUM_SCALAR >::__GStat

mutableprivate

Definition at line 171 of file GTestPolicy.h.

Referenced by gum::GTestPolicy< GUM_SCALAR >::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