contingencyTable_tpl.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once
 

// =========================================================================
#include <agrum/FMDP/learning/core/contingencyTable.h>
 
// =========================================================================
 
 
namespace gum {
 
  // ##########################################################################
  // Constructor & destructor.
  // ##########################################################################
 
  // ==========================================================================
  // Default constructor
  // ==========================================================================
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::ContingencyTable() {
    GUM_CONSTRUCTOR(ContingencyTable);
  }
 
  // ==========================================================================
  // Default destructor
  // ==========================================================================
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::~ContingencyTable() {
    GUM_DESTRUCTOR(ContingencyTable);
  }
 
  // ##########################################################################
  //
  // ##########################################################################
 
  // ==========================================================================
  //
  // ==========================================================================
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  void ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::add(GUM_ELEMENT_A valueA,
                                                             GUM_ELEMENT_B valueB) {
    // 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_ELEMENT_A, GUM_ELEMENT_B > cell(valueA, valueB);
    if (_jointTable_.exists(cell)) _jointTable_[cell]++;
    else _jointTable_.insert(cell, 1);
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >&
      ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::operator+=(
          const ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >& src) {
    // 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_ELEMENT_A, GUM_ELEMENT_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;
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  void* ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::operator new(size_t s) {
    return SmallObjectAllocator::instance().allocate(s);
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  void ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::operator delete(void* p) {
    SmallObjectAllocator::instance().deallocate(p, sizeof(ContingencyTable));
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  Idx ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::joint(GUM_ELEMENT_A valueA,
                                                              GUM_ELEMENT_B valueB) const {
    return _jointTable_.exists(std::pair< GUM_ELEMENT_A, GUM_ELEMENT_B >(valueA, valueB))
             ? _jointTable_[std::pair< GUM_ELEMENT_A, GUM_ELEMENT_B >(valueA, valueB)]
             : 0;
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  Idx ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::attrAMarginal(GUM_ELEMENT_A valueA) const {
    return _attrAMarginalTable_.exists(valueA) ? _attrAMarginalTable_[valueA] : 0;
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  Idx ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::attrBMarginal(GUM_ELEMENT_B valueB) const {
    return _attrAMarginalTable_.exists(valueB) ? _attrAMarginalTable_[valueB] : 0;
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  HashTableConstIteratorSafe< GUM_ELEMENT_A, Idx >
      ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::attrABeginSafe() const {
    return _attrAMarginalTable_.cbeginSafe();
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  HashTableConstIteratorSafe< GUM_ELEMENT_A, Idx >
      ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::attrAEndSafe() const {
    return _attrAMarginalTable_.cendSafe();
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  HashTableConstIteratorSafe< GUM_ELEMENT_B, Idx >
      ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::attrBBeginSafe() const {
    return _attrBMarginalTable_.cbeginSafe();
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  HashTableConstIteratorSafe< GUM_ELEMENT_B, Idx >
      ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::attrBEndSafe() const {
    return _attrBMarginalTable_.cendSafe();
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  Idx ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::attrASize() const {
    return _attrAMarginalTable_.size();
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  Idx ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::attrBSize() const {
    return _attrBMarginalTable_.size();
  }
 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  std::string ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >::toString() const {
    std::ostringstream ss;
    ss << "\t\t\t\t" << _attrAMarginalTable_ << "\n"
       << "\t\t\t\t" << _attrBMarginalTable_ << "\n"
       << "\t\t\t\t" << _jointTable_ << "\n";
    return ss.str();
  }
 
}   // End of namespace gum