contingencyTable.h

Go to the documentation of this file.

#ifndef GUM_CONTINGENCY_TABLE_H
#define GUM_CONTINGENCY_TABLE_H

#include <agrum/core/math/math.h>
#include <agrum/core/hashTable.h>
#include <agrum/core/set.h>
#include <agrum/core/smallobjectallocator/smallObjectAllocator.h>

#include <agrum/FMDP/learning/observation.h>

#include <agrum/variables/discreteVariable.h>


namespace gum {

  template < typename GUM_SCALAR_A, typename GUM_SCALAR_B >
  class ContingencyTable {
    public:
    // ##########################################################################
    // ##########################################################################



    ContingencyTable();



    ~ContingencyTable();

    // ============================================================================
    // ============================================================================
    void* operator new(size_t s) {
      return SmallObjectAllocator::instance().allocate(s);
    }
    void operator delete(void* p) {
      SmallObjectAllocator::instance().deallocate(p, sizeof(ContingencyTable));
    }







    void add(GUM_SCALAR_A valueA, GUM_SCALAR_B valueB);



    Idx joint(GUM_SCALAR_A valueA, GUM_SCALAR_B valueB) const {
      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;
    }



    Idx attrAMarginal(GUM_SCALAR_A valueA) const {
      return __attrAMarginalTable.exists(valueA) ? __attrAMarginalTable[valueA]
                                                 : 0;
    }



    Idx attrBMarginal(GUM_SCALAR_B valueB) const {
      return __attrAMarginalTable.exists(valueB) ? __attrAMarginalTable[valueB]
                                                 : 0;
    }



    //        Idx aMarginal( GUM_SCALAR_A iattr ) { return
    //        __attrMarginalTable[iattr]; }
    HashTableConstIteratorSafe< GUM_SCALAR_A, Idx > attrABeginSafe() const {
      return __attrAMarginalTable.cbeginSafe();
    }
    HashTableConstIteratorSafe< GUM_SCALAR_A, Idx > attrAEndSafe() const {
      return __attrAMarginalTable.cendSafe();
    }



    //        Idx vMarginal( GUM_SCALAR_B ivalue ) { return
    //        __valueMarginalTable[ivalue]; }
    HashTableConstIteratorSafe< GUM_SCALAR_B, Idx > attrBBeginSafe() const {
      return __attrBMarginalTable.cbeginSafe();
    }
    HashTableConstIteratorSafe< GUM_SCALAR_B, Idx > attrBEndSafe() const {
      return __attrBMarginalTable.cendSafe();
    }



    Idx attrASize() const { return __attrAMarginalTable.size(); }



    Idx attrBSize() const { return __attrBMarginalTable.size(); }


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

    std::string toString() const {
      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();
    }

    private:
    HashTable< std::pair< GUM_SCALAR_A, GUM_SCALAR_B >, Idx > __jointTable;
    HashTable< GUM_SCALAR_A, Idx >                            __attrAMarginalTable;
    HashTable< GUM_SCALAR_B, Idx >                            __attrBMarginalTable;
  };

} /* namespace gum */

#include <agrum/FMDP/learning/core/contingencyTable_tpl.h>
#endif   // GUM_CONTINGENCY_TABLE_H