CNLoopyPropagation.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_CN_LOOPY_PROPAGATION_H
#define GUM_CN_LOOPY_PROPAGATION_H
 
#include <cstdlib>
#include <ctime>
#include <limits>
 
#include <agrum/CN/inference/inferenceEngine.h>
 
#include <string_view>
 
#define INF_ std::numeric_limits< GUM_SCALAR >::infinity()
 
namespace gum {
  namespace credal {

    template < GUM_Numeric GUM_SCALAR >
    class PYGUM_PUBLIC CNLoopyPropagation: public InferenceEngine< GUM_SCALAR > {
      public:
      using msg   = std::vector< Tensor< GUM_SCALAR >* >;
      using cArcP = const class gum::Arc*;   // 'class' disambiguates from GDI Arc on Windows

      enum class InferenceType : char {
        nodeToNeighbours, 
 
        ordered,          
 
        randomOrder       
      };


      void makeInference() override;
 
      void insertEvidenceFile(std::string_view path) override;



      void inferenceType(InferenceType inft);

      InferenceType inferenceType();



      void eraseAllEvidence() override;

      void saveInference(std::string_view path);



      explicit CNLoopyPropagation(const CredalNet< GUM_SCALAR >& credalNet);
      ~CNLoopyPropagation() override;
 
      protected:

      void initialize_();



      void makeInferenceNodeToNeighbours_();
      void makeInferenceByOrderedArcs_();
      void makeInferenceByRandomOrder_();

      void updateMarginals_();

      void msgL_(const NodeId X,
                 const NodeId demanding_parent);   // allways sent from X to demanding_X

      void compute_ext_(GUM_SCALAR&                msg_l_min,
                        GUM_SCALAR&                msg_l_max,
                        std::vector< GUM_SCALAR >& lx,
                        GUM_SCALAR&                num_min,
                        GUM_SCALAR&                num_max,
                        GUM_SCALAR&                den_min,
                        GUM_SCALAR&                den_max);

      void compute_ext_(std::vector< std::vector< GUM_SCALAR > >& combi_msg_p,
                        const NodeId&                             id,
                        GUM_SCALAR&                               msg_l_min,
                        GUM_SCALAR&                               msg_l_max,
                        std::vector< GUM_SCALAR >&                lx,
                        const Idx&                                pos);

      void enum_combi_(std::vector< std::vector< std::vector< GUM_SCALAR > > >& msgs_p,
                       const NodeId&                                            id,
                       GUM_SCALAR&                                              msg_l_min,
                       GUM_SCALAR&                                              msg_l_max,
                       std::vector< GUM_SCALAR >&                               lx,
                       const Idx&                                               pos);

      void msgP_(const NodeId X, const NodeId demanding_child);

      void enum_combi_(std::vector< std::vector< std::vector< GUM_SCALAR > > >& msgs_p,
                       const NodeId&                                            id,
                       GUM_SCALAR&                                              msg_p_min,
                       GUM_SCALAR&                                              msg_p_max);

      void compute_ext_(std::vector< std::vector< GUM_SCALAR > >& combi_msg_p,
                        const NodeId&                             id,
                        GUM_SCALAR&                               msg_p_min,
                        GUM_SCALAR&                               msg_p_max);

      void refreshLMsPIs_(bool refreshIndic = false);

      GUM_SCALAR calculateEpsilon_();



      void computeExpectations_();

      void updateIndicatrices_();


      NodeProperty< bool > update_p_;
      NodeProperty< bool > update_l_;

      NodeSet active_nodes_set_;
      NodeSet next_active_nodes_set_;

      NodeProperty< NodeSet* > msg_l_sent_;

      ArcProperty< GUM_SCALAR > ArcsL_min_;
      ArcProperty< GUM_SCALAR > ArcsP_min_;
      NodeProperty< GUM_SCALAR > NodesL_min_;
      NodeProperty< GUM_SCALAR > NodesP_min_;

      ArcProperty< GUM_SCALAR > ArcsL_max_;
      ArcProperty< GUM_SCALAR > ArcsP_max_;
      NodeProperty< GUM_SCALAR > NodesL_max_;
      NodeProperty< GUM_SCALAR > NodesP_max_;

      bool inference_up_to_date_;
 
      private:
      using _infE_ = InferenceEngine< GUM_SCALAR >;

      InferenceType _inferenceType_;

      const CredalNet< GUM_SCALAR >* _cn_;

      const IBayesNet< GUM_SCALAR >* _bnet_;
 
      // cnfunc getCN = &infE::getCN;
    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class CNLoopyPropagation< double >;
#endif
  }   // namespace credal
}   // namespace gum
 
#include <agrum/CN/inference/CNLoopyPropagation_tpl.h>
 
#endif