pattern.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_PATTERN_H
#define GUM_PATTERN_H

#include <agrum/agrum.h>

#include <agrum/graphs/diGraph.h>

#include <agrum/PRM/gspan/DFSCode.h>
#include <agrum/PRM/gspan/interfaceGraph.h>

namespace gum {
  namespace prm {
    namespace gspan {

      class NeighborIterator;

      class Pattern : private DiGraph {
        public:
        // =========================================================================
        // ==========================================================================

        Pattern();

        Pattern(const Pattern& source);

        ~Pattern();

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

        NodeId addNodeWithLabel(LabelData& l);

        LabelData& label(NodeId node);

        const LabelData& label(NodeId node) const;

        LabelData& label(NodeId i, NodeId j);

        const LabelData& label(NodeId i, NodeId j) const;

        LabelData& label(const Arc& arc);

        const LabelData& label(const Arc& arc) const;

        // Returns the last added LabelData.
        LabelData& lastAdded();

        // Returns the last added LabelData.
        const LabelData& lastAdded() const;

        void addArc(NodeId i, NodeId j, LabelData& l);

        bool exists(NodeId id) const;

        bool exists(NodeId tail, NodeId head) const;

        Size size() const;

        Size sizeArcs() const;

        void rightmostPath(std::list< NodeId >& r_path) const;

        std::string toDot(size_t name) const;

        // =========================================================================
        // ==========================================================================
        const NodeGraphPart& nodes() const;

        const ArcSet& arcs() const;

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

        DFSCode& code();

        const DFSCode& code() const;

        EdgeCode& edgeCode(NodeId tail, NodeId head);

        EdgeCode& edgeCode(const Arc& arc);

        const EdgeCode& edgeCode(NodeId tail, NodeId head) const;

        const EdgeCode& edgeCode(const Arc& arc) const;

        void pop_back();

        void remove(NodeId node);

        bool isMinimal();


        private:
        DFSCode __code;

        NodeProperty< LabelData* > __node_map;

        ArcProperty< std::pair< LabelData*, EdgeCode* > > __arc_map;

        LabelData* __last;

        bool __expandCodeIsMinimal(NodeId u, NodeId v);

        bool __rec(Pattern&                     p,
                   Bijection< NodeId, NodeId >& node_map,
                   NodeId                       u,
                   NodeId                       v);

        bool __not_rec(Pattern&                     p,
                       Bijection< NodeId, NodeId >& node_map,
                       NodeId                       u,
                       NodeId                       v);

        // to avoid clang++ warnings
        using DiGraph::addNode;
        using DiGraph::addArc;
        using DiGraph::toDot;
        using DiGraph::parents;
        using DiGraph::children;
      };
    } /* namespace gspan */
  }   /* namespace prm */
} /* namespace gum */
#ifndef GUM_NO_INLINE
#  include <agrum/PRM/gspan/pattern_inl.h>
#endif   // GUM_NO_INLINE

#endif /* GUM_PATTERN_H */