From 40af610e8f6e7065d56e8a2bc70159de3d3e88ae Mon Sep 17 00:00:00 2001 From: "K. Noel Belcourt" Date: Sat, 26 Jan 2008 18:35:59 +0000 Subject: [PATCH] Fixes #416 Fixed spelling of Jack Edmonds name and renamed files where necessary. Updated the documentation as well. Tested changes by building/running tests in libs/graph/test. [SVN r42984] --- ...x_flow.html => edmonds_karp_max_flow.html} | 20 +++++------ doc/kolmogorov_max_flow.html | 2 +- doc/push_relabel_max_flow.html | 2 +- example/edge-connectivity.cpp | 4 +-- ...dmunds-karp-eg.cpp => edmonds-karp-eg.cpp} | 8 ++--- example/regression.cfg | 2 +- include/boost/graph/edge_connectivity.hpp | 4 +-- ...max_flow.hpp => edmonds_karp_max_flow.hpp} | 36 +++++++++---------- test/max_flow_test.cpp | 6 ++-- 9 files changed, 42 insertions(+), 42 deletions(-) rename doc/{edmunds_karp_max_flow.html => edmonds_karp_max_flow.html} (93%) rename example/{edmunds-karp-eg.cpp => edmonds-karp-eg.cpp} (93%) rename include/boost/graph/{edmunds_karp_max_flow.hpp => edmonds_karp_max_flow.hpp} (92%) diff --git a/doc/edmunds_karp_max_flow.html b/doc/edmonds_karp_max_flow.html similarity index 93% rename from doc/edmunds_karp_max_flow.html rename to doc/edmonds_karp_max_flow.html index 0bf59675..d88adaca 100644 --- a/doc/edmunds_karp_max_flow.html +++ b/doc/edmonds_karp_max_flow.html @@ -7,7 +7,7 @@ -- http://www.boost.org/LICENSE_1_0.txt) --> -Boost Graph Library: Edmunds-Karp Maximum Flow +Boost Graph Library: Edmonds-Karp Maximum Flow -

-edmunds_karp_max_flow +

+edmonds_karp_max_flow 

 // named paramter version
 template <class Graph, class P, class T, class R>
 typename detail::edge_capacity_value<Graph, P, T, R>::value_type
-edmunds_karp_max_flow(Graph& g, 
+edmonds_karp_max_flow(Graph& g, 
    typename graph_traits<Graph>::vertex_descriptor src,
    typename graph_traits<Graph>::vertex_descriptor sink,
    const bgl_named_params<P, T, R>& params = all defaults)
@@ -33,7 +33,7 @@ template <class Graph,
 	  class CapacityEdgeMap, class ResidualCapacityEdgeMap,
 	  class ReverseEdgeMap, class ColorMap, class PredEdgeMap>
 typename property_traits<CapacityEdgeMap>::value_type
-edmunds_karp_max_flow(Graph& g, 
+edmonds_karp_max_flow(Graph& g, 
    typename graph_traits<Graph>::vertex_descriptor src,
    typename graph_traits<Graph>::vertex_descriptor sink,
    CapacityEdgeMap cap, ResidualCapacityEdgeMap res, ReverseEdgeMap rev, 
@@ -41,7 +41,7 @@ edmunds_karp_max_flow(Graph& g,

-The edmunds_karp_max_flow() function calculates the maximum flow +The edmonds_karp_max_flow() function calculates the maximum flow of a network. See Section Network Flow Algorithms for a description of maximum flow. The calculated @@ -93,7 +93,7 @@ algorithm.

Where Defined

-boost/graph/edmunds_karp_max_flow.hpp +boost/graph/edmonds_karp_max_flow.hpp

@@ -209,7 +209,7 @@ some constant U.

Example

The program in example/edmunds-karp-eg.cpp +href="../example/edmonds-karp-eg.cpp">example/edmonds-karp-eg.cpp reads an example maximum flow problem (a graph with edge capacities) from a file in the DIMACS format and computes the maximum flow. @@ -229,9 +229,9 @@ from a file in the DIMACS format and computes the maximum flow. - - diff --git a/doc/kolmogorov_max_flow.html b/doc/kolmogorov_max_flow.html index b9b0aa2e..2e99d5a7 100644 --- a/doc/kolmogorov_max_flow.html +++ b/doc/kolmogorov_max_flow.html @@ -364,7 +364,7 @@ f 6 4 0 f 7 6 0 f 7 5 0

See Also

-

edmunds_karp_max_flow(),
push_relabel_max_flow(). +

edmonds_karp_max_flow(),
push_relabel_max_flow().

diff --git a/doc/push_relabel_max_flow.html b/doc/push_relabel_max_flow.html index a2137b3a..3142ad80 100644 --- a/doc/push_relabel_max_flow.html +++ b/doc/push_relabel_max_flow.html @@ -225,7 +225,7 @@ f 6 7 1

See Also

-edmunds_karp_max_flow()
+edmonds_karp_max_flow()
kolmogorov_max_flow().
diff --git a/example/edge-connectivity.cpp b/example/edge-connectivity.cpp index 87cc00a8..f51694e2 100644 --- a/example/edge-connectivity.cpp +++ b/example/edge-connectivity.cpp @@ -8,7 +8,7 @@ #include #include #include -#include +#include #include #include #include @@ -110,7 +110,7 @@ namespace boost while (!nonneighbor_S.empty()) { k = nonneighbor_S.front(); - alpha_S_k = edmunds_karp_max_flow + alpha_S_k = edmonds_karp_max_flow (flow_g, p, k, cap, res_cap, rev_edge, &color[0], &pred[0]); if (alpha_S_k < alpha_star) { alpha_star = alpha_S_k; diff --git a/example/edmunds-karp-eg.cpp b/example/edmonds-karp-eg.cpp similarity index 93% rename from example/edmunds-karp-eg.cpp rename to example/edmonds-karp-eg.cpp index f6cd1995..4b5c6fac 100644 --- a/example/edmunds-karp-eg.cpp +++ b/example/edmonds-karp-eg.cpp @@ -8,13 +8,13 @@ #include #include #include -#include +#include #include #include #include // Use a DIMACS network flow file as stdin. -// edmunds-karp-eg < max_flow.dat +// edmonds-karp-eg < max_flow.dat // // Sample output: // c The total flow: @@ -68,10 +68,10 @@ main() #if defined(BOOST_MSVC) && BOOST_MSVC <= 1300 std::vector color(num_vertices(g)); std::vector pred(num_vertices(g)); - long flow = edmunds_karp_max_flow + long flow = edmonds_karp_max_flow (g, s, t, capacity, residual_capacity, rev, &color[0], &pred[0]); #else - long flow = edmunds_karp_max_flow(g, s, t); + long flow = edmonds_karp_max_flow(g, s, t); #endif std::cout << "c The total flow:" << std::endl; diff --git a/example/regression.cfg b/example/regression.cfg index 762d2e6c..4fa1cef4 100644 --- a/example/regression.cfg +++ b/example/regression.cfg @@ -44,7 +44,7 @@ compile libs/graph/example/edge_basics.cpp compile libs/graph/example/edge_connectivity.cpp compile libs/graph/example/edge_iterator_constructor.cpp compile libs/graph/example/edge_property.cpp -compile libs/graph/example/edmunds-karp-eg.cpp +compile libs/graph/example/edmonds-karp-eg.cpp compile libs/graph/example/exterior_properties.cpp compile libs/graph/example/exterior_property_map.cpp compile libs/graph/example/family-tree-eg.cpp diff --git a/include/boost/graph/edge_connectivity.hpp b/include/boost/graph/edge_connectivity.hpp index d78e3ee4..d52bf9cc 100644 --- a/include/boost/graph/edge_connectivity.hpp +++ b/include/boost/graph/edge_connectivity.hpp @@ -16,7 +16,7 @@ #include #include #include -#include +#include namespace boost { @@ -139,7 +139,7 @@ namespace boost { while (!non_neighbor_S.empty()) { // at most n - 1 times k = non_neighbor_S.front(); - alpha_S_k = edmunds_karp_max_flow + alpha_S_k = edmonds_karp_max_flow (flow_g, p, k, cap, res_cap, rev_edge, &color[0], &pred[0]); if (alpha_S_k < alpha_star) { diff --git a/include/boost/graph/edmunds_karp_max_flow.hpp b/include/boost/graph/edmonds_karp_max_flow.hpp similarity index 92% rename from include/boost/graph/edmunds_karp_max_flow.hpp rename to include/boost/graph/edmonds_karp_max_flow.hpp index ddb49dc6..2564acd6 100644 --- a/include/boost/graph/edmunds_karp_max_flow.hpp +++ b/include/boost/graph/edmonds_karp_max_flow.hpp @@ -7,8 +7,8 @@ // http://www.boost.org/LICENSE_1_0.txt) //======================================================================= -#ifndef EDMUNDS_KARP_MAX_FLOW_HPP -#define EDMUNDS_KARP_MAX_FLOW_HPP +#ifndef EDMONDS_KARP_MAX_FLOW_HPP +#define EDMONDS_KARP_MAX_FLOW_HPP #include #include @@ -25,7 +25,7 @@ namespace boost { // The "labeling" algorithm from "Network Flows" by Ahuja, Magnanti, // Orlin. I think this is the same as or very similar to the original - // Edmunds-Karp algorithm. This solves the maximum flow problem. + // Edmonds-Karp algorithm. This solves the maximum flow problem. namespace detail { @@ -76,7 +76,7 @@ namespace boost { class CapacityEdgeMap, class ResidualCapacityEdgeMap, class ReverseEdgeMap, class ColorMap, class PredEdgeMap> typename property_traits::value_type - edmunds_karp_max_flow + edmonds_karp_max_flow (Graph& g, typename graph_traits::vertex_descriptor src, typename graph_traits::vertex_descriptor sink, @@ -111,7 +111,7 @@ namespace boost { for (tie(ei, e_end) = out_edges(src, g); ei != e_end; ++ei) flow += (cap[*ei] - res[*ei]); return flow; - } // edmunds_karp_max_flow() + } // edmonds_karp_max_flow() namespace detail { //------------------------------------------------------------------------- @@ -119,7 +119,7 @@ namespace boost { // use of class here is a VC++ workaround template - struct edmunds_karp_dispatch2 { + struct edmonds_karp_dispatch2 { template static typename edge_capacity_value::type apply @@ -130,7 +130,7 @@ namespace boost { const bgl_named_params& params, ColorMap color) { - return edmunds_karp_max_flow + return edmonds_karp_max_flow (g, src, sink, choose_const_pmap(get_param(params, edge_capacity), g, edge_capacity), choose_pmap(get_param(params, edge_residual_capacity), @@ -140,7 +140,7 @@ namespace boost { } }; template<> - struct edmunds_karp_dispatch2 { + struct edmonds_karp_dispatch2 { template static typename edge_capacity_value::type apply @@ -156,7 +156,7 @@ namespace boost { size_type n = is_default_param(get_param(params, vertex_color)) ? num_vertices(g) : 1; std::vector color_vec(n); - return edmunds_karp_max_flow + return edmonds_karp_max_flow (g, src, sink, choose_const_pmap(get_param(params, edge_capacity), g, edge_capacity), choose_pmap(get_param(params, edge_residual_capacity), @@ -174,7 +174,7 @@ namespace boost { // use of class here is a VC++ workaround template - struct edmunds_karp_dispatch1 { + struct edmonds_karp_dispatch1 { template static typename edge_capacity_value::type apply(Graph& g, @@ -184,12 +184,12 @@ namespace boost { PredMap pred) { typedef typename property_value< bgl_named_params, vertex_color_t>::type C; - return edmunds_karp_dispatch2::apply + return edmonds_karp_dispatch2::apply (g, src, sink, pred, params, get_param(params, vertex_color)); } }; template<> - struct edmunds_karp_dispatch1 { + struct edmonds_karp_dispatch1 { template static typename edge_capacity_value::type @@ -207,7 +207,7 @@ namespace boost { std::vector pred_vec(n); typedef typename property_value< bgl_named_params, vertex_color_t>::type C; - return edmunds_karp_dispatch2::apply + return edmonds_karp_dispatch2::apply (g, src, sink, make_iterator_property_map(pred_vec.begin(), choose_const_pmap (get_param(params, vertex_index), @@ -221,14 +221,14 @@ namespace boost { template typename detail::edge_capacity_value::type - edmunds_karp_max_flow + edmonds_karp_max_flow (Graph& g, typename graph_traits::vertex_descriptor src, typename graph_traits::vertex_descriptor sink, const bgl_named_params& params) { typedef typename property_value< bgl_named_params, vertex_predecessor_t>::type Pred; - return detail::edmunds_karp_dispatch1::apply + return detail::edmonds_karp_dispatch1::apply (g, src, sink, params, get_param(params, vertex_predecessor)); } @@ -236,15 +236,15 @@ namespace boost { typename property_traits< typename property_map::const_type >::value_type - edmunds_karp_max_flow + edmonds_karp_max_flow (Graph& g, typename graph_traits::vertex_descriptor src, typename graph_traits::vertex_descriptor sink) { bgl_named_params params(0); - return edmunds_karp_max_flow(g, src, sink, params); + return edmonds_karp_max_flow(g, src, sink, params); } } // namespace boost -#endif // EDMUNDS_KARP_MAX_FLOW_HPP +#endif // EDMONDS_KARP_MAX_FLOW_HPP diff --git a/test/max_flow_test.cpp b/test/max_flow_test.cpp index 1ecd904c..02d829de 100644 --- a/test/max_flow_test.cpp +++ b/test/max_flow_test.cpp @@ -39,7 +39,7 @@ //three max_flows we test here #include #include -#include +#include //boost utilities we use #include #include @@ -127,10 +127,10 @@ int test_main(int argc, char* argv[]) tEdgeVal kolmo = kolmogorov_max_flow(g,source_vertex,sink_vertex); tEdgeVal push_relabel = push_relabel_max_flow(g,source_vertex,sink_vertex); - tEdgeVal edmunds_karp = edmunds_karp_max_flow(g,source_vertex,sink_vertex); + tEdgeVal edmonds_karp = edmonds_karp_max_flow(g,source_vertex,sink_vertex); BOOST_REQUIRE( kolmo == push_relabel ); - BOOST_REQUIRE( push_relabel == edmunds_karp ); + BOOST_REQUIRE( push_relabel == edmonds_karp ); return 0; }