gspan.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_GSPAN_H
#define GUM_GSPAN_H
 
#include <algorithm>
#include <list>
#include <ostream>
#include <string>
#include <vector>
 
#include <agrum/base/core/timer.h>
#include <agrum/BN/inference/variableElimination.h>
#include <agrum/PRM/gspan/DFSTree.h>
 
namespace gum {
  namespace prm {

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

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

      ~GSpan();

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

      Size getMaxDFSDepth() const;

      void setMaxDFSDepth(Size depth);

      gspan::DFSTree< GUM_SCALAR >& tree();

      const gspan::DFSTree< GUM_SCALAR >& tree() const;

      gspan::InterfaceGraph< GUM_SCALAR >& interfaceGraph();

      const gspan::InterfaceGraph< GUM_SCALAR >& interfaceGraph() const;

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

      void discoverPatterns();

      std::vector< gspan::Pattern* >& patterns();

      const std::vector< gspan::Pattern* >& patterns() const;

      using MatchedInstances = Set< Sequence< PRMInstance< GUM_SCALAR >* >* >;

      MatchedInstances& matches(const gspan::Pattern& p);

      const MatchedInstances& matches(const gspan::Pattern& p) const;
 
      // /**
      //  * Returns the cumulative sum of all the cliques size created after
      //  lifting
      //  * the patterns.
      //  * @returns the cumulative sum of all the cliques size created after
      //  lifting
      //  *          the patterns.
      //  */
      // double patterns_cost() const;
 
      // /**
      //  * Returns the cumulative sum of all the cliques size created after
      //  lifting
      //  * the inner attributes.
      //  * @returns the cumulative sum of all the cliques size created after
      //  lifting
      //  *          the inner attributes.
      //  */
      // double sve_cost() const;

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

      gspan::InterfaceGraph< GUM_SCALAR >* _graph_;

      gspan::DFSTree< GUM_SCALAR > _tree_;

      Size _depth_stop_;

      std::vector< gspan::Pattern* > _patterns_;

      std::vector< gspan::LabelData* > _nodes_;

      std::vector< gspan::LabelData* > _edges_;

      HashTable< gspan::LabelData*, Idx > _cost_;

      HashTable< gspan::Pattern*, MatchedInstances* > _matched_instances_;

      Set< PRMInstance< GUM_SCALAR >* > _chosen_;

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

      void _sortNodesAndEdges_();

      void _subgraph_mining_(gspan::InterfaceGraph< GUM_SCALAR >& graph, gspan::Pattern& p);

      Size _cost_func_(Size interface_size, Size frequency);

      void _sortPatterns_();

      bool _isEdgeEligible_(typename gspan::EdgeData< GUM_SCALAR >* e);

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

      struct LabelSort {
        LabelSort(GSpan* my_gspan);

        LabelSort(const LabelSort& source);

        ~LabelSort();

        bool operator()(gspan::LabelData* i, gspan::LabelData* j);

        GSpan* gspan;
      };

      struct PatternSort {
        PatternSort(GSpan* my_gspan);

        PatternSort(const PatternSort& source);

        ~PatternSort();

        bool operator()(gspan::Pattern* i, gspan::Pattern* j);

        GSpan* gspan;
      };

    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class GSpan< double >;
#endif
 
 
  } /* namespace prm */
} /* namespace gum */
 
#include <agrum/PRM/inference/gspan_tpl.h>
 
#endif /* GUM_GSPAN_H */