contingencyTable.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                           *
 *                                                                          *
 ****************************************************************************/
 

 
 
#ifndef GUM_CONTINGENCY_TABLE_H
#define GUM_CONTINGENCY_TABLE_H
 
#include <agrum/FMDP/learning/observation.h>
 
#include <agrum/base/core/math/math_utils.h>
 
namespace gum {

 
  template < typename GUM_ELEMENT_A, typename GUM_ELEMENT_B >
  class ContingencyTable {
    public:
    // ##########################################################################
    // ##########################################################################
 

 
    ContingencyTable();
 

 
    ~ContingencyTable();
 
    // ============================================================================
    // ============================================================================
    void* operator new(size_t s);
 
    void operator delete(void* p);

 


 

 
    void add(GUM_ELEMENT_A valueA, GUM_ELEMENT_B valueB);

 
    Idx joint(GUM_ELEMENT_A valueA, GUM_ELEMENT_B valueB) const;

 
    Idx attrAMarginal(GUM_ELEMENT_A valueA) const;

 
    Idx attrBMarginal(GUM_ELEMENT_B valueB) const;

 
    //        Idx aMarginal( GUM_ELEMENT_A iattr ) { return
    //         _attrMarginalTable_[iattr]; }
    HashTableConstIteratorSafe< GUM_ELEMENT_A, Idx > attrABeginSafe() const;
 
    HashTableConstIteratorSafe< GUM_ELEMENT_A, Idx > attrAEndSafe() const;

 
    //        Idx vMarginal( GUM_ELEMENT_B ivalue ) { return
    //         _valueMarginalTable_[ivalue]; }
    HashTableConstIteratorSafe< GUM_ELEMENT_B, Idx > attrBBeginSafe() const;
 
    HashTableConstIteratorSafe< GUM_ELEMENT_B, Idx > attrBEndSafe() const;

 
    Idx attrASize() const;

 
    Idx attrBSize() const;

 
    ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >&
        operator+=(const ContingencyTable< GUM_ELEMENT_A, GUM_ELEMENT_B >& src);
 
    std::string toString() const;
 
    private:
    HashTable< std::pair< GUM_ELEMENT_A, GUM_ELEMENT_B >, Idx > _jointTable_;
    HashTable< GUM_ELEMENT_A, Idx >                             _attrAMarginalTable_;
    HashTable< GUM_ELEMENT_B, Idx >                             _attrBMarginalTable_;
  };
 
} /* namespace gum */
 
#include <agrum/FMDP/learning/core/contingencyTable_tpl.h>
#endif   // GUM_CONTINGENCY_TABLE_H