interfaceGraph.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_INTERFACE_GRAPH_H
#define GUM_INTERFACE_GRAPH_H
 
#include <list>
#include <sstream>
#include <string>
 
#include <agrum/PRM/PRM.h>
 
namespace gum {
  namespace prm {
    template < typename GUM_SCALAR >
    class GSpan;
 
    namespace gspan {

      struct LabelData {
        LabelData();
        LabelData(const LabelData& from);
        ~LabelData();
        Idx id;
        std::string l;
        Size tree_width;
        bool operator==(const LabelData& from) const;
        bool operator!=(const LabelData& from) const;
      };

      std::ostream& operator<<(std::ostream& out, const LabelData& data);

      template < typename GUM_SCALAR >
      class NodeData {
        public:
        NodeData();
        NodeData(const NodeData< GUM_SCALAR >& from);
        ~NodeData();
        PRMInstance< GUM_SCALAR >* n;
        LabelData* l;
        bool operator==(const NodeData< GUM_SCALAR >& from) const;
        bool operator!=(const NodeData< GUM_SCALAR >& from) const;
      };

      template < typename GUM_SCALAR >
      std::ostream& operator<<(std::ostream& out, const NodeData< GUM_SCALAR >& data);

      template < typename GUM_SCALAR >
      class EdgeData {
        public:
        EdgeData();
        EdgeData(const EdgeData< GUM_SCALAR >& from);
        ~EdgeData();
        PRMInstance< GUM_SCALAR >* u;
        LabelData* l_u;
        PRMInstance< GUM_SCALAR >* v;
        LabelData* l_v;
        LabelData* l;
        bool operator==(const EdgeData< GUM_SCALAR >& from) const;
        bool operator!=(const EdgeData< GUM_SCALAR >& from) const;
      };

      template < typename GUM_SCALAR >
      std::ostream& operator<<(std::ostream& out, const EdgeData< GUM_SCALAR >& data);

      template < typename GUM_SCALAR >
      class InterfaceGraph {
        friend class gum::prm::GSpan< GUM_SCALAR >;
 
        public:
        explicit InterfaceGraph(const PRMSystem< GUM_SCALAR >& sys);

        InterfaceGraph(const InterfaceGraph& source);

        InterfaceGraph& operator=(const InterfaceGraph& source);

        ~InterfaceGraph();

        UndiGraph& graph();

        const UndiGraph& graph() const;

        Bijection< Idx, LabelData* >& labels();

        const Bijection< Idx, LabelData* >& labels() const;

        Size size(const LabelData* l) const;

        Set< NodeData< GUM_SCALAR >* >& nodes(const LabelData* l);

        const Set< NodeData< GUM_SCALAR >* >& nodes(const LabelData* l) const;

        Set< EdgeData< GUM_SCALAR >* >& edges(const LabelData* l);

        const Set< EdgeData< GUM_SCALAR >* >& edges(const LabelData* l) const;

        LabelData* label(Idx id);

        NodeId id(const PRMInstance< GUM_SCALAR >& i) const;

        NodeId id(const PRMInstance< GUM_SCALAR >* i) const;

        NodeData< GUM_SCALAR >& node(const PRMInstance< GUM_SCALAR >* i);

        const NodeData< GUM_SCALAR >& node(const PRMInstance< GUM_SCALAR >* i) const;

        NodeData< GUM_SCALAR >& node(NodeId id);

        const NodeData< GUM_SCALAR >& node(NodeId id) const;

        EdgeData< GUM_SCALAR >& edge(NodeId u, NodeId v);

        const EdgeData< GUM_SCALAR >& edge(NodeId u, NodeId v) const;
 
        private:
        const PRMSystem< GUM_SCALAR >* _sys_;

        UndiGraph _graph_;

        NodeProperty< NodeData< GUM_SCALAR >* > _nodes_;

        HashTable< PRMInstance< GUM_SCALAR >*, NodeId > _idMap_;

        EdgeProperty< EdgeData< GUM_SCALAR >* > _edges_;

        Bijection< Idx, LabelData* >* _labels_;

        HashTable< LabelData*, Set< NodeData< GUM_SCALAR >* >* > _nodeMap_;

        HashTable< LabelData*, Set< EdgeData< GUM_SCALAR >* >* > _edgeMap_;

        Idx _counter_;

        bool _erase_flag_;

        void _label_(NodeData< GUM_SCALAR >* node, HashTable< std::string, LabelData* >& label_map);

        void _label_(EdgeData< GUM_SCALAR >* edge, HashTable< std::string, LabelData* >& label_map);
      };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
      extern template class NodeData< double >;
#    endif
#  endif
#endif
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
      extern template class EdgeData< double >;
#    endif
#  endif
#endif
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#  ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
#    ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
      extern template class InterfaceGraph< double >;
#    endif
#  endif
#endif
 
 
    } /* namespace gspan */
  } /* namespace prm */
} /* namespace gum */
 
#include <agrum/PRM/gspan/interfaceGraph_tpl.h>
 
#endif /* GUM_INTERFACE_GRAPH_H */