os/ossrv/ossrv_pub/boost_apis/boost/graph/undirected_dfs.hpp
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
//
sl@0
     2
//=======================================================================
sl@0
     3
// Copyright 1997, 1998, 1999, 2000 University of Notre Dame.
sl@0
     4
// Authors: Andrew Lumsdaine, Lie-Quan Lee, Jeremy G. Siek
sl@0
     5
//
sl@0
     6
// Distributed under the Boost Software License, Version 1.0. (See
sl@0
     7
// accompanying file LICENSE_1_0.txt or copy at
sl@0
     8
// http://www.boost.org/LICENSE_1_0.txt)
sl@0
     9
//=======================================================================
sl@0
    10
//
sl@0
    11
#ifndef BOOST_GRAPH_UNDIRECTED_DFS_HPP
sl@0
    12
#define BOOST_GRAPH_UNDIRECTED_DFS_HPP
sl@0
    13
sl@0
    14
#include <boost/graph/depth_first_search.hpp>
sl@0
    15
#include <vector>
sl@0
    16
sl@0
    17
namespace boost {
sl@0
    18
sl@0
    19
  namespace detail {
sl@0
    20
sl@0
    21
// Define BOOST_RECURSIVE_DFS to use older, recursive version.
sl@0
    22
// It is retained for a while in order to perform performance
sl@0
    23
// comparison.
sl@0
    24
#ifndef BOOST_RECURSIVE_DFS
sl@0
    25
sl@0
    26
    template <typename IncidenceGraph, typename DFSVisitor, 
sl@0
    27
              typename VertexColorMap, typename EdgeColorMap>
sl@0
    28
    void undir_dfv_impl
sl@0
    29
      (const IncidenceGraph& g,
sl@0
    30
       typename graph_traits<IncidenceGraph>::vertex_descriptor u, 
sl@0
    31
       DFSVisitor& vis,
sl@0
    32
       VertexColorMap vertex_color,
sl@0
    33
       EdgeColorMap edge_color)
sl@0
    34
    {
sl@0
    35
      function_requires<IncidenceGraphConcept<IncidenceGraph> >();
sl@0
    36
      function_requires<DFSVisitorConcept<DFSVisitor, IncidenceGraph> >();
sl@0
    37
      typedef typename graph_traits<IncidenceGraph>::vertex_descriptor Vertex;
sl@0
    38
      typedef typename graph_traits<IncidenceGraph>::edge_descriptor Edge;
sl@0
    39
      function_requires<ReadWritePropertyMapConcept<VertexColorMap,Vertex> >();
sl@0
    40
      function_requires<ReadWritePropertyMapConcept<EdgeColorMap,Edge> >();
sl@0
    41
      typedef typename property_traits<VertexColorMap>::value_type ColorValue;
sl@0
    42
      typedef typename property_traits<EdgeColorMap>::value_type EColorValue;
sl@0
    43
      function_requires< ColorValueConcept<ColorValue> >();
sl@0
    44
      function_requires< ColorValueConcept<EColorValue> >();
sl@0
    45
      typedef color_traits<ColorValue> Color;
sl@0
    46
      typedef color_traits<EColorValue> EColor;
sl@0
    47
      typedef typename graph_traits<IncidenceGraph>::out_edge_iterator Iter;
sl@0
    48
      typedef std::pair<Vertex, std::pair<Iter, Iter> > VertexInfo;
sl@0
    49
sl@0
    50
      std::vector<VertexInfo> stack;
sl@0
    51
sl@0
    52
      put(vertex_color, u, Color::gray());
sl@0
    53
      vis.discover_vertex(u, g);
sl@0
    54
      stack.push_back(std::make_pair(u, out_edges(u, g)));
sl@0
    55
      while (!stack.empty()) {
sl@0
    56
        VertexInfo& back = stack.back();
sl@0
    57
        u = back.first;
sl@0
    58
        Iter ei, ei_end;
sl@0
    59
        tie(ei, ei_end) = back.second;
sl@0
    60
        stack.pop_back();
sl@0
    61
        while (ei != ei_end) {
sl@0
    62
          Vertex v = target(*ei, g);
sl@0
    63
          vis.examine_edge(*ei, g);
sl@0
    64
          ColorValue v_color = get(vertex_color, v);
sl@0
    65
          EColorValue uv_color = get(edge_color, *ei);
sl@0
    66
          put(edge_color, *ei, EColor::black());
sl@0
    67
          if (v_color == Color::white()) {
sl@0
    68
            vis.tree_edge(*ei, g);
sl@0
    69
            stack.push_back(std::make_pair(u, std::make_pair(++ei, ei_end)));
sl@0
    70
            u = v;
sl@0
    71
            put(vertex_color, u, Color::gray());
sl@0
    72
            vis.discover_vertex(u, g);
sl@0
    73
            tie(ei, ei_end) = out_edges(u, g);
sl@0
    74
          } else if (v_color == Color::gray()) {
sl@0
    75
            if (uv_color == EColor::white()) vis.back_edge(*ei, g);
sl@0
    76
            ++ei;
sl@0
    77
          } else { // if (v_color == Color::black())
sl@0
    78
            ++ei;
sl@0
    79
          }
sl@0
    80
        }
sl@0
    81
        put(vertex_color, u, Color::black());
sl@0
    82
        vis.finish_vertex(u, g);
sl@0
    83
      }
sl@0
    84
    }
sl@0
    85
sl@0
    86
#else // BOOST_RECURSIVE_DFS
sl@0
    87
sl@0
    88
    template <typename IncidenceGraph, typename DFSVisitor, 
sl@0
    89
              typename VertexColorMap, typename EdgeColorMap>
sl@0
    90
    void undir_dfv_impl
sl@0
    91
      (const IncidenceGraph& g,
sl@0
    92
       typename graph_traits<IncidenceGraph>::vertex_descriptor u, 
sl@0
    93
       DFSVisitor& vis,  // pass-by-reference here, important!
sl@0
    94
       VertexColorMap vertex_color,
sl@0
    95
       EdgeColorMap edge_color)
sl@0
    96
    {
sl@0
    97
      function_requires<IncidenceGraphConcept<IncidenceGraph> >();
sl@0
    98
      function_requires<DFSVisitorConcept<DFSVisitor, IncidenceGraph> >();
sl@0
    99
      typedef typename graph_traits<IncidenceGraph>::vertex_descriptor Vertex;
sl@0
   100
      typedef typename graph_traits<IncidenceGraph>::edge_descriptor Edge;
sl@0
   101
      function_requires<ReadWritePropertyMapConcept<VertexColorMap,Vertex> >();
sl@0
   102
      function_requires<ReadWritePropertyMapConcept<EdgeColorMap,Edge> >();
sl@0
   103
      typedef typename property_traits<VertexColorMap>::value_type ColorValue;
sl@0
   104
      typedef typename property_traits<EdgeColorMap>::value_type EColorValue;
sl@0
   105
      function_requires< ColorValueConcept<ColorValue> >();
sl@0
   106
      function_requires< ColorValueConcept<EColorValue> >();
sl@0
   107
      typedef color_traits<ColorValue> Color;
sl@0
   108
      typedef color_traits<EColorValue> EColor;
sl@0
   109
      typename graph_traits<IncidenceGraph>::out_edge_iterator ei, ei_end;
sl@0
   110
sl@0
   111
      put(vertex_color, u, Color::gray());   vis.discover_vertex(u, g);
sl@0
   112
      for (tie(ei, ei_end) = out_edges(u, g); ei != ei_end; ++ei) {
sl@0
   113
        Vertex v = target(*ei, g);           vis.examine_edge(*ei, g);
sl@0
   114
        ColorValue v_color = get(vertex_color, v);
sl@0
   115
        EColorValue uv_color = get(edge_color, *ei);
sl@0
   116
        put(edge_color, *ei, EColor::black());
sl@0
   117
        if (v_color == Color::white()) {     vis.tree_edge(*ei, g);
sl@0
   118
          undir_dfv_impl(g, v, vis, vertex_color, edge_color);
sl@0
   119
        } else if (v_color == Color::gray() && uv_color == EColor::white())
sl@0
   120
                                             vis.back_edge(*ei, g);
sl@0
   121
      }
sl@0
   122
      put(vertex_color, u, Color::black());  vis.finish_vertex(u, g);
sl@0
   123
    }
sl@0
   124
sl@0
   125
#endif // ! BOOST_RECURSIVE_DFS
sl@0
   126
sl@0
   127
  } // namespace detail
sl@0
   128
sl@0
   129
  template <typename Graph, typename DFSVisitor, 
sl@0
   130
            typename VertexColorMap, typename EdgeColorMap, 
sl@0
   131
            typename Vertex>
sl@0
   132
  void
sl@0
   133
  undirected_dfs(const Graph& g, DFSVisitor vis, 
sl@0
   134
                 VertexColorMap vertex_color, EdgeColorMap edge_color,
sl@0
   135
                 Vertex start_vertex)
sl@0
   136
  {
sl@0
   137
    function_requires<DFSVisitorConcept<DFSVisitor, Graph> >();
sl@0
   138
      function_requires<EdgeListGraphConcept<Graph> >();
sl@0
   139
sl@0
   140
    typedef typename property_traits<VertexColorMap>::value_type ColorValue;
sl@0
   141
    typedef color_traits<ColorValue> Color;
sl@0
   142
sl@0
   143
    typename graph_traits<Graph>::vertex_iterator ui, ui_end;
sl@0
   144
    for (tie(ui, ui_end) = vertices(g); ui != ui_end; ++ui) {
sl@0
   145
      put(vertex_color, *ui, Color::white());   vis.initialize_vertex(*ui, g);
sl@0
   146
    }
sl@0
   147
    typename graph_traits<Graph>::edge_iterator ei, ei_end;
sl@0
   148
    for (tie(ei, ei_end) = edges(g); ei != ei_end; ++ei)
sl@0
   149
      put(edge_color, *ei, Color::white());
sl@0
   150
sl@0
   151
    if (start_vertex != *vertices(g).first){ vis.start_vertex(start_vertex, g);
sl@0
   152
      detail::undir_dfv_impl(g, start_vertex, vis, vertex_color, edge_color);
sl@0
   153
    }
sl@0
   154
sl@0
   155
    for (tie(ui, ui_end) = vertices(g); ui != ui_end; ++ui) {
sl@0
   156
      ColorValue u_color = get(vertex_color, *ui);
sl@0
   157
      if (u_color == Color::white()) {       vis.start_vertex(*ui, g);
sl@0
   158
        detail::undir_dfv_impl(g, *ui, vis, vertex_color, edge_color);
sl@0
   159
      }
sl@0
   160
    }
sl@0
   161
  }
sl@0
   162
sl@0
   163
  template <typename Graph, typename DFSVisitor, typename VertexColorMap,
sl@0
   164
    typename EdgeColorMap>
sl@0
   165
  void
sl@0
   166
  undirected_dfs(const Graph& g, DFSVisitor vis, 
sl@0
   167
                 VertexColorMap vertex_color, EdgeColorMap edge_color)
sl@0
   168
  {
sl@0
   169
    undirected_dfs(g, vis, vertex_color, edge_color, *vertices(g).first);
sl@0
   170
  }
sl@0
   171
sl@0
   172
  namespace detail {
sl@0
   173
    template <typename VertexColorMap>
sl@0
   174
    struct udfs_dispatch {
sl@0
   175
sl@0
   176
      template <typename Graph, typename Vertex, 
sl@0
   177
                typename DFSVisitor, typename EdgeColorMap,
sl@0
   178
                typename P, typename T, typename R>
sl@0
   179
      static void
sl@0
   180
      apply(const Graph& g, DFSVisitor vis, Vertex start_vertex,
sl@0
   181
            const bgl_named_params<P, T, R>&,
sl@0
   182
            EdgeColorMap edge_color,
sl@0
   183
            VertexColorMap vertex_color)
sl@0
   184
      {
sl@0
   185
        undirected_dfs(g, vis, vertex_color, edge_color, start_vertex);
sl@0
   186
      }
sl@0
   187
    };
sl@0
   188
sl@0
   189
    template <>
sl@0
   190
    struct udfs_dispatch<detail::error_property_not_found> {
sl@0
   191
      template <typename Graph, typename Vertex, typename DFSVisitor,
sl@0
   192
                typename EdgeColorMap,
sl@0
   193
                typename P, typename T, typename R>
sl@0
   194
      static void
sl@0
   195
      apply(const Graph& g, DFSVisitor vis, Vertex start_vertex,
sl@0
   196
            const bgl_named_params<P, T, R>& params,
sl@0
   197
            EdgeColorMap edge_color,
sl@0
   198
            detail::error_property_not_found)
sl@0
   199
      {
sl@0
   200
        std::vector<default_color_type> color_vec(num_vertices(g));
sl@0
   201
        default_color_type c = white_color; // avoid warning about un-init
sl@0
   202
        undirected_dfs
sl@0
   203
          (g, vis, make_iterator_property_map
sl@0
   204
           (color_vec.begin(),
sl@0
   205
            choose_const_pmap(get_param(params, vertex_index),
sl@0
   206
                              g, vertex_index), c),
sl@0
   207
           edge_color,
sl@0
   208
           start_vertex);
sl@0
   209
      }
sl@0
   210
    };
sl@0
   211
sl@0
   212
  } // namespace detail
sl@0
   213
  
sl@0
   214
sl@0
   215
  // Named Parameter Variant
sl@0
   216
  template <typename Graph, typename P, typename T, typename R>
sl@0
   217
  void
sl@0
   218
  undirected_dfs(const Graph& g, 
sl@0
   219
                 const bgl_named_params<P, T, R>& params)
sl@0
   220
  {
sl@0
   221
    typedef typename property_value< bgl_named_params<P, T, R>, 
sl@0
   222
      vertex_color_t>::type C;
sl@0
   223
    detail::udfs_dispatch<C>::apply
sl@0
   224
      (g,
sl@0
   225
       choose_param(get_param(params, graph_visitor),
sl@0
   226
                    make_dfs_visitor(null_visitor())),
sl@0
   227
       choose_param(get_param(params, root_vertex_t()),
sl@0
   228
                    *vertices(g).first),
sl@0
   229
       params,
sl@0
   230
       get_param(params, edge_color),
sl@0
   231
       get_param(params, vertex_color)
sl@0
   232
       );
sl@0
   233
  }
sl@0
   234
  
sl@0
   235
sl@0
   236
  template <typename IncidenceGraph, typename DFSVisitor, 
sl@0
   237
    typename VertexColorMap, typename EdgeColorMap>
sl@0
   238
  void undirected_depth_first_visit
sl@0
   239
    (const IncidenceGraph& g,
sl@0
   240
     typename graph_traits<IncidenceGraph>::vertex_descriptor u, 
sl@0
   241
     DFSVisitor vis, VertexColorMap vertex_color, EdgeColorMap edge_color)
sl@0
   242
  {
sl@0
   243
    detail::undir_dfv_impl(g, u, vis, vertex_color, edge_color);
sl@0
   244
  }
sl@0
   245
sl@0
   246
sl@0
   247
} // namespace boost
sl@0
   248
sl@0
   249
sl@0
   250
#endif