multipleInferenceEngine.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 __MULTIPLE_INFERENCE_ENGINES__H__
#define __MULTIPLE_INFERENCE_ENGINES__H__


 
#include <agrum/BN/inference/lazyPropagation.h>
#include <agrum/CN/inference/inferenceEngine.h>
 
namespace gum {
  namespace credal {

    template < typename GUM_SCALAR, class BNInferenceEngine >
    class MultipleInferenceEngine: public InferenceEngine< GUM_SCALAR > {
      private:
      using _infE_ = InferenceEngine< GUM_SCALAR >;
 
      using _cluster_   = NodeProperty< std::vector< NodeId > >;
      using _credalSet_ = NodeProperty< std::vector< std::vector< GUM_SCALAR > > >;
      using _margi_     = NodeProperty< std::vector< GUM_SCALAR > >;
      using _expe_      = NodeProperty< GUM_SCALAR >;
 
      using _bnet_       = IBayesNet< GUM_SCALAR >;
      using _margis_     = std::vector< _margi_ >;
      using _expes_      = std::vector< _expe_ >;
      using _credalSets_ = std::vector< _credalSet_ >;
      using _clusters_   = std::vector< std::vector< _cluster_ > >;
 
      using _modals_ = std::vector< HashTable< std::string, std::vector< GUM_SCALAR > > >;

      inline void _updateThreadCredalSets_(Size                             this_thread,
                                           const NodeId&                    id,
                                           const std::vector< GUM_SCALAR >& vertex,
                                           const bool&                      elimRedund);
 
      protected:
      _margis_ l_marginalMin_;
      _margis_ l_marginalMax_;
      _expes_ l_expectationMin_;
      _expes_ l_expectationMax_;
      _modals_ l_modal_;
      _credalSets_ l_marginalSets_;
      _margis_ l_evidence_;
      _clusters_ l_clusters_;
 

      typename std::vector< _bnet_* > workingSet_;
      typename std::vector< List< const Tensor< GUM_SCALAR >* >* > workingSetE_;

      typename std::vector< BNInferenceEngine* > l_inferenceEngine_;
      std::vector< VarMod2BNsMap< GUM_SCALAR >* > l_optimalNet_;

      std::vector< std::mt19937 > generators_;

      // OptBN< GUM_SCALAR > threadFusion_; // we should use this OptBN if omp
      // is
      // disabled (avoid creating 2 objects when only one is necessary)
      // it should also avoid calling thread fusion operations


      void initThreadsData_(const Size& num_threads,
                            const bool  _storeVertices_,
                            const bool  _storeBNOpt_);



      inline bool updateThread_(Size                             this_thread,
                                const NodeId&                    id,
                                const std::vector< GUM_SCALAR >& vertex,
                                const bool&                      elimRedund = false);

      inline void updateMarginals_();

      inline const GUM_SCALAR computeEpsilon_();

      void updateOldMarginals_();



      void optFusion_();
      void expFusion_();
      void verticesFusion_();   // called ?? not done yet

 
      public:

      explicit MultipleInferenceEngine(const CredalNet< GUM_SCALAR >& credalNet);

      virtual ~MultipleInferenceEngine();



      virtual void eraseAllEvidence();


      virtual void makeInference() = 0;

    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class MultipleInferenceEngine< double, gum::LazyPropagation< double > >;
 
    extern template class MultipleInferenceEngine< float, gum::LazyPropagation< float > >;
#endif
 
  }   // namespace credal
}   // namespace gum
 
#include <agrum/CN/inference/multipleInferenceEngine_tpl.h>
 
#endif