<agrum/FMDP/learning/core/contingencyTable.h> More...

#include <contingencyTable.h>

Collaboration diagram for gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >:

Public Member Functions
ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B > &	operator+= (const ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B > &src)

std::string	toString () const

Constructor & destructor.
	ContingencyTable ()
	Default constructor. More...

	~ContingencyTable ()
	Default destructor. More...

void *	operator new (size_t s)
	Allocators and Deallocators redefinition. More...

void	operator delete (void *p)
	Default constructor. More...


void	add (GUM_SCALAR_A valueA, GUM_SCALAR_B valueB)
	Increments the number of sample for case( iattr, ivalue ) More...

Idx	joint (GUM_SCALAR_A valueA, GUM_SCALAR_B valueB) const
	Returns the number of samples for case (iattr, ivalue) More...

Idx	attrAMarginal (GUM_SCALAR_A valueA) const
	Returns the number of samples for case (iattr, ivalue) More...

Idx	attrBMarginal (GUM_SCALAR_B valueB) const
	Returns the number of samples for case (iattr, ivalue) More...

HashTableConstIteratorSafe< GUM_SCALAR_A, Idx >	attrABeginSafe () const
	Returns the number of samples for line iattr. More...

HashTableConstIteratorSafe< GUM_SCALAR_A, Idx >	attrAEndSafe () const
	Increments the number of sample for case( iattr, ivalue ) More...

HashTableConstIteratorSafe< GUM_SCALAR_B, Idx >	attrBBeginSafe () const
	Returns the number of samples for column ivalue. More...

HashTableConstIteratorSafe< GUM_SCALAR_B, Idx >	attrBEndSafe () const
	Increments the number of sample for case( iattr, ivalue ) More...

Idx	attrASize () const
	Returns the number of samples for line iattr. More...

Idx	attrBSize () const
	Returns the number of samples for column ivalue. More...

Detailed Description

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>
class gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >

Definition at line 57 of file contingencyTable.h.

Constructor & Destructor Documentation

◆ ContingencyTable()

template<typename GUM_SCALAR_A , typename GUM_SCALAR_B >

gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::ContingencyTable ( )

Default constructor.

Definition at line 44 of file contingencyTable_tpl.h.

                                                                    {
     GUM_CONSTRUCTOR(ContingencyTable);
   }

◆ ~ContingencyTable()

template<typename GUM_SCALAR_A , typename GUM_SCALAR_B >

gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::~ContingencyTable ( )

Default destructor.

Definition at line 53 of file contingencyTable_tpl.h.

                                                                     {
     GUM_DESTRUCTOR(ContingencyTable);
   }

Member Function Documentation

◆ add()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

void gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::add	(	GUM_SCALAR_A	valueA,
		GUM_SCALAR_B	valueB
	)

Increments the number of sample for case( iattr, ivalue )

Definition at line 66 of file contingencyTable_tpl.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::operator delete().

                                                                                 {
     // Updating
     if (__attrAMarginalTable.exists(valueA))
       __attrAMarginalTable[valueA]++;
     else
       __attrAMarginalTable.insert(valueA, 1);
 
     if (__attrBMarginalTable.exists(valueB))
       __attrBMarginalTable[valueB]++;
     else
       __attrBMarginalTable.insert(valueB, 1);
 
     std::pair< GUM_SCALAR_A, GUM_SCALAR_B > cell(valueA, valueB);
     if (__jointTable.exists(cell))
       __jointTable[cell]++;
     else
       __jointTable.insert(cell, 1);
   }

Here is the caller graph for this function:

◆ attrABeginSafe()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

HashTableConstIteratorSafe< GUM_SCALAR_A, Idx > gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrABeginSafe ( ) const

inline

Returns the number of samples for line iattr.

Definition at line 128 of file contingencyTable.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::operator+=().

                                                                            {
       return __attrAMarginalTable.cbeginSafe();
     }

Here is the caller graph for this function:

◆ attrAEndSafe()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

HashTableConstIteratorSafe< GUM_SCALAR_A, Idx > gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrAEndSafe ( ) const

inline

Increments the number of sample for case( iattr, ivalue )

Definition at line 131 of file contingencyTable.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::operator+=().

                                                                          {
       return __attrAMarginalTable.cendSafe();
     }

Here is the caller graph for this function:

◆ attrAMarginal()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

Idx gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrAMarginal ( GUM_SCALAR_A valueA ) const

inline

Returns the number of samples for case (iattr, ivalue)

Definition at line 110 of file contingencyTable.h.

                                                  {
       return __attrAMarginalTable.exists(valueA) ? __attrAMarginalTable[valueA]
                                                  : 0;
     }

◆ attrASize()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

Idx gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrASize ( ) const

inline

Returns the number of samples for line iattr.

Definition at line 150 of file contingencyTable.h.

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

150 { return __attrAMarginalTable.size(); }

gum::HashTable::size

Size size() const noexcept

Returns the number of elements stored into the hashtable.

Definition: hashTable_tpl.h:736

gum::ContingencyTable::__attrAMarginalTable

HashTable< GUM_SCALAR_A, Idx > __attrAMarginalTable

Definition: contingencyTable.h:181

Here is the caller graph for this function:

◆ attrBBeginSafe()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

HashTableConstIteratorSafe< GUM_SCALAR_B, Idx > gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrBBeginSafe ( ) const

inline

Returns the number of samples for column ivalue.

Definition at line 140 of file contingencyTable.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::operator+=().

                                                                            {
       return __attrBMarginalTable.cbeginSafe();
     }

Here is the caller graph for this function:

◆ attrBEndSafe()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

HashTableConstIteratorSafe< GUM_SCALAR_B, Idx > gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrBEndSafe ( ) const

inline

Increments the number of sample for case( iattr, ivalue )

Definition at line 143 of file contingencyTable.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::operator+=().

                                                                          {
       return __attrBMarginalTable.cendSafe();
     }

Here is the caller graph for this function:

◆ attrBMarginal()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

Idx gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrBMarginal ( GUM_SCALAR_B valueB ) const

inline

Returns the number of samples for case (iattr, ivalue)

Definition at line 118 of file contingencyTable.h.

                                                  {
       return __attrAMarginalTable.exists(valueB) ? __attrAMarginalTable[valueB]
                                                  : 0;
     }

◆ attrBSize()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

Idx gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::attrBSize ( ) const

inline

Returns the number of samples for column ivalue.

Definition at line 155 of file contingencyTable.h.

155 { return __attrBMarginalTable.size(); }

gum::HashTable::size

Size size() const noexcept

Returns the number of elements stored into the hashtable.

Definition: hashTable_tpl.h:736

gum::ContingencyTable::__attrBMarginalTable

HashTable< GUM_SCALAR_B, Idx > __attrBMarginalTable

Definition: contingencyTable.h:182

◆ joint()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

Idx gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::joint	(	GUM_SCALAR_A	valueA,
		GUM_SCALAR_B	valueB
	)		const

inline

Returns the number of samples for case (iattr, ivalue)

Definition at line 99 of file contingencyTable.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::operator+=().

                                                               {
       return __jointTable.exists(
                 std::pair< GUM_SCALAR_A, GUM_SCALAR_B >(valueA, valueB))
                 ? __jointTable[std::pair< GUM_SCALAR_A, GUM_SCALAR_B >(valueA,
                                                                        valueB)]
                 : 0;
     }

Here is the caller graph for this function:

◆ operator delete()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

void gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::operator delete ( void * p )

inline

Default constructor.

Definition at line 80 of file contingencyTable.h.

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

◆ operator new()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

void* gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::operator new ( size_t s )

inline

Allocators and Deallocators redefinition.

Definition at line 77 of file contingencyTable.h.

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

◆ operator+=()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B > & gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::operator+= ( const ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B > & src )

Definition at line 89 of file contingencyTable_tpl.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::add(), and gum::ContingencyTable< Idx, GUM_SCALAR >::attrBSize().

                                                                               {
     // Ajout dans marginal A et table joint des valeurs pour src
     for (auto aTer = src.attrABeginSafe(); aTer != src.attrAEndSafe(); ++aTer) {
       if (__attrAMarginalTable.exists(aTer.key()))
         __attrAMarginalTable[aTer.key()] += aTer.val();
       else
         __attrAMarginalTable.insert(aTer.key(), aTer.val());
 
       for (auto bTer = src.attrBBeginSafe(); bTer != src.attrBEndSafe(); ++bTer) {
         std::pair< GUM_SCALAR_A, GUM_SCALAR_B > cell(aTer.key(), bTer.key());
         if (__jointTable.exists(cell))
           __jointTable[cell] += src.joint(aTer.key(), bTer.key());
         else
           __jointTable.insert(cell, src.joint(aTer.key(), bTer.key()));
       }
     }
 
     // Ajout dans marginal B des valeurs de src
     for (auto bTer = src.attrBBeginSafe(); bTer != src.attrBEndSafe(); ++bTer) {
       if (__attrBMarginalTable.exists(bTer.key()))
         __attrBMarginalTable[bTer.key()] += bTer.val();
       else
         __attrBMarginalTable.insert(bTer.key(), bTer.val());
     }
     return *this;
   }

Here is the caller graph for this function:

◆ toString()

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

std::string gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::toString ( ) const

inline

Definition at line 162 of file contingencyTable.h.

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

                                {
       std::stringstream ss;
       ss << "\t\t\t\t" << __attrAMarginalTable << std::endl
          << "\t\t\t\t" << __attrBMarginalTable << std::endl
          << "\t\t\t\t" << __jointTable << std::endl;
       return ss.str();
     }

Here is the caller graph for this function:

Member Data Documentation

◆ __attrAMarginalTable

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

HashTable< GUM_SCALAR_A, Idx > gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::__attrAMarginalTable

private

Definition at line 181 of file contingencyTable.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::attrABeginSafe(), gum::ContingencyTable< Idx, GUM_SCALAR >::attrAEndSafe(), gum::ContingencyTable< Idx, GUM_SCALAR >::attrAMarginal(), gum::ContingencyTable< Idx, GUM_SCALAR >::attrASize(), gum::ContingencyTable< Idx, GUM_SCALAR >::attrBMarginal(), and gum::ContingencyTable< Idx, GUM_SCALAR >::toString().

◆ __attrBMarginalTable

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

HashTable< GUM_SCALAR_B, Idx > gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::__attrBMarginalTable

private

Definition at line 182 of file contingencyTable.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::attrBBeginSafe(), gum::ContingencyTable< Idx, GUM_SCALAR >::attrBEndSafe(), gum::ContingencyTable< Idx, GUM_SCALAR >::attrBSize(), and gum::ContingencyTable< Idx, GUM_SCALAR >::toString().

◆ __jointTable

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>

HashTable< std::pair< GUM_SCALAR_A, GUM_SCALAR_B >, Idx > gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >::__jointTable

private

The contingency table used to compute the GStat Left Idx is for the attribute Right Idx for the value.

NB: This is a silly and in a hurry implementation of contingency table If someone ever use this class and has time to correctly implements a efficient contingency table, you're welcome

Definition at line 180 of file contingencyTable.h.

Referenced by gum::ContingencyTable< Idx, GUM_SCALAR >::joint(), and gum::ContingencyTable< Idx, GUM_SCALAR >::toString().

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

agrum/FMDP/learning/core/contingencyTable.h
agrum/FMDP/learning/core/contingencyTable_tpl.h

Public Member Functions

Detailed Description

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B> class gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >

Constructor & Destructor Documentation

◆ ContingencyTable()

◆ ~ContingencyTable()

Member Function Documentation

◆ add()

◆ attrABeginSafe()

◆ attrAEndSafe()

◆ attrAMarginal()

◆ attrASize()

◆ attrBBeginSafe()

◆ attrBEndSafe()

◆ attrBMarginal()

◆ attrBSize()

◆ joint()

◆ operator delete()

◆ operator new()

◆ operator+=()

◆ toString()

Member Data Documentation

◆ __attrAMarginalTable

◆ __attrBMarginalTable

◆ __jointTable

template<typename GUM_SCALAR_A, typename GUM_SCALAR_B>
class gum::ContingencyTable< GUM_SCALAR_A, GUM_SCALAR_B >