sl@0: //=======================================================================
sl@0: // Copyright 2002 Indiana University.
sl@0: // Authors: Andrew Lumsdaine, Lie-Quan Lee, Jeremy G. Siek
sl@0: //
sl@0: // Distributed under the Boost Software License, Version 1.0. (See
sl@0: // accompanying file LICENSE_1_0.txt or copy at
sl@0: // http://www.boost.org/LICENSE_1_0.txt)
sl@0: //=======================================================================
sl@0: 
sl@0: #ifndef BOOST_GRAPH_TEST_HPP
sl@0: #define BOOST_GRAPH_TEST_HPP
sl@0: 
sl@0: #include <vector>
sl@0: #include <boost/test/minimal.hpp>
sl@0: #include <boost/graph/filtered_graph.hpp>
sl@0: #include <boost/graph/iteration_macros.hpp>
sl@0: #include <boost/graph/isomorphism.hpp>
sl@0: #include <boost/graph/copy.hpp>
sl@0: #include <boost/graph/graph_utility.hpp> // for connects
sl@0: 
sl@0: 
sl@0: // UNDER CONSTRUCTION 
sl@0: 
sl@0: namespace boost {
sl@0: 
sl@0:   template <typename Graph>
sl@0:   struct graph_test
sl@0:   {
sl@0:   
sl@0:     typedef typename graph_traits<Graph>::vertex_descriptor vertex_t;
sl@0:     typedef typename graph_traits<Graph>::edge_descriptor edge_t;
sl@0:     typedef typename graph_traits<Graph>::vertices_size_type v_size_t;
sl@0:     typedef typename graph_traits<Graph>::degree_size_type deg_size_t;
sl@0:     typedef typename graph_traits<Graph>::edges_size_type e_size_t;
sl@0:     typedef typename graph_traits<Graph>::out_edge_iterator out_edge_iter;
sl@0:     typedef typename property_map<Graph, vertex_index_t>::type index_map_t;
sl@0:     typedef iterator_property_map<typename std::vector<vertex_t>::iterator,
sl@0:       index_map_t,vertex_t,vertex_t&> IsoMap;
sl@0: 
sl@0:     struct ignore_vertex {
sl@0:       ignore_vertex() { }
sl@0:       ignore_vertex(vertex_t v) : v(v) { }
sl@0:       bool operator()(vertex_t x) const { return x != v; }
sl@0:       vertex_t v;
sl@0:     };
sl@0:     struct ignore_edge {
sl@0:       ignore_edge() { }
sl@0:       ignore_edge(edge_t e) : e(e) { }
sl@0:       bool operator()(edge_t x) const { return x != e; }
sl@0:       edge_t e;
sl@0:     };
sl@0:     struct ignore_edges {
sl@0:       ignore_edges(vertex_t s, vertex_t t, const Graph& g) 
sl@0:         : s(s), t(t), g(g) { }
sl@0:       bool operator()(edge_t x) const { 
sl@0:         return !(source(x, g) == s && target(x, g) == t);
sl@0:       }
sl@0:       vertex_t s; vertex_t t; const Graph& g;
sl@0:     };
sl@0: 
sl@0:     //=========================================================================
sl@0:     // Traversal Operations
sl@0: 
sl@0:     void test_incidence_graph
sl@0:        (const std::vector<vertex_t>& vertex_set,
sl@0:         const std::vector< std::pair<vertex_t, vertex_t> >& edge_set,
sl@0:         const Graph& g)
sl@0:     {
sl@0:       typedef typename std::vector<vertex_t>::const_iterator vertex_iter;
sl@0:       typedef typename std::vector< std::pair<vertex_t, vertex_t> >
sl@0:         ::const_iterator edge_iter;
sl@0:       typedef typename graph_traits<Graph>::out_edge_iterator out_edge_iter;
sl@0: 
sl@0:       for (vertex_iter ui = vertex_set.begin(); ui != vertex_set.end(); ++ui) {
sl@0:         vertex_t u = *ui;
sl@0:         std::vector<vertex_t> adj;
sl@0:         for (edge_iter e = edge_set.begin(); e != edge_set.end(); ++e)
sl@0:           if (e->first == u)
sl@0:             adj.push_back(e->second);
sl@0:         
sl@0:         std::pair<out_edge_iter, out_edge_iter> p = out_edges(u, g);
sl@0:         BOOST_CHECK(out_degree(u, g) == adj.size());
sl@0:         BOOST_CHECK(deg_size_t(std::distance(p.first, p.second))
sl@0:                    == out_degree(u, g));
sl@0:         for (; p.first != p.second; ++p.first) {
sl@0:           edge_t e = *p.first;
sl@0:           BOOST_CHECK(source(e, g) == u);
sl@0:           BOOST_CHECK(contains(adj, target(e, g)) == true);
sl@0:         }
sl@0:       }
sl@0:     }
sl@0: 
sl@0:     void test_bidirectional_graph
sl@0:       (const std::vector<vertex_t>& vertex_set,
sl@0:        const std::vector< std::pair<vertex_t, vertex_t> >& edge_set,
sl@0:        const Graph& g)
sl@0:     {
sl@0:       typedef typename std::vector<vertex_t>::const_iterator vertex_iter;
sl@0:       typedef typename std::vector< std::pair<vertex_t, vertex_t> >
sl@0:         ::const_iterator edge_iter;
sl@0:       typedef typename graph_traits<Graph>::in_edge_iterator in_edge_iter;
sl@0: 
sl@0:       for (vertex_iter vi = vertex_set.begin(); vi != vertex_set.end(); ++vi) {
sl@0:         vertex_t v = *vi;
sl@0:         std::vector<vertex_t> inv_adj;
sl@0:         for (edge_iter e = edge_set.begin(); e != edge_set.end(); ++e)
sl@0:           if (e->second == v)
sl@0:             inv_adj.push_back(e->first);
sl@0: 
sl@0:         std::pair<in_edge_iter, in_edge_iter> p = in_edges(v, g);
sl@0:         BOOST_CHECK(in_degree(v, g) == inv_adj.size());
sl@0:         BOOST_CHECK(deg_size_t(std::distance(p.first, p.second))
sl@0:                    == in_degree(v, g));
sl@0:         for (; p.first != p.second; ++p.first) {
sl@0:           edge_t e = *p.first;
sl@0:           BOOST_CHECK(target(e, g) == v);
sl@0:           BOOST_CHECK(contains(inv_adj, source(e, g)) == true);
sl@0:         }
sl@0:       }
sl@0:     }
sl@0: 
sl@0:     void test_adjacency_graph
sl@0:       (const std::vector<vertex_t>& vertex_set,
sl@0:        const std::vector< std::pair<vertex_t,vertex_t> >& edge_set,
sl@0:        const Graph& g)
sl@0:     {
sl@0:       typedef typename std::vector<vertex_t>::const_iterator vertex_iter;
sl@0:       typedef typename std::vector<std::pair<vertex_t,vertex_t> >
sl@0:         ::const_iterator edge_iter;
sl@0:       typedef typename graph_traits<Graph>::adjacency_iterator adj_iter;
sl@0: 
sl@0:       for (vertex_iter ui = vertex_set.begin(); ui != vertex_set.end(); ++ui) {
sl@0:         vertex_t u = *ui;
sl@0:         std::vector<vertex_t> adj;
sl@0:         for (edge_iter e = edge_set.begin(); e != edge_set.end(); ++e)
sl@0:           if (e->first == u)
sl@0:             adj.push_back(e->second);
sl@0: 
sl@0:         std::pair<adj_iter, adj_iter> p = adjacent_vertices(u, g);
sl@0:         BOOST_CHECK(deg_size_t(std::distance(p.first, p.second)) == adj.size());
sl@0:         for (; p.first != p.second; ++p.first) {
sl@0:           vertex_t v = *p.first;
sl@0:           BOOST_CHECK(contains(adj, v) == true);
sl@0:         }
sl@0:       }
sl@0:     }      
sl@0: 
sl@0:     void test_vertex_list_graph
sl@0:       (const std::vector<vertex_t>& vertex_set, const Graph& g)
sl@0:     {
sl@0:       typedef typename graph_traits<Graph>::vertex_iterator v_iter;
sl@0:       std::pair<v_iter, v_iter> p = vertices(g);
sl@0:       BOOST_CHECK(num_vertices(g) == vertex_set.size());
sl@0:       v_size_t n = std::distance(p.first, p.second);
sl@0:       BOOST_CHECK(n == num_vertices(g));
sl@0:       for (; p.first != p.second; ++p.first) {
sl@0:         vertex_t v = *p.first;
sl@0:         BOOST_CHECK(contains(vertex_set, v) == true);
sl@0:       }
sl@0:     }
sl@0: 
sl@0:     void test_edge_list_graph
sl@0:       (const std::vector<vertex_t>& vertex_set, 
sl@0:        const std::vector< std::pair<vertex_t, vertex_t> >& edge_set, 
sl@0:        const Graph& g)
sl@0:     {
sl@0:       typedef typename graph_traits<Graph>::edge_iterator e_iter;
sl@0:       std::pair<e_iter, e_iter> p = edges(g);
sl@0:       BOOST_CHECK(num_edges(g) == edge_set.size());
sl@0:       e_size_t m = std::distance(p.first, p.second);
sl@0:       BOOST_CHECK(m == num_edges(g));
sl@0:       for (; p.first != p.second; ++p.first) {
sl@0:         edge_t e = *p.first;
sl@0:         BOOST_CHECK(any_if(edge_set, connects(source(e, g), target(e, g), g)));
sl@0:         BOOST_CHECK(contains(vertex_set, source(e, g)) == true);
sl@0:         BOOST_CHECK(contains(vertex_set, target(e, g)) == true);
sl@0:       }
sl@0:     }
sl@0: 
sl@0:     void test_adjacency_matrix
sl@0:       (const std::vector<vertex_t>& vertex_set, 
sl@0:        const std::vector< std::pair<vertex_t, vertex_t> >& edge_set, 
sl@0:        const Graph& g)
sl@0:     {
sl@0:       std::pair<edge_t, bool> p;
sl@0:       for (typename std::vector<std::pair<vertex_t, vertex_t> >
sl@0:              ::const_iterator i = edge_set.begin();
sl@0:            i != edge_set.end(); ++i) {
sl@0:         p = edge(i->first, i->second, g);
sl@0:         BOOST_CHECK(p.second == true);
sl@0:         BOOST_CHECK(source(p.first, g) == i->first);
sl@0:         BOOST_CHECK(target(p.first, g) == i->second);
sl@0:       }
sl@0:       typename std::vector<vertex_t>::const_iterator j, k;
sl@0:       for (j = vertex_set.begin(); j != vertex_set.end(); ++j)
sl@0:         for (k = vertex_set.begin(); k != vertex_set.end(); ++k) {
sl@0:           p = edge(*j, *k, g);
sl@0:           if (p.second == true)
sl@0:             BOOST_CHECK(any_if(edge_set, 
sl@0:               connects(source(p.first, g), target(p.first, g), g)) == true);
sl@0:         }
sl@0:     }
sl@0: 
sl@0:     //=========================================================================
sl@0:     // Mutating Operations
sl@0: 
sl@0:     void test_add_vertex(Graph& g)
sl@0:     {
sl@0:       Graph cpy;
sl@0:       std::vector<vertex_t> iso_vec(num_vertices(g));
sl@0:       IsoMap iso_map(iso_vec.begin(), get(vertex_index, g));
sl@0:       copy_graph(g, cpy, orig_to_copy(iso_map));
sl@0: 
sl@0:       assert((verify_isomorphism(g, cpy, iso_map)));
sl@0: 
sl@0:       vertex_t v = add_vertex(g);
sl@0:       
sl@0:       BOOST_CHECK(num_vertices(g) == num_vertices(cpy) + 1);
sl@0: 
sl@0:       BOOST_CHECK(out_degree(v, g) == 0);
sl@0: 
sl@0:       // Make sure the rest of the graph stayed the same
sl@0:       BOOST_CHECK((verify_isomorphism
sl@0:                   (make_filtered_graph(g, keep_all(), ignore_vertex(v)), cpy,
sl@0:                    iso_map)));
sl@0:     }
sl@0:     
sl@0:     void test_add_edge(vertex_t u, vertex_t v, Graph& g)
sl@0:     {
sl@0:       Graph cpy;
sl@0:       std::vector<vertex_t> iso_vec(num_vertices(g));
sl@0:       IsoMap iso_map(iso_vec.begin(), get(vertex_index, g));
sl@0:       copy_graph(g, cpy, orig_to_copy(iso_map));
sl@0: 
sl@0:       bool parallel_edge_exists = contains(adjacent_vertices(u, g), v);
sl@0:       
sl@0:       std::pair<edge_t, bool> p = add_edge(u, v, g);
sl@0:       edge_t e = p.first;
sl@0:       bool added = p.second;
sl@0: 
sl@0:       if (is_undirected(g) && u == v) // self edge
sl@0:         BOOST_CHECK(added == false);
sl@0:       else if (parallel_edge_exists)
sl@0:         BOOST_CHECK(allows_parallel_edges(g) && added == true
sl@0:                    || !allows_parallel_edges(g) && added == false);
sl@0:       else
sl@0:         BOOST_CHECK(added == true);
sl@0: 
sl@0:       if (p.second == true) { // edge added
sl@0:         BOOST_CHECK(num_edges(g) == num_edges(cpy) + 1);
sl@0:         
sl@0:         BOOST_CHECK(contains(out_edges(u, g), e) == true);
sl@0:         
sl@0:         BOOST_CHECK((verify_isomorphism
sl@0:                     (make_filtered_graph(g, ignore_edge(e)), cpy, iso_map)));
sl@0:       }
sl@0:       else { // edge not added
sl@0:         if (! (is_undirected(g) && u == v)) {
sl@0:           // e should be a parallel edge
sl@0:           BOOST_CHECK(source(e, g) == u);
sl@0:           BOOST_CHECK(target(e, g) == v);
sl@0:         }
sl@0:         // The graph should not be changed.
sl@0:         BOOST_CHECK((verify_isomorphism(g, cpy, iso_map)));
sl@0:       }
sl@0:     } // test_add_edge()
sl@0: 
sl@0: 
sl@0:     void test_remove_edge(vertex_t u, vertex_t v, Graph& g)
sl@0:     {
sl@0:       Graph cpy;
sl@0:       std::vector<vertex_t> iso_vec(num_vertices(g));
sl@0:       IsoMap iso_map(iso_vec.begin(), get(vertex_index, g));
sl@0:       copy_graph(g, cpy, orig_to_copy(iso_map));
sl@0: 
sl@0:       deg_size_t occurances = count(adjacent_vertices(u, g), v);
sl@0: 
sl@0:       remove_edge(u, v, g);
sl@0:       
sl@0:       BOOST_CHECK(num_edges(g) + occurances == num_edges(cpy));
sl@0:       BOOST_CHECK((verify_isomorphism
sl@0:                   (g, make_filtered_graph(cpy, ignore_edges(u,v,cpy)),
sl@0:                    iso_map)));
sl@0:     }
sl@0: 
sl@0:     void test_remove_edge(edge_t e, Graph& g)
sl@0:     {
sl@0:       Graph cpy;
sl@0:       std::vector<vertex_t> iso_vec(num_vertices(g));
sl@0:       IsoMap iso_map(iso_vec.begin(), get(vertex_index, g));
sl@0:       copy_graph(g, cpy, orig_to_copy(iso_map));
sl@0: 
sl@0:       vertex_t u = source(e, g), v = target(e, g);
sl@0:       deg_size_t occurances = count(adjacent_vertices(u, g), v);
sl@0:       
sl@0:       remove_edge(e, g);
sl@0: 
sl@0:       BOOST_CHECK(num_edges(g) + 1 == num_edges(cpy));
sl@0:       BOOST_CHECK(count(adjacent_vertices(u, g), v) + 1 == occurances);
sl@0:       BOOST_CHECK((verify_isomorphism
sl@0:                   (g, make_filtered_graph(cpy, ignore_edge(e)),
sl@0:                    iso_map)));
sl@0:     }
sl@0: 
sl@0:     void test_clear_vertex(vertex_t v, Graph& g)
sl@0:     {
sl@0:       Graph cpy;
sl@0:       std::vector<vertex_t> iso_vec(num_vertices(g));
sl@0:       IsoMap iso_map(iso_vec.begin(), get(vertex_index, g));
sl@0:       copy_graph(g, cpy, orig_to_copy(iso_map));
sl@0: 
sl@0:       clear_vertex(v, g);
sl@0: 
sl@0:       BOOST_CHECK(out_degree(v, g) == 0);
sl@0:       BOOST_CHECK(num_vertices(g) == num_vertices(cpy));
sl@0:       BOOST_CHECK((verify_isomorphism
sl@0:                   (g, make_filtered_graph(cpy, keep_all(), ignore_vertex(v)),
sl@0:                    iso_map)));
sl@0:     }
sl@0: 
sl@0:     //=========================================================================
sl@0:     // Property Map
sl@0: 
sl@0:     template <typename PropVal, typename PropertyTag>
sl@0:     void test_readable_vertex_property_graph
sl@0:       (const std::vector<PropVal>& vertex_prop, PropertyTag, const Graph& g)
sl@0:     {
sl@0:       typedef typename property_map<Graph, PropertyTag>::const_type const_Map;
sl@0:       const_Map pmap = get(PropertyTag(), g);
sl@0:       typename std::vector<PropVal>::const_iterator i = vertex_prop.begin();
sl@0: 
sl@0:   for (typename boost::graph_traits<Graph>::vertex_iterator 
sl@0:            bgl_first_9 = vertices(g).first, bgl_last_9 = vertices(g).second;
sl@0:        bgl_first_9 != bgl_last_9; bgl_first_9 = bgl_last_9)
sl@0:     for (typename boost::graph_traits<Graph>::vertex_descriptor v;
sl@0:          bgl_first_9 != bgl_last_9 ? (v = *bgl_first_9, true) : false;
sl@0:          ++bgl_first_9) {
sl@0:       //BGL_FORALL_VERTICES_T(v, g, Graph) {
sl@0:         typename property_traits<const_Map>::value_type 
sl@0:           pval1 = get(pmap, v), pval2 = get(PropertyTag(), g, v);
sl@0:         BOOST_CHECK(pval1 == pval2);
sl@0:         BOOST_CHECK(pval1 == *i++);
sl@0:       }
sl@0:     }
sl@0: 
sl@0:     template <typename PropVal, typename PropertyTag>
sl@0:     void test_vertex_property_graph
sl@0:       (const std::vector<PropVal>& vertex_prop, PropertyTag tag, Graph& g)
sl@0:     {
sl@0:       typedef typename property_map<Graph, PropertyTag>::type PMap;
sl@0:       PMap pmap = get(PropertyTag(), g);
sl@0:       typename std::vector<PropVal>::const_iterator i = vertex_prop.begin();
sl@0:   for (typename boost::graph_traits<Graph>::vertex_iterator 
sl@0:            bgl_first_9 = vertices(g).first, bgl_last_9 = vertices(g).second;
sl@0:        bgl_first_9 != bgl_last_9; bgl_first_9 = bgl_last_9)
sl@0:     for (typename boost::graph_traits<Graph>::vertex_descriptor v;
sl@0:          bgl_first_9 != bgl_last_9 ? (v = *bgl_first_9, true) : false;
sl@0:          ++bgl_first_9)
sl@0:       //      BGL_FORALL_VERTICES_T(v, g, Graph)
sl@0:         put(pmap, v, *i++);
sl@0: 
sl@0:       test_readable_vertex_property_graph(vertex_prop, tag, g);
sl@0: 
sl@0:       BGL_FORALL_VERTICES_T(v, g, Graph)
sl@0:         put(pmap, v, vertex_prop[0]);
sl@0:       
sl@0:       typename std::vector<PropVal>::const_iterator j = vertex_prop.begin();
sl@0:       BGL_FORALL_VERTICES_T(v, g, Graph)
sl@0:         put(PropertyTag(), g, v, *j++);
sl@0:       
sl@0:       test_readable_vertex_property_graph(vertex_prop, tag, g);      
sl@0:     }
sl@0:     
sl@0:     
sl@0:   };
sl@0: 
sl@0: 
sl@0: } // namespace boost
sl@0: 
sl@0: #include <boost/graph/iteration_macros_undef.hpp>
sl@0: 
sl@0: #endif // BOOST_GRAPH_TEST_HPP