DFSTree.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_DFS_TREE_H
#define GUM_DFS_TREE_H
 
#include <list>
#include <ostream>
#include <utility>
#include <vector>
 
#include <agrum/PRM/gspan/searchStrategy.h>
 
namespace gum {
  namespace prm {
 
    template < typename GUM_SCALAR >
    class GSpan;
 
    namespace gspan {
      template < typename GUM_SCALAR >
      class SearchStrategy;

      template < typename GUM_SCALAR >
      class DFSTree: private DiGraph {
        public:
        // =========================================================================
        // ==========================================================================

        // DFSTree(InterfaceGraph<GUM_SCALAR>* graph);
        DFSTree(const InterfaceGraph< GUM_SCALAR >& graph,
                SearchStrategy< GUM_SCALAR >*       strategy = 0);

        ~DFSTree();

        // =========================================================================
        // ==========================================================================
 
        const InterfaceGraph< GUM_SCALAR >& graph() const;
 
        struct PatternData {
          explicit PatternData(Pattern* p);
          PatternData(const PatternData& from);
          ~PatternData();
          Pattern* pattern;
          std::list< NodeId > children;
          UndiGraph iso_graph;
          NodeProperty< Sequence< PRMInstance< GUM_SCALAR >* >* > iso_map;
          Set< NodeId > max_indep_set;
          Size cost;
          Size gain;
        };

        std::list< NodeId >& roots();

        const std::list< NodeId >& roots() const;

        Pattern& parent(const Pattern& p);

        const Pattern& parent(const Pattern& p) const;

        std::list< NodeId >& children(const Pattern& p);

        const std::list< NodeId >& children(const Pattern& p) const;

        Pattern& pattern(NodeId id);

        const Pattern& pattern(NodeId id) const;

        void addRoot(LabelData& data);

        Pattern& growPattern(Pattern& p, EdgeGrowth< GUM_SCALAR >& edge_growth, Size min_freq);

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

        UndiGraph& iso_graph(const Pattern& p);

        Sequence< PRMInstance< GUM_SCALAR >* >& iso_map(const Pattern& p, NodeId node);

        Set< NodeId >& max_indep_set(const Pattern& p);

        double frequency(const Pattern& p) const;

        PatternData& data(const Pattern& p);
        const PatternData& data(const Pattern& p) const;

        SearchStrategy< GUM_SCALAR >& strategy();

        const SearchStrategy< GUM_SCALAR >& strategy() const;

        struct NeighborDegreeSort {
          explicit NeighborDegreeSort(UndiGraph& graph);
          NeighborDegreeSort(const NeighborDegreeSort& source);
          ~NeighborDegreeSort();
          bool operator()(NodeId i, NodeId j);
          UndiGraph& g;
        };

 
        private:
        const InterfaceGraph< GUM_SCALAR >* _graph_;

        std::list< NodeId > _roots_;

        Bijection< NodeId, Pattern* > _node_map_;

        HashTable< Pattern*, PatternData* > _data_;

        SearchStrategy< GUM_SCALAR >* _strategy_;

        void _checkGrowth_(Pattern& p, Pattern* child, EdgeGrowth< GUM_SCALAR >& edge_growth);

        void _addChild_(Pattern& p, Pattern* child, EdgeGrowth< GUM_SCALAR >& edge_growth);

        bool _is_new_seq_(Sequence< PRMInstance< GUM_SCALAR >* >&                  seq,
                          NodeProperty< Sequence< PRMInstance< GUM_SCALAR >* >* >& iso_map);

        void _initialiaze_root_(Pattern* p, Sequence< EdgeData< GUM_SCALAR >* >& seq);
 
        // Used by  _find_sub_pattern_.
        bool _test_equality_(HashTable< PRMClassElement< GUM_SCALAR >*, Size >& x,
                             HashTable< PRMClassElement< GUM_SCALAR >*, Size >& y);
      };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
      extern template class DFSTree< double >;
#endif
 
 
    } /* namespace gspan */
  } /* namespace prm */
} /* namespace gum */
 
#include <agrum/PRM/gspan/DFSTree_tpl.h>
 
#endif /* GUM_DFS_TREE_H */