test/max_flow_test.cc
author Peter Kovacs <kpeter@inf.elte.hu>
Thu, 22 Mar 2018 18:55:31 +0100
changeset 1382 e2732b9da429
parent 1381 e0ccc1f0268f
child 1383 e018899c2926
permissions -rw-r--r--
Refactoring and code formatting in max_flow_test.cc (#608)
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
     2  *
     3  * This file is a part of LEMON, a generic C++ optimization library.
     4  *
     5  * Copyright (C) 2003-2013
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
     8  *
     9  * Permission to use, modify and distribute this software is granted
    10  * provided that this copyright notice appears in all copies. For
    11  * precise terms see the accompanying LICENSE file.
    12  *
    13  * This software is provided "AS IS" with no warranty of any kind,
    14  * express or implied, and with no claim as to its suitability for any
    15  * purpose.
    16  *
    17  */
    18 
    19 #include <iostream>
    20 
    21 #include "test_tools.h"
    22 #include <lemon/smart_graph.h>
    23 #include <lemon/preflow.h>
    24 #include <lemon/edmonds_karp.h>
    25 #include <lemon/concepts/digraph.h>
    26 #include <lemon/concepts/maps.h>
    27 #include <lemon/lgf_reader.h>
    28 #include <lemon/elevator.h>
    29 
    30 using namespace lemon;
    31 
    32 char test_lgf[] =
    33   "@nodes\n"
    34   "label\n"
    35   "0\n"
    36   "1\n"
    37   "2\n"
    38   "3\n"
    39   "4\n"
    40   "5\n"
    41   "6\n"
    42   "7\n"
    43   "8\n"
    44   "9\n"
    45   "@arcs\n"
    46   "    label capacity\n"
    47   "0 1 0     20\n"
    48   "0 2 1     0\n"
    49   "1 1 2     3\n"
    50   "1 2 3     8\n"
    51   "1 3 4     8\n"
    52   "2 5 5     5\n"
    53   "3 2 6     5\n"
    54   "3 5 7     5\n"
    55   "3 6 8     5\n"
    56   "4 3 9     3\n"
    57   "5 7 10    3\n"
    58   "5 6 11    10\n"
    59   "5 8 12    10\n"
    60   "6 8 13    8\n"
    61   "8 9 14    20\n"
    62   "8 1 15    5\n"
    63   "9 5 16    5\n"
    64   "@attributes\n"
    65   "source 1\n"
    66   "target 8\n";
    67 
    68 
    69 // Checks the general interface of a max flow algorithm
    70 template <typename GR, typename CAP>
    71 struct MaxFlowClassConcept
    72 {
    73 
    74   template <typename MF>
    75   struct Constraints {
    76 
    77     typedef typename GR::Node Node;
    78     typedef typename GR::Arc Arc;
    79     typedef typename CAP::Value Value;
    80     typedef concepts::ReadWriteMap<Arc, Value> FlowMap;
    81     typedef concepts::WriteMap<Node, bool> CutMap;
    82 
    83     GR g;
    84     Node n;
    85     Arc e;
    86     CAP cap;
    87     FlowMap flow;
    88     CutMap cut;
    89     Value v;
    90     bool b;
    91 
    92     void constraints() {
    93       checkConcept<concepts::Digraph, GR>();
    94 
    95       const Constraints& me = *this;
    96 
    97       typedef typename MF
    98           ::template SetFlowMap<FlowMap>
    99           ::Create MaxFlowType;
   100       typedef typename MF::Create MaxFlowType2;
   101       MaxFlowType max_flow(me.g, me.cap, me.n, me.n);
   102       const MaxFlowType& const_max_flow = max_flow;
   103 
   104       max_flow
   105           .capacityMap(cap)
   106           .flowMap(flow)
   107           .source(n)
   108           .target(n);
   109 
   110       typename MaxFlowType::Tolerance tol = const_max_flow.tolerance();
   111       max_flow.tolerance(tol);
   112 
   113       max_flow.init();
   114       max_flow.init(cap);
   115       max_flow.run();
   116 
   117       v = const_max_flow.flowValue();
   118       v = const_max_flow.flow(e);
   119       const FlowMap& fm = const_max_flow.flowMap();
   120 
   121       b = const_max_flow.minCut(n);
   122       const_max_flow.minCutMap(cut);
   123 
   124       ::lemon::ignore_unused_variable_warning(fm);
   125     }
   126 
   127   };
   128 
   129 };
   130 
   131 // Checks the specific parts of Preflow's interface
   132 void checkPreflowCompile()
   133 {
   134   typedef int Value;
   135   typedef concepts::Digraph Digraph;
   136   typedef concepts::ReadMap<Digraph::Arc, Value> CapMap;
   137   typedef Elevator<Digraph, Digraph::Node> Elev;
   138   typedef LinkedElevator<Digraph, Digraph::Node> LinkedElev;
   139 
   140   Digraph g;
   141   Digraph::Node n;
   142   CapMap cap;
   143 
   144   typedef Preflow<Digraph, CapMap>
   145       ::SetElevator<Elev>
   146       ::SetStandardElevator<LinkedElev>
   147       ::Create PreflowType;
   148   PreflowType preflow_test(g, cap, n, n);
   149   const PreflowType& const_preflow_test = preflow_test;
   150 
   151   const PreflowType::Elevator& elev = const_preflow_test.elevator();
   152   preflow_test.elevator(const_cast<PreflowType::Elevator&>(elev));
   153 
   154   bool b = preflow_test.init(cap);
   155   preflow_test.startFirstPhase();
   156   preflow_test.startSecondPhase();
   157   preflow_test.runMinCut();
   158 
   159   ::lemon::ignore_unused_variable_warning(b);
   160 }
   161 
   162 // Checks the specific parts of EdmondsKarp's interface
   163 void checkEdmondsKarpCompile()
   164 {
   165   typedef int Value;
   166   typedef concepts::Digraph Digraph;
   167   typedef concepts::ReadMap<Digraph::Arc, Value> CapMap;
   168 
   169   Digraph g;
   170   Digraph::Node n;
   171   CapMap cap;
   172 
   173   EdmondsKarp<Digraph, CapMap> ek_test(g, cap, n, n);
   174 
   175   ek_test.init(cap);
   176   bool b = ek_test.checkedInit(cap);
   177   b = ek_test.augment();
   178   ek_test.start();
   179 
   180   ::lemon::ignore_unused_variable_warning(b);
   181 }
   182 
   183 
   184 template <typename T>
   185 T cutValue(const SmartDigraph& g,
   186            const SmartDigraph::NodeMap<bool>& cut,
   187            const SmartDigraph::ArcMap<T>& cap) {
   188 
   189   T c = 0;
   190   for (SmartDigraph::ArcIt e(g); e != INVALID; ++e) {
   191     if (cut[g.source(e)] && !cut[g.target(e)]) c += cap[e];
   192   }
   193   return c;
   194 }
   195 
   196 template <typename T>
   197 bool checkFlow(const SmartDigraph& g,
   198                const SmartDigraph::ArcMap<T>& flow,
   199                const SmartDigraph::ArcMap<T>& cap,
   200                SmartDigraph::Node s, SmartDigraph::Node t) {
   201 
   202   for (SmartDigraph::ArcIt e(g); e != INVALID; ++e) {
   203     if (flow[e] < 0 || flow[e] > cap[e]) return false;
   204   }
   205 
   206   for (SmartDigraph::NodeIt n(g); n != INVALID; ++n) {
   207     if (n == s || n == t) continue;
   208     T sum = 0;
   209     for (SmartDigraph::OutArcIt e(g, n); e != INVALID; ++e) {
   210       sum += flow[e];
   211     }
   212     for (SmartDigraph::InArcIt e(g, n); e != INVALID; ++e) {
   213       sum -= flow[e];
   214     }
   215     if (sum != 0) return false;
   216   }
   217   return true;
   218 }
   219 
   220 void checkInitPreflow()
   221 {
   222   DIGRAPH_TYPEDEFS(SmartDigraph);
   223 
   224   SmartDigraph g;
   225   SmartDigraph::ArcMap<int> cap(g), iflow(g);
   226   Node s = g.addNode(); Node t = g.addNode();
   227   Node n1 = g.addNode(); Node n2 = g.addNode();
   228   Arc a;
   229   a = g.addArc(s, n1); cap[a] = 20; iflow[a] = 20;
   230   a = g.addArc(n1, n2); cap[a] = 10; iflow[a] = 0;
   231   a = g.addArc(n2, t); cap[a] = 20; iflow[a] = 0;
   232 
   233   Preflow<SmartDigraph> pre(g, cap, s, t);
   234   pre.init(iflow);
   235   pre.startFirstPhase();
   236 
   237   check(pre.flowValue() == 10, "Incorrect max flow value.");
   238   check(pre.minCut(s), "Wrong min cut (Node s).");
   239   check(pre.minCut(n1), "Wrong min cut (Node n1).");
   240   check(!pre.minCut(n2), "Wrong min cut (Node n2).");
   241   check(!pre.minCut(t), "Wrong min cut (Node t).");
   242 }
   243 
   244 template <typename MF, typename SF>
   245 void checkMaxFlowAlg() {
   246   typedef SmartDigraph Digraph;
   247   DIGRAPH_TYPEDEFS(Digraph);
   248 
   249   typedef typename MF::Value Value;
   250   typedef Digraph::ArcMap<Value> CapMap;
   251   typedef CapMap FlowMap;
   252   typedef BoolNodeMap CutMap;
   253 
   254   Digraph g;
   255   Node s, t;
   256   CapMap cap(g);
   257   std::istringstream input(test_lgf);
   258   DigraphReader<Digraph>(g,input)
   259       .arcMap("capacity", cap)
   260       .node("source",s)
   261       .node("target",t)
   262       .run();
   263 
   264   MF max_flow(g, cap, s, t);
   265   max_flow.run();
   266 
   267   check(checkFlow(g, max_flow.flowMap(), cap, s, t),
   268         "The flow is not feasible.");
   269 
   270   CutMap min_cut(g);
   271   max_flow.minCutMap(min_cut);
   272   Value min_cut_value = cutValue(g, min_cut, cap);
   273 
   274   check(max_flow.flowValue() == min_cut_value,
   275         "The max flow value is not equal to the min cut value.");
   276 
   277   FlowMap flow(g);
   278   for (ArcIt e(g); e != INVALID; ++e) flow[e] = max_flow.flowMap()[e];
   279 
   280   Value flow_value = max_flow.flowValue();
   281 
   282   for (ArcIt e(g); e != INVALID; ++e) cap[e] = 2 * cap[e];
   283   max_flow.init(flow);
   284 
   285   SF::startFirstPhase(max_flow);       // start first phase of the algorithm
   286 
   287   CutMap min_cut1(g);
   288   max_flow.minCutMap(min_cut1);
   289   min_cut_value = cutValue(g, min_cut1, cap);
   290 
   291   check(max_flow.flowValue() == min_cut_value &&
   292         min_cut_value == 2 * flow_value,
   293         "The max flow value or the min cut value is wrong.");
   294 
   295   SF::startSecondPhase(max_flow);       // start second phase of the algorithm
   296 
   297   check(checkFlow(g, max_flow.flowMap(), cap, s, t),
   298         "The flow is not feasible.");
   299 
   300   CutMap min_cut2(g);
   301   max_flow.minCutMap(min_cut2);
   302   min_cut_value = cutValue(g, min_cut2, cap);
   303 
   304   check(max_flow.flowValue() == min_cut_value &&
   305         min_cut_value == 2 * flow_value,
   306         "The max flow value or the min cut value was not doubled.");
   307 
   308   max_flow.flowMap(flow);
   309 
   310   NodeIt tmp1(g, s);
   311   ++tmp1;
   312   if (tmp1 != INVALID) s = tmp1;
   313 
   314   NodeIt tmp2(g, t);
   315   ++tmp2;
   316   if (tmp2 != INVALID) t = tmp2;
   317 
   318   max_flow.source(s);
   319   max_flow.target(t);
   320 
   321   max_flow.run();
   322 
   323   CutMap min_cut3(g);
   324   max_flow.minCutMap(min_cut3);
   325   min_cut_value = cutValue(g, min_cut3, cap);
   326 
   327   check(max_flow.flowValue() == min_cut_value,
   328         "The max flow value or the min cut value is wrong.");
   329 }
   330 
   331 // Struct for calling start functions of a general max flow algorithm
   332 template <typename MF>
   333 struct GeneralStartFunctions {
   334 
   335   static void startFirstPhase(MF& mf) {
   336     mf.start();
   337   }
   338 
   339   static void startSecondPhase(MF& mf) {
   340     ::lemon::ignore_unused_variable_warning(mf);
   341   }
   342 
   343 };
   344 
   345 // Struct for calling start functions of Preflow
   346 template <typename MF>
   347 struct PreflowStartFunctions {
   348 
   349   static void startFirstPhase(MF& mf) {
   350     mf.startFirstPhase();
   351   }
   352 
   353   static void startSecondPhase(MF& mf) {
   354     mf.startSecondPhase();
   355   }
   356 
   357 };
   358 
   359 int main() {
   360 
   361   typedef concepts::Digraph GR;
   362   typedef concepts::ReadMap<GR::Arc, int> CM1;
   363   typedef concepts::ReadMap<GR::Arc, double> CM2;
   364 
   365   // Check the interface of Preflow
   366   checkConcept< MaxFlowClassConcept<GR, CM1>,
   367                 Preflow<GR, CM1> >();
   368   checkConcept< MaxFlowClassConcept<GR, CM2>,
   369                 Preflow<GR, CM2> >();
   370 
   371   // Check the interface of EdmondsKarp
   372   checkConcept< MaxFlowClassConcept<GR, CM1>,
   373                 EdmondsKarp<GR, CM1> >();
   374   checkConcept< MaxFlowClassConcept<GR, CM2>,
   375                 EdmondsKarp<GR, CM2> >();
   376 
   377   // Check Preflow
   378   typedef Preflow<SmartDigraph, SmartDigraph::ArcMap<int> > PType1;
   379   typedef Preflow<SmartDigraph, SmartDigraph::ArcMap<float> > PType2;
   380   checkMaxFlowAlg<PType1, PreflowStartFunctions<PType1> >();
   381   checkMaxFlowAlg<PType2, PreflowStartFunctions<PType2> >();
   382 
   383   checkInitPreflow();
   384 
   385   // Check EdmondsKarp
   386   typedef EdmondsKarp<SmartDigraph, SmartDigraph::ArcMap<int> > EKType1;
   387   typedef EdmondsKarp<SmartDigraph, SmartDigraph::ArcMap<float> > EKType2;
   388   checkMaxFlowAlg<EKType1, GeneralStartFunctions<EKType1> >();
   389   checkMaxFlowAlg<EKType2, GeneralStartFunctions<EKType2> >();
   390 
   391   return 0;
   392 }