ged_graph.hpp

Go to the documentation of this file.

/***************************************************************************
*                                                                          *
*   Copyright (C) 2018 by David B. Blumenthal                              *
*                                                                          *
*   This file is part of GEDLIB.                                           *
*                                                                          *
*   GEDLIB is free software: you can redistribute it and/or modify it      *
*   under the terms of 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.                                    *
*                                                                          *
*   GEDLIB 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 Lesser General Public License for more details.                    *
*                                                                          *
*   You should have received a copy of the GNU Lesser General Public       *
*   License along with GEDLIB. If not, see <http://www.gnu.org/licenses/>. *
*                                                                          *
***************************************************************************/

#ifndef SRC_ENV_GED_GRAPH_HPP_
#define SRC_ENV_GED_GRAPH_HPP_

#include "common_types.hpp"
#include "matrix.hpp"

//#include "ged_graph.fwd.hpp"

namespace ged {

namespace detail {

namespace al_graph_prop {

struct node;

struct edge;

struct graph;

}

namespace am_graph_prop {

struct node;

struct edge;

struct graph;

}

typedef boost::adjacency_list<
        boost::vecS,
        boost::vecS,
        boost::undirectedS,
        al_graph_prop::node,
        al_graph_prop::edge
        > GedGraphAL;

typedef boost::adjacency_matrix<
        boost::undirectedS,
        am_graph_prop::node,
        am_graph_prop::edge
        > GedGraphAM;

namespace al_graph_prop {

struct node {
    LabelID label{invalid_label()};
};

struct edge {
    LabelID label{invalid_label()};
};

struct graph {};

}

namespace am_graph_prop {

struct node {};

struct edge {
    GedGraphAL::edge_descriptor cref;
};

struct graph {};

}

}

class GEDGraph {

public:

    typedef std::size_t NodeID; 

    typedef detail::GedGraphAL::edge_descriptor EdgeID; 

    typedef std::vector<GEDGraph>::size_type GraphID; 

    typedef std::map<NodeID, NodeID> NodeNodeMap; 

    typedef std::map<NodeID, std::size_t> NodeSizeTMap; 

    typedef std::map<std::size_t, NodeID> SizeTNodeMap; 

    typedef detail::GedGraphAL::out_edge_iterator incident_edge_iterator; 

    typedef detail::GedGraphAL::edge_iterator edge_iterator; 

    typedef detail::GedGraphAL::vertex_iterator node_iterator; 

    GEDGraph();

    GEDGraph(GraphID id);

    GEDGraph(const GEDGraph & ged_graph);

    GraphID id() const;

    void clear();

    static NodeID dummy_node();

    static NodeID undefined_node();

    static EdgeID dummy_edge();


    NodeID add_node();

    EdgeID add_edge(NodeID tail, NodeID head);

    void set_label(NodeID node, LabelID label);

    void set_label(EdgeID edge, LabelID label);

    LabelID get_node_label(NodeID node) const;

    LabelID get_edge_label(EdgeID edge) const;

    LabelID get_edge_label(NodeID node_1, NodeID node_2) const;

    void setup_adjacency_matrix();

    NodeID tail(EdgeID edge) const;

    NodeID head(EdgeID edge) const;


    EdgeID get_edge(NodeID tail, NodeID head) const;


    EdgeID safe_get_edge(NodeID tail, NodeID head) const;


    bool is_edge(NodeID tail, NodeID head) const;

    bool safe_is_edge(NodeID tail, NodeID head) const;

    std::size_t degree(NodeID node) const;

    std::size_t num_nodes() const;

    std::size_t num_edges() const;

    bool initialized() const;

    void un_init();

    std::size_t maxdeg() const;

    std::pair<node_iterator, node_iterator> nodes() const;

    std::pair<edge_iterator, edge_iterator> edges() const;

    std::pair<incident_edge_iterator, incident_edge_iterator> incident_edges(NodeID node) const;

    const detail::GedGraphAL & get_adjacency_list() const;

private:

    detail::GedGraphAL alist_;

    detail::GedGraphAM amatrix_;

    GraphID id_;

    bool initialized_;
};

std::ostream & operator<<(std::ostream & os, const GEDGraph & graph);

}

#include "ged_graph.ipp"

#endif /* SRC_ENV_GED_GRAPH_HPP_ */