boost/graph/johnson_all_pairs_shortest.hpp

   1 //=======================================================================
   2 // Copyright 1997, 1998, 1999, 2000 University of Notre Dame.
   3 // Authors: Andrew Lumsdaine, Lie-Quan Lee, Jeremy G. Siek
   4 //
   5 // Distributed under the Boost Software License, Version 1.0. (See
   6 // accompanying file LICENSE_1_0.txt or copy at
   7 // http://www.boost.org/LICENSE_1_0.txt)
   8 //=======================================================================
   9
  10 /*
  11   This file implements the function
  12
  13   template <class VertexAndEdgeListGraph, class DistanceMatrix,
  14             class P, class T, class R>
  15   bool
  16   johnson_all_pairs_shortest_paths
  17     (VertexAndEdgeListGraph& g,
  18      DistanceMatrix& D,
  19      const bgl_named_params<P, T, R>& params)
  20  */
  21
  22 #ifndef BOOST_GRAPH_JOHNSON_HPP
  23 #define BOOST_GRAPH_JOHNSON_HPP
  24
  25 #include <boost/graph/graph_traits.hpp>
  26 #include <boost/property_map/property_map.hpp>
  27 #include <boost/property_map/shared_array_property_map.hpp>
  28 #include <boost/graph/bellman_ford_shortest_paths.hpp>
  29 #include <boost/graph/dijkstra_shortest_paths.hpp>
  30 #include <boost/graph/adjacency_list.hpp>
  31 #include <boost/type_traits/same_traits.hpp>
  32 #include <boost/concept/assert.hpp>
  33
  34 namespace boost {
  35
  36   template <class VertexAndEdgeListGraph, class DistanceMatrix,
  37             class VertexID, class Weight, typename BinaryPredicate,
  38             typename BinaryFunction, typename Infinity, class DistanceZero>
  39   bool
  40   johnson_all_pairs_shortest_paths(VertexAndEdgeListGraph& g1,
  41                DistanceMatrix& D,
  42                VertexID id1, Weight w1, const BinaryPredicate& compare,
  43                const BinaryFunction& combine, const Infinity& inf,
  44                DistanceZero zero)
  45   {
  46     typedef graph_traits<VertexAndEdgeListGraph> Traits1;
  47     typedef typename property_traits<Weight>::value_type DT;
  48     BOOST_CONCEPT_ASSERT(( BasicMatrixConcept<DistanceMatrix,
  49       typename Traits1::vertices_size_type, DT> ));
  50
  51     typedef typename Traits1::directed_category DirCat;
  52     bool is_undirected = is_same<DirCat, undirected_tag>::value;
  53
  54     typedef adjacency_list<vecS, vecS, directedS,
  55       property< vertex_distance_t, DT>,
  56       property< edge_weight_t, DT,
  57       property< edge_weight2_t, DT > > > Graph2;
  58     typedef graph_traits<Graph2> Traits2;
  59
  60     Graph2 g2(num_vertices(g1) + 1);
  61     typename property_map<Graph2, edge_weight_t>::type
  62       w = get(edge_weight, g2);
  63     typename property_map<Graph2, edge_weight2_t>::type
  64       w_hat = get(edge_weight2, g2);
  65     typename property_map<Graph2, vertex_distance_t>::type
  66       d = get(vertex_distance, g2);
  67     typedef typename property_map<Graph2, vertex_index_t>::type VertexID2;
  68     VertexID2 id2 = get(vertex_index, g2);
  69
  70     // Construct g2 where V[g2] = V[g1] U {s}
  71     //   and  E[g2] = E[g1] U {(s,v)| v in V[g1]}
  72     std::vector<typename Traits1::vertex_descriptor>
  73       verts1(num_vertices(g1) + 1);
  74     typename Traits2::vertex_descriptor s = *vertices(g2).first;
  75     {
  76       typename Traits1::vertex_iterator v, v_end;
  77       int i = 1;
  78       for (boost::tie(v, v_end) = vertices(g1); v != v_end; ++v, ++i) {
  79         typename Traits2::edge_descriptor e; bool z;
  80         boost::tie(e, z) = add_edge(s, get(id1, *v) + 1, g2);
  81         put(w, e, zero);
  82         verts1[i] = *v;
  83       }
  84       typename Traits1::edge_iterator e, e_end;
  85       for (boost::tie(e, e_end) = edges(g1); e != e_end; ++e) {
  86         typename Traits2::edge_descriptor e2; bool z;
  87         boost::tie(e2, z) = add_edge(get(id1, source(*e, g1)) + 1,
  88                                      get(id1, target(*e, g1)) + 1, g2);
  89         put(w, e2, get(w1, *e));
  90         if (is_undirected) {
  91           boost::tie(e2, z) = add_edge(get(id1, target(*e, g1)) + 1,
  92                                        get(id1, source(*e, g1)) + 1, g2);
  93           put(w, e2, get(w1, *e));
  94         }
  95       }
  96     }
  97     typename Traits2::vertex_iterator v, v_end, u, u_end;
  98     typename Traits2::edge_iterator e, e_end;
  99     shared_array_property_map<DT,VertexID2> h(num_vertices(g2), id2);
 100
 101     for (boost::tie(v, v_end) = vertices(g2); v != v_end; ++v)
 102       put(d, *v, inf);
 103
 104     put(d, s, zero);
 105     // Using the non-named parameter versions of bellman_ford and
 106     // dijkstra for portability reasons.
 107     dummy_property_map pred; bellman_visitor<> bvis;
 108     if (bellman_ford_shortest_paths
 109         (g2, num_vertices(g2), w, pred, d, combine, compare, bvis)) {
 110       for (boost::tie(v, v_end) = vertices(g2); v != v_end; ++v)
 111         put(h, *v, get(d, *v));
 112       // Reweight the edges to remove negatives
 113       for (boost::tie(e, e_end) = edges(g2); e != e_end; ++e) {
 114         typename Traits2::vertex_descriptor a = source(*e, g2),
 115           b = target(*e, g2);
 116         put(w_hat, *e, combine(get(w, *e), (get(h, a) - get(h, b))));
 117       }
 118       for (boost::tie(u, u_end) = vertices(g2); u != u_end; ++u) {
 119         dijkstra_visitor<> dvis;
 120         dijkstra_shortest_paths
 121           (g2, *u, pred, d, w_hat, id2, compare, combine, inf, zero,dvis);
 122         for (boost::tie(v, v_end) = vertices(g2); v != v_end; ++v) {
 123           if (*u != s && *v != s) {
 124             typename Traits1::vertex_descriptor u1, v1;
 125             u1 = verts1[get(id2, *u)]; v1 = verts1[get(id2, *v)];
 126             D[get(id2, *u)-1][get(id2, *v)-1] = combine(get(d, *v), (get(h, *v) - get(h, *u)));
 127           }
 128         }
 129       }
 130       return true;
 131     } else
 132       return false;
 133   }
 134
 135   template <class VertexAndEdgeListGraph, class DistanceMatrix,
 136             class VertexID, class Weight, class DistanceZero>
 137   bool
 138   johnson_all_pairs_shortest_paths(VertexAndEdgeListGraph& g1,
 139                DistanceMatrix& D,
 140                VertexID id1, Weight w1, DistanceZero zero)
 141   {
 142     typedef typename property_traits<Weight>::value_type WT;
 143     return johnson_all_pairs_shortest_paths(g1, D, id1, w1,
 144                                             std::less<WT>(),
 145                                             closed_plus<WT>(),
 146                                             (std::numeric_limits<WT>::max)(),
 147                                             zero);
 148   }
 149
 150   namespace detail {
 151
 152     template <class VertexAndEdgeListGraph, class DistanceMatrix,
 153               class P, class T, class R, class Weight,
 154               class VertexID>
 155     bool
 156     johnson_dispatch(VertexAndEdgeListGraph& g,
 157                      DistanceMatrix& D,
 158                      const bgl_named_params<P, T, R>& params,
 159                      Weight w, VertexID id)
 160     {
 161       typedef typename property_traits<Weight>::value_type WT;
 162
 163       return johnson_all_pairs_shortest_paths
 164         (g, D, id, w,
 165         choose_param(get_param(params, distance_compare_t()),
 166           std::less<WT>()),
 167         choose_param(get_param(params, distance_combine_t()),
 168           closed_plus<WT>()),
 169         choose_param(get_param(params, distance_inf_t()),
 170           std::numeric_limits<WT>::max BOOST_PREVENT_MACRO_SUBSTITUTION()),
 171          choose_param(get_param(params, distance_zero_t()), WT()) );
 172     }
 173
 174   } // namespace detail
 175
 176   template <class VertexAndEdgeListGraph, class DistanceMatrix,
 177             class P, class T, class R>
 178   bool
 179   johnson_all_pairs_shortest_paths
 180     (VertexAndEdgeListGraph& g,
 181      DistanceMatrix& D,
 182      const bgl_named_params<P, T, R>& params)
 183   {
 184     return detail::johnson_dispatch
 185       (g, D, params,
 186        choose_const_pmap(get_param(params, edge_weight), g, edge_weight),
 187        choose_const_pmap(get_param(params, vertex_index), g, vertex_index)
 188        );
 189   }
 190
 191   template <class VertexAndEdgeListGraph, class DistanceMatrix>
 192   bool
 193   johnson_all_pairs_shortest_paths
 194     (VertexAndEdgeListGraph& g, DistanceMatrix& D)
 195   {
 196     bgl_named_params<int,int> params(1);
 197     return detail::johnson_dispatch
 198       (g, D, params, get(edge_weight, g), get(vertex_index, g));
 199   }
 200
 201 } // namespace boost
 202
 203 #endif // BOOST_GRAPH_JOHNSON_HPP
 204
 205