structuredInference.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_STRUCTURED_INFERENCE_H
#define GUM_STRUCTURED_INFERENCE_H
 
#include <string>
 
#include <agrum/PRM/inference/gspan.h>
#include <agrum/PRM/inference/PRMInference.h>
 
namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class StructuredInference: public PRMInference< GUM_SCALAR > {
      public:
      // ========================================================================
      // ========================================================================

      StructuredInference(const PRM< GUM_SCALAR >&             prm,
                          const PRMSystem< GUM_SCALAR >&       system,
                          gspan::SearchStrategy< GUM_SCALAR >* strategy = 0);

      StructuredInference(const StructuredInference& source);

      virtual ~StructuredInference();

      StructuredInference& operator=(const StructuredInference& source);

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

      void setPatternMining(bool b);
 
      virtual std::string name() const;

      GSpan< GUM_SCALAR >& gspan();

      const GSpan< GUM_SCALAR >& gspan() const;

      void searchPatterns();

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

      virtual void evidenceAdded_(const typename PRMInference< GUM_SCALAR >::Chain& chain);

      virtual void evidenceRemoved_(const typename PRMInference< GUM_SCALAR >::Chain& chain);

      virtual void posterior_(const typename PRMInference< GUM_SCALAR >::Chain& chain,
                              Tensor< GUM_SCALAR >&                             m);

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

 
      private:
      struct RGData {
        UndiGraph reducedGraph;
        NodeProperty< Size > mods;
        Bijection< const DiscreteVariable*, NodeId > var2node;
        Set< Tensor< GUM_SCALAR >* > pool;
        List< NodeSet > partial_order;
        RGData();
        ~RGData();

        inline NodeSet& outputs() { return partial_order[0]; }

        inline NodeSet& queries() { return partial_order[1]; }
      };

      struct PData {
        const gspan::Pattern& pattern;
        typename GSpan< GUM_SCALAR >::MatchedInstances& matches;
        UndiGraph graph;
        NodeProperty< Size > mod;
        Bijection< NodeId, std::string > node2attr;
        NodeProperty< std::pair< Idx, std::string > > map;
        Bijection< NodeId, const DiscreteVariable* > vars;
        NodeProperty< Tensor< GUM_SCALAR >* > pots;
        Set< NodeId > barren;
        PData(const gspan::Pattern& p, typename GSpan< GUM_SCALAR >::MatchedInstances& m);
        PData(const PData& source);
        ~PData();

        inline NodeSet& inners() { return _partial_order_[0]; }

        inline NodeSet& obs() { return _partial_order_[1]; }

        inline NodeSet& outputs() { return _partial_order_[2]; }

        inline NodeSet& queries() { return _partial_order_[3]; }
 
        // We use the first match for computations
        // inline const Sequence<PRMInstance<GUM_SCALAR>*>& match() const {
        // return
        // **(matches.begin());}
        // Remove any empty set in partial_order
        const List< NodeSet >* partial_order();
 
        private:
        List< NodeSet > _partial_order_;
        List< NodeSet >* _real_order_;
      };

      struct CData {
        const PRMClass< GUM_SCALAR >& c;
        UndiGraph moral_graph;
        NodeProperty< Size > mods;
        List< NodeSet > partial_order;
        Set< const PRMInstance< GUM_SCALAR >* > instances;
        Set< Tensor< GUM_SCALAR >* > pool;
        CData(const PRMClass< GUM_SCALAR >& c);
        ~CData();

        inline NodeSet& inners() { return _inners_; }

        inline NodeSet& aggregators() { return _aggregators_; }

        inline NodeSet& outputs() { return _outputs_; }

        inline std::vector< NodeId >& elim_order() { return _elim_order_; }
 
        private:
        std::vector< NodeId >        _elim_order_;
        NodeSet                      _inners_;
        NodeSet                      _aggregators_;
        NodeSet                      _outputs_;
        Set< Tensor< GUM_SCALAR >* > _trash_;
      };

      GSpan< GUM_SCALAR >* _gspan_;

      HashTable< const Sequence< PRMInstance< GUM_SCALAR >* >*, Set< Tensor< GUM_SCALAR >* >* >
          _elim_map_;

      HashTable< const PRMClass< GUM_SCALAR >*, CData* > _cdata_map_;

      Set< Tensor< GUM_SCALAR >* > _trash_;
 
      HashTable< const PRMClass< GUM_SCALAR >*, std::vector< NodeId >* > _outputs_;

      Set< const PRMInstance< GUM_SCALAR >* > _reducedInstances_;

      typename PRMInference< GUM_SCALAR >::Chain _query_;

      PData* _pdata_;

      bool _mining_;

      bool                          _found_query_;
      std::pair< Idx, std::string > _query_data_;

      void _buildReduceGraph_(RGData& data);

      // MSVC void  _addNodesInReducedGraph_( RGData& data );

      void _addEdgesInReducedGraph_(RGData& data);
 
      void _removeNode_(typename StructuredInference::PData& data,
                        NodeId                               id,
                        Set< Tensor< GUM_SCALAR >* >&        pool);

      void _reduceAloneInstances_(RGData& data);

      void _reducePattern_(const gspan::Pattern* p);

      void _buildPatternGraph_(PData&                                        data,
                               Set< Tensor< GUM_SCALAR >* >&                 pool,
                               const Sequence< PRMInstance< GUM_SCALAR >* >& match);
 
      void _insertNodeInElimLists_(typename StructuredInference::PData&          data,
                                   const Sequence< PRMInstance< GUM_SCALAR >* >& match,
                                   PRMInstance< GUM_SCALAR >*                    inst,
                                   PRMAttribute< GUM_SCALAR >*                   attr,
                                   NodeId                                        id,
                                   std::pair< Idx, std::string >&                v);
 
      bool _allInstanceNoRefAttr_(typename StructuredInference::PData& data,
                                  std::pair< Idx, std::string >        attr);
 
      void _removeBarrenNodes_(typename StructuredInference::PData& data,
                               Set< Tensor< GUM_SCALAR >* >&        pool);

      // MVSC void  _buildQuerySet_( PData& data );

      Set< Tensor< GUM_SCALAR >* >*
          _eliminateObservedNodes_(typename StructuredInference::PData&          data,
                                   const Set< Tensor< GUM_SCALAR >* >&           pool,
                                   const Sequence< PRMInstance< GUM_SCALAR >* >& match,
                                   const std::vector< NodeId >&                  elim_order);
 
      Set< Tensor< GUM_SCALAR >* >*
          _eliminateObservedNodesInSource_(typename StructuredInference::PData&          data,
                                           const Set< Tensor< GUM_SCALAR >* >&           pool,
                                           const Sequence< PRMInstance< GUM_SCALAR >* >& match,
                                           const std::vector< NodeId >& elim_order);

      Set< Tensor< GUM_SCALAR >* >*
          _translatePotSet_(typename StructuredInference::PData&          data,
                            const Set< Tensor< GUM_SCALAR >* >&           pool,
                            const Sequence< PRMInstance< GUM_SCALAR >* >& match);

      // MVSC void  _unreduceMatchWithQuery_();
 
      // MVSC std::vector<NodeId>*  _getClassOutputs_( const
      // PRMClass<GUM_SCALAR>* c );
      std::string _dot_;
      std::string _str_(const PRMInstance< GUM_SCALAR >*  i,
                        const PRMAttribute< GUM_SCALAR >* a) const;
      std::string _str_(const PRMInstance< GUM_SCALAR >*  i,
                        const PRMAttribute< GUM_SCALAR >& a) const;
      std::string _str_(const PRMInstance< GUM_SCALAR >*  i,
                        const PRMSlotChain< GUM_SCALAR >& a) const;
 
      public:
      // For bench/debug purpose.
      Timer       timer;
      Timer       plopTimer;
      double      triang_time;
      double      mining_time;
      double      pattern_time;
      double      inner_time;
      double      obs_time;
      double      full_time;
      std::string info() const;
    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class StructuredInference< double >;
#endif
 
 
  } /* namespace prm */
} /* namespace gum */
 
#include <agrum/PRM/inference/structuredInference_tpl.h>
 
#endif /* GUM_STRUCTURED_INFERENCE_H */