searchStrategy.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_SEARCHSTRATEGY_H
#define GUM_SEARCHSTRATEGY_H
 
#include <list>
#include <ostream>
#include <utility>
#include <vector>
 
#include <agrum/PRM/gspan/edgeGrowth.h>
 
namespace gum {
  namespace prm {
 
    template < typename GUM_SCALAR >
    class GSpan;
 
    namespace gspan {
      template < typename GUM_SCALAR >
      class DFSTree;
 
      // clang_format off
      // clang_format on
      template < typename GUM_SCALAR >
      class SearchStrategy {
        public:
        // =========================================================================
        // ==========================================================================

        SearchStrategy();

        SearchStrategy(const SearchStrategy< GUM_SCALAR >& from);

        virtual ~SearchStrategy();

        SearchStrategy< GUM_SCALAR >& operator=(const SearchStrategy< GUM_SCALAR >& from);

        // =========================================================================
        // ==========================================================================
 
        void setTree(DFSTree< GUM_SCALAR >* tree);
 
        virtual bool accept_root(const Pattern* r) = 0;
 
        virtual bool accept_growth(const Pattern*                  parent,
                                   const Pattern*                  child,
                                   const EdgeGrowth< GUM_SCALAR >& growth)
            = 0;
 
        virtual bool operator()(LabelData* i, LabelData* j) = 0;
        virtual bool operator()(Pattern* i, Pattern* j)     = 0;
 
        protected:
        DFSTree< GUM_SCALAR >* tree_;
        double                 computeCost_(const Pattern& p);
      };

      template < typename GUM_SCALAR >
      class FrequenceSearch: public SearchStrategy< GUM_SCALAR > {
        public:
        // =========================================================================
        // ==========================================================================

        explicit FrequenceSearch(Size freq);

        FrequenceSearch(const FrequenceSearch& from);

        virtual ~FrequenceSearch();

        FrequenceSearch& operator=(const FrequenceSearch& from);

        // =========================================================================
        // ==========================================================================
 
        virtual bool accept_root(const Pattern* r);
 
        virtual bool accept_growth(const Pattern*                  parent,
                                   const Pattern*                  child,
                                   const EdgeGrowth< GUM_SCALAR >& growth);
 
        virtual bool operator()(LabelData* i, LabelData* j);
        virtual bool operator()(Pattern* i, Pattern* j);
 
        private:
        Size _freq_;
      };

      template < typename GUM_SCALAR >
      class StrictSearch: public SearchStrategy< GUM_SCALAR > {
        public:
        // =========================================================================
        // ==========================================================================

        explicit StrictSearch(Size freq = 2);

        StrictSearch(const StrictSearch& from);

        virtual ~StrictSearch();

        StrictSearch& operator=(const StrictSearch& from);

        // =========================================================================
        // ==========================================================================
 
        virtual bool accept_root(const Pattern* r);
 
        virtual bool accept_growth(const Pattern*                  parent,
                                   const Pattern*                  child,
                                   const EdgeGrowth< GUM_SCALAR >& growth);
 
        virtual bool operator()(LabelData* i, LabelData* j);
        virtual bool operator()(Pattern* i, Pattern* j);
 
        private:
        Size                                                     _freq_;
        double                                                   _inner_cost_(const Pattern* p);
        double                                                   _outer_cost_(const Pattern* p);
        void                                                     _compute_costs_(const Pattern* p);
        HashTable< const Pattern*, std::pair< double, double > > _map_;

        struct PData {
          UndiGraph graph;
          NodeProperty< Size > mod;
          Bijection< NodeId, std::string > node2attr;
          Bijection< NodeId, const DiscreteVariable* > vars;
          NodeSet inners;
          NodeSet outputs;
        };
 
        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;
        void        _buildPatternGraph_(typename StrictSearch< GUM_SCALAR >::PData&   data,
                                        Set< Tensor< GUM_SCALAR >* >&                 pool,
                                        const Sequence< PRMInstance< GUM_SCALAR >* >& match);
        std::pair< Size, Size > _elimination_cost_(typename StrictSearch< GUM_SCALAR >::PData& data,
                                                   Set< Tensor< GUM_SCALAR >* >& pool);
      };

      template < typename GUM_SCALAR >
      class TreeWidthSearch: public SearchStrategy< GUM_SCALAR > {
        public:
        // =========================================================================
        // ==========================================================================

        TreeWidthSearch();

        TreeWidthSearch(const TreeWidthSearch& from);

        virtual ~TreeWidthSearch();

        TreeWidthSearch& operator=(const TreeWidthSearch& from);

        // =========================================================================
        // ==========================================================================
 
        double cost(const Pattern& p);
 
        virtual bool accept_root(const Pattern* r);
 
        virtual bool accept_growth(const Pattern*                  parent,
                                   const Pattern*                  child,
                                   const EdgeGrowth< GUM_SCALAR >& growth);
 
        virtual bool operator()(LabelData* i, LabelData* j);
        virtual bool operator()(Pattern* i, Pattern* j);
 
        private:
        HashTable< const Pattern*, double > _map_;
      };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#      ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
      extern template class SearchStrategy< double >;
#      endif
#    endif
#  endif
#endif
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#      ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
      extern template class FrequenceSearch< double >;
#      endif
#    endif
#  endif
#endif
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#      ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
      extern template class StrictSearch< double >;
#      endif
#    endif
#  endif
#endif
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#      ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
      extern template class TreeWidthSearch< double >;
#      endif
#    endif
#  endif
#endif
 
 
    } /* namespace gspan */
  } /* namespace prm */
} /* namespace gum */
 
#include <agrum/PRM/gspan/searchStrategy_tpl.h>
 
#endif /* GUM_DFS_TREE_H */