structuredBayesBall.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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                           *
 *                                                                          *
 ****************************************************************************/
 

 
#include <sstream>
#include <string>
#include <utility>
 
#include <agrum/PRM/inference/PRMInference.h>
 
#ifndef GUM_STRUCTURED_BB_H
#  define GUM_STRUCTURED_BB_H
 
namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class StructuredBayesBall {
      public:
      // ========================================================================
      // ========================================================================

      StructuredBayesBall(const PRMInference< GUM_SCALAR >& inference);

      ~StructuredBayesBall();

      // ========================================================================
      // ========================================================================

      const std::string& key(const PRMInstance< GUM_SCALAR >* i) const;

      const std::string& key(const PRMInstance< GUM_SCALAR >& i) const;

      const Set< NodeId >& requisiteNodes(const PRMInstance< GUM_SCALAR >* i) const;

      const Set< NodeId >& requisiteNodes(const PRMInstance< GUM_SCALAR >& i) const;

      Size occurrence(const std::string& key) const;

      float liftRatio() const;

      bool exists(const PRMInstance< GUM_SCALAR >* i) const;

      bool exists(const PRMInstance< GUM_SCALAR >& i) const;


      void compute(const PRMInstance< GUM_SCALAR >* i, NodeId n);

      void compute(const PRMInstance< GUM_SCALAR >& i, NodeId n);

      bool _isHardEvidence_(const PRMInstance< GUM_SCALAR >* i, NodeId n);
 
      private:
      StructuredBayesBall(const StructuredBayesBall& source);

      StructuredBayesBall& operator=(const StructuredBayesBall& source);

      using MarkMap     = HashTable< NodeId, std::pair< bool, bool > >;
      using InstanceMap = HashTable< const PRMInstance< GUM_SCALAR >*, MarkMap* >;

      std::pair< bool, bool >&
          _getMark_(InstanceMap& marks, const PRMInstance< GUM_SCALAR >* i, NodeId n);
      const PRMSlotChain< GUM_SCALAR >& _getSC_(const PRMInstance< GUM_SCALAR >* i, NodeId n);

      void _clean_();

      void _compute_(const PRMInstance< GUM_SCALAR >* i, NodeId n);

      void _fromChild_(const PRMInstance< GUM_SCALAR >* i, NodeId n, InstanceMap& marks);

      void _fromParent_(const PRMInstance< GUM_SCALAR >* i, NodeId n, InstanceMap& marks);

      void _fillMaps_(InstanceMap& marks);

      std::string _buildHashKey_(const PRMInstance< GUM_SCALAR >* i, Set< NodeId >& req_nodes);

      const PRMInference< GUM_SCALAR >* _inf_;

      HashTable< const PRMInstance< GUM_SCALAR >*, std::pair< std::string, Set< NodeId >* > >
          _keyMap_;

      HashTable< std::string, std::pair< Set< NodeId >*, Size > > _reqMap_;
    };
 
 
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class StructuredBayesBall< double >;
#  endif
 
 
  } /* namespace prm */
} /* namespace gum */
 
#  include <agrum/PRM/inference/structuredBayesBall_tpl.h>
 
#endif /* GUM_STRUCTURED_BB_H */