//======================================================================= // Copyright 2001 University of Notre Dame. // Authors: Jeremy G. Siek and Lie-Quan Lee // // Distributed under the Boost Software License, Version 1.0. (See // accompanying file LICENSE_1_0.txt or copy at // http://www.boost.org/LICENSE_1_0.txt) //======================================================================= #ifndef BOOST_SUBGRAPH_HPP #define BOOST_SUBGRAPH_HPP // UNDER CONSTRUCTION #include #include #include #include #include #include #include #include #include #include namespace boost { struct subgraph_tag { }; // Invariants of an induced subgraph: // - If vertex u is in subgraph g, then u must be in g.parent(). // - If edge e is in subgraph g, then e must be in g.parent(). // - If edge e=(u,v) is in the root graph, then edge e // is also in any subgraph that contains both vertex u and v. // The Graph template parameter must have a vertex_index // and edge_index internal property. It is assumed that // the vertex indices are assigned automatically by the // graph during a call to add_vertex(). It is not // assumed that the edge vertices are assigned automatically, // they are explicitly assigned here. template class subgraph { typedef graph_traits Traits; typedef std::list*> ChildrenList; public: // Graph requirements typedef typename Traits::vertex_descriptor vertex_descriptor; typedef typename Traits::edge_descriptor edge_descriptor; typedef typename Traits::directed_category directed_category; typedef typename Traits::edge_parallel_category edge_parallel_category; typedef typename Traits::traversal_category traversal_category; static vertex_descriptor null_vertex() { return Traits::null_vertex(); } // IncidenceGraph requirements typedef typename Traits::out_edge_iterator out_edge_iterator; typedef typename Traits::degree_size_type degree_size_type; // AdjacencyGraph requirements typedef typename Traits::adjacency_iterator adjacency_iterator; // VertexListGraph requirements typedef typename Traits::vertex_iterator vertex_iterator; typedef typename Traits::vertices_size_type vertices_size_type; // EdgeListGraph requirements typedef typename Traits::edge_iterator edge_iterator; typedef typename Traits::edges_size_type edges_size_type; typedef typename Traits::in_edge_iterator in_edge_iterator; typedef typename Graph::edge_property_type edge_property_type; typedef typename Graph::vertex_property_type vertex_property_type; typedef typename Graph::vertex_bundled vertex_bundled; typedef typename Graph::edge_bundled edge_bundled; typedef subgraph_tag graph_tag; typedef Graph graph_type; typedef typename Graph::graph_property_type graph_property_type; // Constructors // Create the main graph, the root of the subgraph tree subgraph() : m_parent(0), m_edge_counter(0) { } subgraph(const graph_property_type& p) : m_graph(p), m_parent(0), m_edge_counter(0) { } subgraph(vertices_size_type n, const graph_property_type& p = graph_property_type()) : m_graph(n, p), m_parent(0), m_edge_counter(0), m_global_vertex(n) { typename Graph::vertex_iterator v, v_end; vertices_size_type i = 0; for (tie(v, v_end) = vertices(m_graph); v != v_end; ++v) m_global_vertex[i++] = *v; } // copy constructor subgraph(const subgraph& x) : m_graph(x.m_graph), m_parent(x.m_parent), m_edge_counter(x.m_edge_counter), m_global_vertex(x.m_global_vertex), m_global_edge(x.m_global_edge) { // Do a deep copy for (typename ChildrenList::const_iterator i = x.m_children.begin(); i != x.m_children.end(); ++i) m_children.push_back(new subgraph( **i )); } ~subgraph() { for (typename ChildrenList::iterator i = m_children.begin(); i != m_children.end(); ++i) delete *i; } // Create a subgraph subgraph& create_subgraph() { m_children.push_back(new subgraph()); m_children.back()->m_parent = this; return *m_children.back(); } // Create a subgraph with the specified vertex set. template subgraph& create_subgraph(VertexIterator first, VertexIterator last) { m_children.push_back(new subgraph()); m_children.back()->m_parent = this; for (; first != last; ++first) add_vertex(*first, *m_children.back()); return *m_children.back(); } // local <-> global descriptor conversion functions vertex_descriptor local_to_global(vertex_descriptor u_local) const { return m_global_vertex[u_local]; } vertex_descriptor global_to_local(vertex_descriptor u_global) const { vertex_descriptor u_local; bool in_subgraph; tie(u_local, in_subgraph) = this->find_vertex(u_global); assert(in_subgraph == true); return u_local; } edge_descriptor local_to_global(edge_descriptor e_local) const { return m_global_edge[get(get(edge_index, m_graph), e_local)]; } edge_descriptor global_to_local(edge_descriptor e_global) const { return (*m_local_edge.find(get(get(edge_index, root().m_graph), e_global))).second; } // Is vertex u (of the root graph) contained in this subgraph? // If so, return the matching local vertex. std::pair find_vertex(vertex_descriptor u_global) const { typename std::map::const_iterator i = m_local_vertex.find(u_global); bool valid = i != m_local_vertex.end(); return std::make_pair((valid ? (*i).second : null_vertex()), valid); } // Return the parent graph. subgraph& parent() { return *m_parent; } const subgraph& parent() const { return *m_parent; } bool is_root() const { return m_parent == 0; } // Return the root graph of the subgraph tree. subgraph& root() { if (this->is_root()) return *this; else return m_parent->root(); } const subgraph& root() const { if (this->is_root()) return *this; else return m_parent->root(); } // Return the children subgraphs of this graph/subgraph. // Use a list of pointers because the VC++ std::list doesn't like // storing incomplete type. typedef indirect_iterator< typename ChildrenList::const_iterator , subgraph , std::bidirectional_iterator_tag > children_iterator; typedef indirect_iterator< typename ChildrenList::const_iterator , subgraph const , std::bidirectional_iterator_tag > const_children_iterator; std::pair children() const { return std::make_pair(const_children_iterator(m_children.begin()), const_children_iterator(m_children.end())); } std::pair children() { return std::make_pair(children_iterator(m_children.begin()), children_iterator(m_children.end())); } std::size_t num_children() const { return m_children.size(); } #ifndef BOOST_GRAPH_NO_BUNDLED_PROPERTIES // Bundled properties support template typename graph::detail::bundled_result::type& operator[](Descriptor x) { if (m_parent == 0) return m_graph[x]; else return root().m_graph[local_to_global(x)]; } template typename graph::detail::bundled_result::type const& operator[](Descriptor x) const { if (m_parent == 0) return m_graph[x]; else return root().m_graph[local_to_global(x)]; } #endif // BOOST_GRAPH_NO_BUNDLED_PROPERTIES // private: typedef typename property_map::type EdgeIndexMap; typedef typename property_traits::value_type edge_index_type; BOOST_STATIC_ASSERT((!is_same::value)); Graph m_graph; subgraph* m_parent; edge_index_type m_edge_counter; // for generating unique edge indices ChildrenList m_children; std::vector m_global_vertex; // local -> global std::map m_local_vertex; // global -> local std::vector m_global_edge; // local -> global std::map m_local_edge; // global -> local edge_descriptor local_add_edge(vertex_descriptor u_local, vertex_descriptor v_local, edge_descriptor e_global) { edge_descriptor e_local; bool inserted; tie(e_local, inserted) = add_edge(u_local, v_local, m_graph); put(edge_index, m_graph, e_local, m_edge_counter++); m_global_edge.push_back(e_global); m_local_edge[get(get(edge_index, this->root()), e_global)] = e_local; return e_local; } }; #ifndef BOOST_GRAPH_NO_BUNDLED_PROPERTIES template struct vertex_bundle_type > : vertex_bundle_type { }; template struct edge_bundle_type > : edge_bundle_type { }; #endif // BOOST_GRAPH_NO_BUNDLED_PROPERTIES //=========================================================================== // Functions special to the Subgraph Class template typename subgraph::vertex_descriptor add_vertex(typename subgraph::vertex_descriptor u_global, subgraph& g) { assert(!g.is_root()); typename subgraph::vertex_descriptor u_local, v_global, uu_global; typename subgraph::edge_descriptor e_global; u_local = add_vertex(g.m_graph); g.m_global_vertex.push_back(u_global); g.m_local_vertex[u_global] = u_local; subgraph& r = g.root(); // remember edge global and local maps { typename subgraph::out_edge_iterator ei, ei_end; for (tie(ei, ei_end) = out_edges(u_global, r); ei != ei_end; ++ei) { e_global = *ei; v_global = target(e_global, r); if (g.find_vertex(v_global).second == true) g.local_add_edge(u_local, g.global_to_local(v_global), e_global); } } if (is_directed(g)) { // not necessary for undirected graph typename subgraph::vertex_iterator vi, vi_end; typename subgraph::out_edge_iterator ei, ei_end; for (tie(vi, vi_end) = vertices(r); vi != vi_end; ++vi) { v_global = *vi; if (g.find_vertex(v_global).second) for (tie(ei, ei_end) = out_edges(*vi, r); ei != ei_end; ++ei) { e_global = *ei; uu_global = target(e_global, r); if (uu_global == u_global && g.find_vertex(v_global).second) g.local_add_edge(g.global_to_local(v_global), u_local, e_global); } } } return u_local; } //=========================================================================== // Functions required by the IncidenceGraph concept template std::pair::out_edge_iterator, typename graph_traits::out_edge_iterator> out_edges(typename graph_traits::vertex_descriptor u_local, const subgraph& g) { return out_edges(u_local, g.m_graph); } template typename graph_traits::degree_size_type out_degree(typename graph_traits::vertex_descriptor u_local, const subgraph& g) { return out_degree(u_local, g.m_graph); } template typename graph_traits::vertex_descriptor source(typename graph_traits::edge_descriptor e_local, const subgraph& g) { return source(e_local, g.m_graph); } template typename graph_traits::vertex_descriptor target(typename graph_traits::edge_descriptor e_local, const subgraph& g) { return target(e_local, g.m_graph); } //=========================================================================== // Functions required by the BidirectionalGraph concept template std::pair::in_edge_iterator, typename graph_traits::in_edge_iterator> in_edges(typename graph_traits::vertex_descriptor u_local, const subgraph& g) { return in_edges(u_local, g.m_graph); } template typename graph_traits::degree_size_type in_degree(typename graph_traits::vertex_descriptor u_local, const subgraph& g) { return in_degree(u_local, g.m_graph); } template typename graph_traits::degree_size_type degree(typename graph_traits::vertex_descriptor u_local, const subgraph& g) { return degree(u_local, g.m_graph); } //=========================================================================== // Functions required by the AdjacencyGraph concept template std::pair::adjacency_iterator, typename subgraph::adjacency_iterator> adjacent_vertices(typename subgraph::vertex_descriptor u_local, const subgraph& g) { return adjacent_vertices(u_local, g.m_graph); } //=========================================================================== // Functions required by the VertexListGraph concept template std::pair::vertex_iterator, typename subgraph::vertex_iterator> vertices(const subgraph& g) { return vertices(g.m_graph); } template typename subgraph::vertices_size_type num_vertices(const subgraph& g) { return num_vertices(g.m_graph); } //=========================================================================== // Functions required by the EdgeListGraph concept template std::pair::edge_iterator, typename subgraph::edge_iterator> edges(const subgraph& g) { return edges(g.m_graph); } template typename subgraph::edges_size_type num_edges(const subgraph& g) { return num_edges(g.m_graph); } //=========================================================================== // Functions required by the AdjacencyMatrix concept template std::pair::edge_descriptor, bool> edge(typename subgraph::vertex_descriptor u_local, typename subgraph::vertex_descriptor v_local, const subgraph& g) { return edge(u_local, v_local, g.m_graph); } //=========================================================================== // Functions required by the MutableGraph concept namespace detail { template void add_edge_recur_down (Vertex u_global, Vertex v_global, Edge e_global, subgraph& g); template void children_add_edge(Vertex u_global, Vertex v_global, Edge e_global, Children& c, subgraph* orig) { for (typename Children::iterator i = c.begin(); i != c.end(); ++i) if ((*i)->find_vertex(u_global).second && (*i)->find_vertex(v_global).second) add_edge_recur_down(u_global, v_global, e_global, **i, orig); } template void add_edge_recur_down (Vertex u_global, Vertex v_global, Edge e_global, subgraph& g, subgraph* orig) { if (&g != orig ) { // add local edge only if u_global and v_global are in subgraph g Vertex u_local, v_local; bool u_in_subgraph, v_in_subgraph; tie(u_local, u_in_subgraph) = g.find_vertex(u_global); tie(v_local, v_in_subgraph) = g.find_vertex(v_global); if (u_in_subgraph && v_in_subgraph) g.local_add_edge(u_local, v_local, e_global); } children_add_edge(u_global, v_global, e_global, g.m_children, orig); } template std::pair::edge_descriptor, bool> add_edge_recur_up(Vertex u_global, Vertex v_global, const typename Graph::edge_property_type& ep, subgraph& g, subgraph* orig) { if (g.is_root()) { typename subgraph::edge_descriptor e_global; bool inserted; tie(e_global, inserted) = add_edge(u_global, v_global, ep, g.m_graph); put(edge_index, g.m_graph, e_global, g.m_edge_counter++); g.m_global_edge.push_back(e_global); children_add_edge(u_global, v_global, e_global, g.m_children, orig); return std::make_pair(e_global, inserted); } else return add_edge_recur_up(u_global, v_global, ep, *g.m_parent, orig); } } // namespace detail // Add an edge to the subgraph g, specified by the local vertex // descriptors u and v. In addition, the edge will be added to any // other subgraphs which contain vertex descriptors u and v. template std::pair::edge_descriptor, bool> add_edge(typename subgraph::vertex_descriptor u_local, typename subgraph::vertex_descriptor v_local, const typename G::edge_property_type& ep, subgraph& g) { if (g.is_root()) // u_local and v_local are really global return detail::add_edge_recur_up(u_local, v_local, ep, g, &g); else { typename subgraph::edge_descriptor e_local, e_global; bool inserted; tie(e_global, inserted) = detail::add_edge_recur_up (g.local_to_global(u_local), g.local_to_global(v_local), ep, g, &g); e_local = g.local_add_edge(u_local, v_local, e_global); return std::make_pair(e_local, inserted); } } template std::pair::edge_descriptor, bool> add_edge(typename subgraph::vertex_descriptor u, typename subgraph::vertex_descriptor v, subgraph& g) { typename G::edge_property_type ep; return add_edge(u, v, ep, g); } namespace detail { //------------------------------------------------------------------------- // implementation of remove_edge(u,v,g) template void remove_edge_recur_down(Vertex u_global, Vertex v_global, subgraph& g); template void children_remove_edge(Vertex u_global, Vertex v_global, Children& c) { for (typename Children::iterator i = c.begin(); i != c.end(); ++i) if ((*i)->find_vertex(u_global).second && (*i)->find_vertex(v_global).second) remove_edge_recur_down(u_global, v_global, **i); } template void remove_edge_recur_down(Vertex u_global, Vertex v_global, subgraph& g) { Vertex u_local, v_local; u_local = g.m_local_vertex[u_global]; v_local = g.m_local_vertex[v_global]; remove_edge(u_local, v_local, g.m_graph); children_remove_edge(u_global, v_global, g.m_children); } template void remove_edge_recur_up(Vertex u_global, Vertex v_global, subgraph& g) { if (g.is_root()) { remove_edge(u_global, v_global, g.m_graph); children_remove_edge(u_global, v_global, g.m_children); } else remove_edge_recur_up(u_global, v_global, *g.m_parent); } //------------------------------------------------------------------------- // implementation of remove_edge(e,g) template void remove_edge_recur_down(Edge e_global, subgraph& g); template void children_remove_edge(Edge e_global, Children& c) { for (typename Children::iterator i = c.begin(); i != c.end(); ++i) if ((*i)->find_vertex(source(e_global, **i)).second && (*i)->find_vertex(target(e_global, **i)).second) remove_edge_recur_down(source(e_global, **i), target(e_global, **i), **i); } template void remove_edge_recur_down(Edge e_global, subgraph& g) { remove_edge(g.global_to_local(e_global), g.m_graph); children_remove_edge(e_global, g.m_children); } template void remove_edge_recur_up(Edge e_global, subgraph& g) { if (g.is_root()) { remove_edge(e_global, g.m_graph); children_remove_edge(e_global, g.m_children); } else remove_edge_recur_up(e_global, *g.m_parent); } } // namespace detail template void remove_edge(typename subgraph::vertex_descriptor u_local, typename subgraph::vertex_descriptor v_local, subgraph& g) { if (g.is_root()) detail::remove_edge_recur_up(u_local, v_local, g); else detail::remove_edge_recur_up(g.local_to_global(u_local), g.local_to_global(v_local), g); } template void remove_edge(typename subgraph::edge_descriptor e_local, subgraph& g) { if (g.is_root()) detail::remove_edge_recur_up(e_local, g); else detail::remove_edge_recur_up(g.local_to_global(e_local), g); } template void remove_edge_if(Predicate p, subgraph& g) { // This is wrong... remove_edge_if(p, g.m_graph); } template void clear_vertex(typename subgraph::vertex_descriptor v_local, subgraph& g) { // this is wrong... clear_vertex(v_local, g.m_graph); } namespace detail { template typename subgraph::vertex_descriptor add_vertex_recur_up(subgraph& g) { typename subgraph::vertex_descriptor u_local, u_global; if (g.is_root()) { u_global = add_vertex(g.m_graph); g.m_global_vertex.push_back(u_global); } else { u_global = add_vertex_recur_up(*g.m_parent); u_local = add_vertex(g.m_graph); g.m_global_vertex.push_back(u_global); g.m_local_vertex[u_global] = u_local; } return u_global; } } // namespace detail template typename subgraph::vertex_descriptor add_vertex(subgraph& g) { typename subgraph::vertex_descriptor u_local, u_global; if (g.is_root()) { u_global = add_vertex(g.m_graph); g.m_global_vertex.push_back(u_global); u_local = u_global; } else { u_global = detail::add_vertex_recur_up(g.parent()); u_local = add_vertex(g.m_graph); g.m_global_vertex.push_back(u_global); g.m_local_vertex[u_global] = u_local; } return u_local; } template void remove_vertex(typename subgraph::vertex_descriptor u, subgraph& g) { // UNDER CONSTRUCTION assert(false); } //=========================================================================== // Functions required by the PropertyGraph concept template class subgraph_global_property_map : public put_get_helper< typename property_traits::reference, subgraph_global_property_map > { typedef property_traits Traits; public: typedef typename Traits::category category; typedef typename Traits::value_type value_type; typedef typename Traits::key_type key_type; typedef typename Traits::reference reference; subgraph_global_property_map() { } subgraph_global_property_map(GraphPtr g) : m_g(g) { } inline reference operator[](key_type e_local) const { PropertyMap pmap = get(Tag(), m_g->root().m_graph); if (m_g->m_parent == 0) return pmap[e_local]; else return pmap[m_g->local_to_global(e_local)]; } GraphPtr m_g; }; template class subgraph_local_property_map : public put_get_helper< typename property_traits::reference, subgraph_local_property_map > { typedef property_traits Traits; public: typedef typename Traits::category category; typedef typename Traits::value_type value_type; typedef typename Traits::key_type key_type; typedef typename Traits::reference reference; subgraph_local_property_map() { } subgraph_local_property_map(GraphPtr g) : m_g(g) { } inline reference operator[](key_type e_local) const { PropertyMap pmap = get(Tag(), *m_g); return pmap[e_local]; } GraphPtr m_g; }; namespace detail { struct subgraph_any_pmap { template class bind_ { typedef typename SubGraph::graph_type Graph; typedef SubGraph* SubGraphPtr; typedef const SubGraph* const_SubGraphPtr; typedef typename property_map::type PMap; typedef typename property_map::const_type const_PMap; public: typedef subgraph_global_property_map type; typedef subgraph_global_property_map const_type; }; }; struct subgraph_id_pmap { template struct bind_ { typedef typename SubGraph::graph_type Graph; typedef SubGraph* SubGraphPtr; typedef const SubGraph* const_SubGraphPtr; typedef typename property_map::type PMap; typedef typename property_map::const_type const_PMap; public: typedef subgraph_local_property_map type; typedef subgraph_local_property_map const_type; }; }; template struct subgraph_choose_pmap_helper { typedef subgraph_any_pmap type; }; template <> struct subgraph_choose_pmap_helper { typedef subgraph_id_pmap type; }; template struct subgraph_choose_pmap { typedef typename subgraph_choose_pmap_helper::type Helper; typedef typename Helper::template bind_ Bind; typedef typename Bind::type type; typedef typename Bind::const_type const_type; }; struct subgraph_property_generator { template struct bind_ { typedef subgraph_choose_pmap Choice; typedef typename Choice::type type; typedef typename Choice::const_type const_type; }; }; } // namespace detail template <> struct vertex_property_selector { typedef detail::subgraph_property_generator type; }; template <> struct edge_property_selector { typedef detail::subgraph_property_generator type; }; template typename property_map< subgraph, Property>::type get(Property, subgraph& g) { typedef typename property_map< subgraph, Property>::type PMap; return PMap(&g); } template typename property_map< subgraph, Property>::const_type get(Property, const subgraph& g) { typedef typename property_map< subgraph, Property>::const_type PMap; return PMap(&g); } template typename property_traits< typename property_map< subgraph, Property>::const_type >::value_type get(Property, const subgraph& g, const Key& k) { typedef typename property_map< subgraph, Property>::const_type PMap; PMap pmap(&g); return pmap[k]; } #ifndef BOOST_GRAPH_NO_BUNDLED_PROPERTIES template inline typename property_map, T Bundle::*>::type get(T Bundle::* p, subgraph& sg) { typedef typename property_map, T Bundle::*>::type result_type; return result_type(&sg, p); } #endif template void put(Property, subgraph& g, const Key& k, const Value& val) { typedef typename property_map< subgraph, Property>::type PMap; PMap pmap(&g); pmap[k] = val; } template inline typename graph_property::type& get_property(subgraph& g, Tag tag) { return get_property(g.m_graph, tag); } template inline const typename graph_property::type& get_property(const subgraph& g, Tag tag) { return get_property(g.m_graph, tag); } //=========================================================================== // Miscellaneous Functions template typename subgraph::vertex_descriptor vertex(typename subgraph::vertices_size_type n, const subgraph& g) { return vertex(n, g.m_graph); } } // namespace boost #endif // BOOST_SUBGRAPH_HPP