gum::LeastSquareTestPolicy< GUM_ELEMENT > Class Template Reference

<agrum/base/multidim/core/testPolicy/leastSquareTestPolicy.h> More...

#include <leastSquareTestPolicy.h>

Inheritance diagram for gum::LeastSquareTestPolicy< GUM_ELEMENT >:

Collaboration diagram for gum::LeastSquareTestPolicy< GUM_ELEMENT >:

Public Member Functions
Constructor/Destrcutor
	LeastSquareTestPolicy ()
	Constructor.
void *	operator new (size_t s)
	Allocators and Deallocators redefinition.
void	operator delete (void *p)
	Constructor.
virtual	~LeastSquareTestPolicy ()
	Destructor.
Observation insertion
void	addObservation (Idx attr, GUM_ELEMENT value)
	Comptabilizes the new observation.
Test relevance
bool	isTestRelevant () const
	Returns true if enough observation were made so that the test can be relevant.
Test result
void	computeScore ()
	Returns the performance of current variable according to the test.
double	score ()
	Returns the performance of current variable according to the test.
double	secondaryscore () const
	Returns a second criterion to severe ties.
Observation methods
Idx	nbObservation () const
	Comptabilizes the new observation.
Test methods
virtual void	computeScore () const
	Recomputes the statistic from the beginning.
virtual double	score () const =0
	Returns the performance of current variable according to the test.
Fusion Methods
void	add (const ITestPolicy< GUM_ELEMENT > &src)
Miscelleanous Methods
std::string	toString () const

Protected Member Functions
bool	isModified_ () const

Private Attributes
bool	_isModified_
	Booleans indicating if we have to re eval test.
Idx	_nbObs_

Fusion Methods
double	_sumO_
	Global sum.
HashTable< Idx, Idx >	_nbObsTable_
	Nb Observation for each modality assumed by variable.
HashTable< Idx, double >	_sumAttrTable_
	Sum for each modality assumed by variable.
HashTable< Idx, LinkedList< double > * >	_obsTable_
	Not sure if needed.
double	_score_
	Keeping computed score.
void	add (const LeastSquareTestPolicy< GUM_ELEMENT > &src)
	Performs the merging of current LeastSquareTestPolicy instance with given instance.
double	sumValue () const
	Returns global sum (needed for the merging).
const HashTable< Idx, Idx > &	nbObsTable () const
	Returns nbobs per modality table (needed for the merging).
const HashTable< Idx, double > &	sumAttrTable () const
	Returns sum per modality table (needed for the merging).
const HashTable< Idx, LinkedList< double > * > &	obsTable () const
	Returns global sum (needed for the merging).

Detailed Description

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

<agrum/base/multidim/core/testPolicy/leastSquareTestPolicy.h>

LeastSquareTestPolicy implements a test policy that follows the Least Square statistic

Definition at line 73 of file leastSquareTestPolicy.h.

Constructor & Destructor Documentation

LeastSquareTestPolicy()

template<typename GUM_ELEMENT>

gum::LeastSquareTestPolicy< GUM_ELEMENT >::LeastSquareTestPolicy

(

)

Constructor.

Definition at line 164 of file leastSquareTestPolicy_tpl.h.

                                                              :
      ITestPolicy< GUM_ELEMENT >(), _sumO_(0.0), _score_(0) {
    GUM_CONSTRUCTOR(LeastSquareTestPolicy);
  }

References gum::ITestPolicy< GUM_ELEMENT >::ITestPolicy(), LeastSquareTestPolicy(), _score_, and _sumO_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

~LeastSquareTestPolicy()

template<typename GUM_ELEMENT>

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

virtual

Destructor.

Definition at line 59 of file leastSquareTestPolicy_tpl.h.

                                                               {
    for (auto obsIter = this->_obsTable_.cbeginSafe(); _obsTable_.cendSafe() != obsIter; ++obsIter)
      delete obsIter.val();
 
    GUM_DESTRUCTOR(LeastSquareTestPolicy);
  }

References LeastSquareTestPolicy(), and _obsTable_.

Here is the call graph for this function:

Member Function Documentation

add() [1/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:

add() [2/2]

template<typename GUM_ELEMENT>

void gum::LeastSquareTestPolicy< GUM_ELEMENT >::add

(

const LeastSquareTestPolicy< GUM_ELEMENT > &

src

)

Performs the merging of current LeastSquareTestPolicy instance with given instance.

Definition at line 138 of file leastSquareTestPolicy_tpl.h.

                                                                                 {
    ITestPolicy< GUM_ELEMENT >::add(src);
 
    for (auto obsIter = src.nbObsTable().cbeginSafe(); obsIter != src.nbObsTable().cendSafe();
         ++obsIter)
      if (_nbObsTable_.exists(obsIter.key())) _nbObsTable_[obsIter.key()] += obsIter.val();
      else _nbObsTable_.insert(obsIter.key(), obsIter.val());
 
    for (auto attrIter = src.sumAttrTable().cbeginSafe(); attrIter != src.sumAttrTable().cendSafe();
         ++attrIter)
      if (_sumAttrTable_.exists(attrIter.key())) _sumAttrTable_[attrIter.key()] += attrIter.val();
      else _sumAttrTable_.insert(attrIter.key(), attrIter.val());
 
    for (auto obsIter = src.obsTable().cbeginSafe(); obsIter != src.obsTable().cendSafe();
         ++obsIter) {
      if (!_obsTable_.exists(obsIter.key()))
        _obsTable_.insert(obsIter.key(), new LinkedList< double >());
      const Link< double >* srcLink = obsIter.val()->list();
      while (srcLink) {
        _obsTable_[obsIter.key()]->addLink(srcLink->element());
        srcLink = srcLink->nextLink();
      }
    }
  }

References LeastSquareTestPolicy(), _nbObsTable_, _obsTable_, _sumAttrTable_, gum::ITestPolicy< GUM_ELEMENT >::add(), gum::HashTable< Key, Val >::cbeginSafe(), gum::HashTable< Key, Val >::cendSafe(), gum::Link< T >::element(), nbObsTable(), gum::Link< T >::nextLink(), obsTable(), and sumAttrTable().

Here is the call graph for this function:

addObservation()

template<typename GUM_ELEMENT>

void gum::LeastSquareTestPolicy< GUM_ELEMENT >::addObservation ( Idx attr, GUM_ELEMENT value )

virtual

Comptabilizes the new observation.

Reimplemented from gum::ITestPolicy< GUM_ELEMENT >.

Definition at line 74 of file leastSquareTestPolicy_tpl.h.

                                                                                       {
    ITestPolicy< GUM_ELEMENT >::addObservation(attr, value);
    _sumO_ += value;
 
    if (_sumAttrTable_.exists(attr)) _sumAttrTable_[attr] += value;
    else _sumAttrTable_.insert(attr, value);
 
    if (_nbObsTable_.exists(attr)) _nbObsTable_[attr]++;
    else _nbObsTable_.insert(attr, 1);
 
    if (!_obsTable_.exists(attr)) _obsTable_.insert(attr, new LinkedList< double >());
    _obsTable_[attr]->addLink(value);
  }

References _nbObsTable_, _obsTable_, _sumAttrTable_, _sumO_, and gum::ITestPolicy< GUM_ELEMENT >::addObservation().

Here is the call graph for this function:

computeScore() [1/2]

template<typename GUM_ELEMENT>

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

virtualinherited

Recomputes the statistic from the beginning.

Reimplemented in gum::Chi2TestPolicy< GUM_ELEMENT >, and gum::GTestPolicy< GUM_ELEMENT >.

Definition at line 81 of file ITestPolicy_tpl.h.

                                                      {
    _isModified_ = false;
  }

References _isModified_.

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

Here is the caller graph for this function:

computeScore() [2/2]

template<typename GUM_ELEMENT>

void gum::LeastSquareTestPolicy< GUM_ELEMENT >::computeScore

(

)

Returns the performance of current variable according to the test.

Definition at line 96 of file leastSquareTestPolicy_tpl.h.

                                                          {
    ITestPolicy< GUM_ELEMENT >::computeScore();
    double mean         = _sumO_ / (double)this->nbObservation();
    double errorO       = 0.0;
    double sumErrorAttr = 0.0;
    for (auto attrIter = _sumAttrTable_.cbeginSafe(); attrIter != _sumAttrTable_.cendSafe();
         ++attrIter) {
      Idx    key       = attrIter.key();
      double meanAttr  = _sumAttrTable_[key] / (double)_nbObsTable_[key];
      double errorAttr = 0.0;
 
      const Link< double >* linky = _obsTable_[key]->list();
      while (linky) {
        errorAttr += std::pow(linky->element() - meanAttr, 2);
        errorO += std::pow(linky->element() - mean, 2);
        linky = linky->nextLink();
      }
 
      sumErrorAttr += ((double)_nbObsTable_[key] / (double)this->nbObservation()) * errorAttr;
    }
    _score_ = errorO - sumErrorAttr;
  }

References _nbObsTable_, _obsTable_, _score_, _sumAttrTable_, _sumO_, gum::ITestPolicy< GUM_ELEMENT >::computeScore(), gum::Link< T >::element(), gum::ITestPolicy< GUM_ELEMENT >::nbObservation(), and gum::Link< T >::nextLink().

Referenced by score(), and secondaryscore().

Here is the call graph for this function:

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::LeastSquareTestPolicy< GUM_ELEMENT >::isTestRelevant ( ) const

virtual

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

Implements gum::ITestPolicy< GUM_ELEMENT >.

Definition at line 180 of file leastSquareTestPolicy_tpl.h.

                                                                  {
    return (this->nbObservation() > 20);
  }

References 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:

nbObsTable()

template<typename GUM_ELEMENT>

const HashTable< Idx, Idx > & gum::LeastSquareTestPolicy< GUM_ELEMENT >::nbObsTable

(

)

const

Returns nbobs per modality table (needed for the merging).

Definition at line 190 of file leastSquareTestPolicy_tpl.h.

                                                                                      {
    return _nbObsTable_;
  }

References _nbObsTable_.

Referenced by add().

Here is the caller graph for this function:

obsTable()

template<typename GUM_ELEMENT>

const HashTable< Idx, LinkedList< double > * > & gum::LeastSquareTestPolicy< GUM_ELEMENT >::obsTable

(

)

const

Returns global sum (needed for the merging).

Definition at line 201 of file leastSquareTestPolicy_tpl.h.

                                                           {
    return _obsTable_;
  }

References _obsTable_.

Referenced by add().

Here is the caller graph for this function:

operator delete()

template<typename GUM_ELEMENT>

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

(

void *

p

)

Constructor.

Definition at line 175 of file leastSquareTestPolicy_tpl.h.

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

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

Here is the call graph for this function:

operator new()

template<typename GUM_ELEMENT>

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

(

size_t

s

)

Allocators and Deallocators redefinition.

Definition at line 170 of file leastSquareTestPolicy_tpl.h.

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

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

Here is the call graph for this function:

score() [1/2]

template<typename GUM_ELEMENT>

virtual double gum::ITestPolicy< GUM_ELEMENT >::score ( ) const

pure virtualinherited

Returns the performance of current variable according to the test.

Implemented in gum::Chi2TestPolicy< GUM_ELEMENT >, and gum::GTestPolicy< GUM_ELEMENT >.

score() [2/2]

template<typename GUM_ELEMENT>

double gum::LeastSquareTestPolicy< GUM_ELEMENT >::score

(

)

Returns the performance of current variable according to the test.

Definition at line 123 of file leastSquareTestPolicy_tpl.h.

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

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

Here is the call graph for this function:

secondaryscore()

template<typename GUM_ELEMENT>

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

virtual

Returns a second criterion to severe ties.

Implements gum::ITestPolicy< GUM_ELEMENT >.

Definition at line 132 of file leastSquareTestPolicy_tpl.h.

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

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

Here is the call graph for this function:

sumAttrTable()

template<typename GUM_ELEMENT>

const HashTable< Idx, double > & gum::LeastSquareTestPolicy< GUM_ELEMENT >::sumAttrTable

(

)

const

Returns sum per modality table (needed for the merging).

Definition at line 195 of file leastSquareTestPolicy_tpl.h.

                                                                                           {
    return _sumAttrTable_;
  }

References _sumAttrTable_.

Referenced by add().

Here is the caller graph for this function:

sumValue()

template<typename GUM_ELEMENT>

double gum::LeastSquareTestPolicy< GUM_ELEMENT >::sumValue

(

)

const

Returns global sum (needed for the merging).

Definition at line 185 of file leastSquareTestPolicy_tpl.h.

                                                              {
    return _sumO_;
  }

References _sumO_.

toString()

template<typename GUM_ELEMENT>

std::string gum::ITestPolicy< GUM_ELEMENT >::toString ( ) const

inherited

Definition at line 92 of file ITestPolicy_tpl.h.

                                                       {
    return std::format("\t\t\tNb Obs : {}\n", _nbObs_);
  }

References _nbObs_.

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

Here is the caller graph for this function:

Member Data Documentation

_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().

_nbObsTable_

template<typename GUM_ELEMENT>

HashTable< Idx, Idx > gum::LeastSquareTestPolicy< GUM_ELEMENT >::_nbObsTable_

private

Nb Observation for each modality assumed by variable.

Definition at line 183 of file leastSquareTestPolicy.h.

Referenced by add(), addObservation(), computeScore(), and nbObsTable().

_obsTable_

template<typename GUM_ELEMENT>

HashTable< Idx, LinkedList< double >* > gum::LeastSquareTestPolicy< GUM_ELEMENT >::_obsTable_

private

Not sure if needed.

Definition at line 189 of file leastSquareTestPolicy.h.

Referenced by ~LeastSquareTestPolicy(), add(), addObservation(), computeScore(), and obsTable().

_score_

template<typename GUM_ELEMENT>

double gum::LeastSquareTestPolicy< GUM_ELEMENT >::_score_

private

Keeping computed score.

Definition at line 192 of file leastSquareTestPolicy.h.

Referenced by LeastSquareTestPolicy(), computeScore(), score(), and secondaryscore().

_sumAttrTable_

template<typename GUM_ELEMENT>

HashTable< Idx, double > gum::LeastSquareTestPolicy< GUM_ELEMENT >::_sumAttrTable_

private

Sum for each modality assumed by variable.

Definition at line 186 of file leastSquareTestPolicy.h.

Referenced by add(), addObservation(), computeScore(), and sumAttrTable().

_sumO_

template<typename GUM_ELEMENT>

double gum::LeastSquareTestPolicy< GUM_ELEMENT >::_sumO_

private

Global sum.

Definition at line 180 of file leastSquareTestPolicy.h.

Referenced by LeastSquareTestPolicy(), addObservation(), computeScore(), and sumValue().

---

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

• agrum/FMDP/learning/core/testPolicy/leastSquareTestPolicy.h
• agrum/FMDP/learning/core/testPolicy/leastSquareTestPolicy_tpl.h