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

 
#ifndef GUM_PRM_INFERENCE_H
#define GUM_PRM_INFERENCE_H
 
#include <string>
 
#include <agrum/PRM/PRM.h>
 
namespace gum {
  namespace prm {
    template < typename GUM_SCALAR >
    class PRMInference {
      public:
      using Chain
          = std::pair< const PRMInstance< GUM_SCALAR >*, const PRMAttribute< GUM_SCALAR >* >;

      using EMap = NodeProperty< const Tensor< GUM_SCALAR >* >;

      using EMapIterator = typename NodeProperty< const Tensor< GUM_SCALAR >* >::iterator_safe;

      using EMapConstIterator =
          typename NodeProperty< const Tensor< GUM_SCALAR >* >::const_iterator_safe;
 
      // ========================================================================
      // ========================================================================

      PRMInference(const PRM< GUM_SCALAR >& prm, const PRMSystem< GUM_SCALAR >& system);

      PRMInference(const PRMInference& source);

      virtual ~PRMInference();

      PRMInference& operator=(const PRMInference& source);

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

      virtual std::string name() const = 0;

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

      void posterior(const Chain& chain, Tensor< GUM_SCALAR >& m);

      void joint(const std::vector< Chain >& chains, Tensor< GUM_SCALAR >& j);

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

      EMap& evidence(const PRMInstance< GUM_SCALAR >& i);

      EMap& evidence(const PRMInstance< GUM_SCALAR >* i);

      const EMap& evidence(const PRMInstance< GUM_SCALAR >& i) const;

      const EMap& evidence(const PRMInstance< GUM_SCALAR >* i) const;

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

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

      bool hasEvidence(const Chain& chain) const;

      bool hasEvidence() const;

      void addEvidence(const Chain& chain, const Tensor< GUM_SCALAR >& p);

      void removeEvidence(const Chain& chain);

      void clearEvidence();

 
      protected:
      // ========================================================================
      // ========================================================================

      virtual void evidenceAdded_(const Chain& chain) = 0;

      virtual void evidenceRemoved_(const Chain& chain) = 0;

      virtual void posterior_(const Chain& chain, Tensor< GUM_SCALAR >& m) = 0;

      virtual void joint_(const std::vector< Chain >& queries, Tensor< GUM_SCALAR >& j) = 0;

      PRM< GUM_SCALAR > const* prm_;

      PRMSystem< GUM_SCALAR > const* sys_;

 
      private:
      // ========================================================================
      // ========================================================================

      using EvidenceIterator =
          typename HashTable< const PRMInstance< GUM_SCALAR >*, EMap* >::iterator_safe;
      using EvidenceConstIterator =
          typename HashTable< const PRMInstance< GUM_SCALAR >*, EMap* >::const_iterator_safe;

      HashTable< const PRMInstance< GUM_SCALAR >*, EMap* > _evidences_;

      EMap& _EMap_(const PRMInstance< GUM_SCALAR >* i);

    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMInference< double >;
#endif
 
 
  } /* namespace prm */
} /* namespace gum */
 
#include <agrum/PRM/inference/PRMInference_tpl.h>
 
#endif /* GUM_PRM_INFERENCE_H */