kpeter@601: /* -*- mode: C++; indent-tabs-mode: nil; -*-
kpeter@601:  *
kpeter@601:  * This file is a part of LEMON, a generic C++ optimization library.
kpeter@601:  *
kpeter@601:  * Copyright (C) 2003-2009
kpeter@601:  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
kpeter@601:  * (Egervary Research Group on Combinatorial Optimization, EGRES).
kpeter@601:  *
kpeter@601:  * Permission to use, modify and distribute this software is granted
kpeter@601:  * provided that this copyright notice appears in all copies. For
kpeter@601:  * precise terms see the accompanying LICENSE file.
kpeter@601:  *
kpeter@601:  * This software is provided "AS IS" with no warranty of any kind,
kpeter@601:  * express or implied, and with no claim as to its suitability for any
kpeter@601:  * purpose.
kpeter@601:  *
kpeter@601:  */
kpeter@601: 
kpeter@601: #include <iostream>
kpeter@601: #include <fstream>
kpeter@601: 
kpeter@601: #include <lemon/list_graph.h>
kpeter@601: #include <lemon/lgf_reader.h>
kpeter@601: 
kpeter@601: #include <lemon/network_simplex.h>
kpeter@601: 
kpeter@601: #include <lemon/concepts/digraph.h>
kpeter@601: #include <lemon/concept_check.h>
kpeter@601: 
kpeter@601: #include "test_tools.h"
kpeter@601: 
kpeter@601: using namespace lemon;
kpeter@601: 
kpeter@601: char test_lgf[] =
kpeter@601:   "@nodes\n"
kpeter@609:   "label  sup1 sup2 sup3 sup4 sup5\n"
kpeter@609:   "    1    20   27    0   20   30\n"
kpeter@609:   "    2    -4    0    0   -8   -3\n"
kpeter@609:   "    3     0    0    0    0    0\n"
kpeter@609:   "    4     0    0    0    0    0\n"
kpeter@609:   "    5     9    0    0    6   11\n"
kpeter@609:   "    6    -6    0    0   -5   -6\n"
kpeter@609:   "    7     0    0    0    0    0\n"
kpeter@609:   "    8     0    0    0    0    3\n"
kpeter@609:   "    9     3    0    0    0    0\n"
kpeter@609:   "   10    -2    0    0   -7   -2\n"
kpeter@609:   "   11     0    0    0  -10    0\n"
kpeter@609:   "   12   -20  -27    0  -30  -20\n"
kpeter@601:   "\n"
kpeter@601:   "@arcs\n"
kpeter@601:   "       cost  cap low1 low2\n"
kpeter@601:   " 1  2    70   11    0    8\n"
kpeter@601:   " 1  3   150    3    0    1\n"
kpeter@601:   " 1  4    80   15    0    2\n"
kpeter@601:   " 2  8    80   12    0    0\n"
kpeter@601:   " 3  5   140    5    0    3\n"
kpeter@601:   " 4  6    60   10    0    1\n"
kpeter@601:   " 4  7    80    2    0    0\n"
kpeter@601:   " 4  8   110    3    0    0\n"
kpeter@601:   " 5  7    60   14    0    0\n"
kpeter@601:   " 5 11   120   12    0    0\n"
kpeter@601:   " 6  3     0    3    0    0\n"
kpeter@601:   " 6  9   140    4    0    0\n"
kpeter@601:   " 6 10    90    8    0    0\n"
kpeter@601:   " 7  1    30    5    0    0\n"
kpeter@601:   " 8 12    60   16    0    4\n"
kpeter@601:   " 9 12    50    6    0    0\n"
kpeter@601:   "10 12    70   13    0    5\n"
kpeter@601:   "10  2   100    7    0    0\n"
kpeter@601:   "10  7    60   10    0    0\n"
kpeter@601:   "11 10    20   14    0    6\n"
kpeter@601:   "12 11    30   10    0    0\n"
kpeter@601:   "\n"
kpeter@601:   "@attributes\n"
kpeter@601:   "source 1\n"
kpeter@601:   "target 12\n";
kpeter@601: 
kpeter@601: 
kpeter@609: enum ProblemType {
kpeter@609:   EQ,
kpeter@609:   GEQ,
kpeter@609:   LEQ
kpeter@609: };
kpeter@609: 
kpeter@601: // Check the interface of an MCF algorithm
kpeter@607: template <typename GR, typename Flow, typename Cost>
kpeter@601: class McfClassConcept
kpeter@601: {
kpeter@601: public:
kpeter@601: 
kpeter@601:   template <typename MCF>
kpeter@601:   struct Constraints {
kpeter@601:     void constraints() {
kpeter@601:       checkConcept<concepts::Digraph, GR>();
kpeter@601: 
kpeter@605:       MCF mcf(g);
kpeter@601: 
kpeter@606:       b = mcf.reset()
kpeter@606:              .lowerMap(lower)
kpeter@605:              .upperMap(upper)
kpeter@605:              .capacityMap(upper)
kpeter@605:              .boundMaps(lower, upper)
kpeter@605:              .costMap(cost)
kpeter@605:              .supplyMap(sup)
kpeter@605:              .stSupply(n, n, k)
kpeter@609:              .flowMap(flow)
kpeter@609:              .potentialMap(pot)
kpeter@605:              .run();
kpeter@609:       
kpeter@609:       const MCF& const_mcf = mcf;
kpeter@601: 
kpeter@609:       const typename MCF::FlowMap &fm = const_mcf.flowMap();
kpeter@609:       const typename MCF::PotentialMap &pm = const_mcf.potentialMap();
kpeter@605: 
kpeter@609:       v = const_mcf.totalCost();
kpeter@609:       double x = const_mcf.template totalCost<double>();
kpeter@609:       v = const_mcf.flow(a);
kpeter@609:       v = const_mcf.potential(n);
kpeter@605: 
kpeter@601:       ignore_unused_variable_warning(fm);
kpeter@601:       ignore_unused_variable_warning(pm);
kpeter@605:       ignore_unused_variable_warning(x);
kpeter@601:     }
kpeter@601: 
kpeter@601:     typedef typename GR::Node Node;
kpeter@601:     typedef typename GR::Arc Arc;
kpeter@607:     typedef concepts::ReadMap<Node, Flow> NM;
kpeter@607:     typedef concepts::ReadMap<Arc, Flow> FAM;
kpeter@607:     typedef concepts::ReadMap<Arc, Cost> CAM;
kpeter@601: 
kpeter@601:     const GR &g;
kpeter@607:     const FAM &lower;
kpeter@607:     const FAM &upper;
kpeter@607:     const CAM &cost;
kpeter@601:     const NM &sup;
kpeter@601:     const Node &n;
kpeter@601:     const Arc &a;
kpeter@607:     const Flow &k;
kpeter@607:     Flow v;
kpeter@605:     bool b;
kpeter@601: 
kpeter@601:     typename MCF::FlowMap &flow;
kpeter@601:     typename MCF::PotentialMap &pot;
kpeter@601:   };
kpeter@601: 
kpeter@601: };
kpeter@601: 
kpeter@601: 
kpeter@601: // Check the feasibility of the given flow (primal soluiton)
kpeter@601: template < typename GR, typename LM, typename UM,
kpeter@601:            typename SM, typename FM >
kpeter@601: bool checkFlow( const GR& gr, const LM& lower, const UM& upper,
kpeter@609:                 const SM& supply, const FM& flow,
kpeter@609:                 ProblemType type = EQ )
kpeter@601: {
kpeter@601:   TEMPLATE_DIGRAPH_TYPEDEFS(GR);
kpeter@601: 
kpeter@601:   for (ArcIt e(gr); e != INVALID; ++e) {
kpeter@601:     if (flow[e] < lower[e] || flow[e] > upper[e]) return false;
kpeter@601:   }
kpeter@601: 
kpeter@601:   for (NodeIt n(gr); n != INVALID; ++n) {
kpeter@601:     typename SM::Value sum = 0;
kpeter@601:     for (OutArcIt e(gr, n); e != INVALID; ++e)
kpeter@601:       sum += flow[e];
kpeter@601:     for (InArcIt e(gr, n); e != INVALID; ++e)
kpeter@601:       sum -= flow[e];
kpeter@609:     bool b = (type ==  EQ && sum == supply[n]) ||
kpeter@609:              (type == GEQ && sum >= supply[n]) ||
kpeter@609:              (type == LEQ && sum <= supply[n]);
kpeter@609:     if (!b) return false;
kpeter@601:   }
kpeter@601: 
kpeter@601:   return true;
kpeter@601: }
kpeter@601: 
kpeter@601: // Check the feasibility of the given potentials (dual soluiton)
kpeter@605: // using the "Complementary Slackness" optimality condition
kpeter@601: template < typename GR, typename LM, typename UM,
kpeter@609:            typename CM, typename SM, typename FM, typename PM >
kpeter@601: bool checkPotential( const GR& gr, const LM& lower, const UM& upper,
kpeter@609:                      const CM& cost, const SM& supply, const FM& flow, 
kpeter@609:                      const PM& pi )
kpeter@601: {
kpeter@601:   TEMPLATE_DIGRAPH_TYPEDEFS(GR);
kpeter@601: 
kpeter@601:   bool opt = true;
kpeter@601:   for (ArcIt e(gr); opt && e != INVALID; ++e) {
kpeter@601:     typename CM::Value red_cost =
kpeter@601:       cost[e] + pi[gr.source(e)] - pi[gr.target(e)];
kpeter@601:     opt = red_cost == 0 ||
kpeter@601:           (red_cost > 0 && flow[e] == lower[e]) ||
kpeter@601:           (red_cost < 0 && flow[e] == upper[e]);
kpeter@601:   }
kpeter@609:   
kpeter@609:   for (NodeIt n(gr); opt && n != INVALID; ++n) {
kpeter@609:     typename SM::Value sum = 0;
kpeter@609:     for (OutArcIt e(gr, n); e != INVALID; ++e)
kpeter@609:       sum += flow[e];
kpeter@609:     for (InArcIt e(gr, n); e != INVALID; ++e)
kpeter@609:       sum -= flow[e];
kpeter@609:     opt = (sum == supply[n]) || (pi[n] == 0);
kpeter@609:   }
kpeter@609:   
kpeter@601:   return opt;
kpeter@601: }
kpeter@601: 
kpeter@601: // Run a minimum cost flow algorithm and check the results
kpeter@601: template < typename MCF, typename GR,
kpeter@601:            typename LM, typename UM,
kpeter@601:            typename CM, typename SM >
kpeter@601: void checkMcf( const MCF& mcf, bool mcf_result,
kpeter@601:                const GR& gr, const LM& lower, const UM& upper,
kpeter@601:                const CM& cost, const SM& supply,
kpeter@601:                bool result, typename CM::Value total,
kpeter@609:                const std::string &test_id = "",
kpeter@609:                ProblemType type = EQ )
kpeter@601: {
kpeter@601:   check(mcf_result == result, "Wrong result " + test_id);
kpeter@601:   if (result) {
kpeter@609:     check(checkFlow(gr, lower, upper, supply, mcf.flowMap(), type),
kpeter@601:           "The flow is not feasible " + test_id);
kpeter@601:     check(mcf.totalCost() == total, "The flow is not optimal " + test_id);
kpeter@609:     check(checkPotential(gr, lower, upper, cost, supply, mcf.flowMap(),
kpeter@601:                          mcf.potentialMap()),
kpeter@601:           "Wrong potentials " + test_id);
kpeter@601:   }
kpeter@601: }
kpeter@601: 
kpeter@601: int main()
kpeter@601: {
kpeter@601:   // Check the interfaces
kpeter@601:   {
kpeter@607:     typedef int Flow;
kpeter@607:     typedef int Cost;
kpeter@605:     // TODO: This typedef should be enabled if the standard maps are
kpeter@605:     // reference maps in the graph concepts (See #190).
kpeter@605: /**/
kpeter@601:     //typedef concepts::Digraph GR;
kpeter@601:     typedef ListDigraph GR;
kpeter@605: /**/
kpeter@607:     checkConcept< McfClassConcept<GR, Flow, Cost>,
kpeter@607:                   NetworkSimplex<GR, Flow, Cost> >();
kpeter@601:   }
kpeter@601: 
kpeter@601:   // Run various MCF tests
kpeter@601:   typedef ListDigraph Digraph;
kpeter@601:   DIGRAPH_TYPEDEFS(ListDigraph);
kpeter@601: 
kpeter@601:   // Read the test digraph
kpeter@601:   Digraph gr;
kpeter@601:   Digraph::ArcMap<int> c(gr), l1(gr), l2(gr), u(gr);
kpeter@609:   Digraph::NodeMap<int> s1(gr), s2(gr), s3(gr), s4(gr), s5(gr);
kpeter@605:   ConstMap<Arc, int> cc(1), cu(std::numeric_limits<int>::max());
kpeter@601:   Node v, w;
kpeter@601: 
kpeter@601:   std::istringstream input(test_lgf);
kpeter@601:   DigraphReader<Digraph>(gr, input)
kpeter@601:     .arcMap("cost", c)
kpeter@601:     .arcMap("cap", u)
kpeter@601:     .arcMap("low1", l1)
kpeter@601:     .arcMap("low2", l2)
kpeter@601:     .nodeMap("sup1", s1)
kpeter@601:     .nodeMap("sup2", s2)
kpeter@601:     .nodeMap("sup3", s3)
kpeter@609:     .nodeMap("sup4", s4)
kpeter@609:     .nodeMap("sup5", s5)
kpeter@601:     .node("source", v)
kpeter@601:     .node("target", w)
kpeter@601:     .run();
kpeter@601: 
kpeter@605:   // A. Test NetworkSimplex with the default pivot rule
kpeter@601:   {
kpeter@606:     NetworkSimplex<Digraph> mcf(gr);
kpeter@601: 
kpeter@609:     // Check the equality form
kpeter@606:     mcf.upperMap(u).costMap(c);
kpeter@606:     checkMcf(mcf, mcf.supplyMap(s1).run(),
kpeter@605:              gr, l1, u, c, s1, true,  5240, "#A1");
kpeter@606:     checkMcf(mcf, mcf.stSupply(v, w, 27).run(),
kpeter@605:              gr, l1, u, c, s2, true,  7620, "#A2");
kpeter@606:     mcf.lowerMap(l2);
kpeter@606:     checkMcf(mcf, mcf.supplyMap(s1).run(),
kpeter@605:              gr, l2, u, c, s1, true,  5970, "#A3");
kpeter@606:     checkMcf(mcf, mcf.stSupply(v, w, 27).run(),
kpeter@605:              gr, l2, u, c, s2, true,  8010, "#A4");
kpeter@606:     mcf.reset();
kpeter@606:     checkMcf(mcf, mcf.supplyMap(s1).run(),
kpeter@605:              gr, l1, cu, cc, s1, true,  74, "#A5");
kpeter@606:     checkMcf(mcf, mcf.lowerMap(l2).stSupply(v, w, 27).run(),
kpeter@605:              gr, l2, cu, cc, s2, true,  94, "#A6");
kpeter@606:     mcf.reset();
kpeter@606:     checkMcf(mcf, mcf.run(),
kpeter@605:              gr, l1, cu, cc, s3, true,   0, "#A7");
kpeter@606:     checkMcf(mcf, mcf.boundMaps(l2, u).run(),
kpeter@605:              gr, l2, u, cc, s3, false,   0, "#A8");
kpeter@609: 
kpeter@609:     // Check the GEQ form
kpeter@609:     mcf.reset().upperMap(u).costMap(c).supplyMap(s4);
kpeter@609:     checkMcf(mcf, mcf.run(),
kpeter@609:              gr, l1, u, c, s4, true,  3530, "#A9", GEQ);
kpeter@609:     mcf.problemType(mcf.GEQ);
kpeter@609:     checkMcf(mcf, mcf.lowerMap(l2).run(),
kpeter@609:              gr, l2, u, c, s4, true,  4540, "#A10", GEQ);
kpeter@609:     mcf.problemType(mcf.CARRY_SUPPLIES).supplyMap(s5);
kpeter@609:     checkMcf(mcf, mcf.run(),
kpeter@609:              gr, l2, u, c, s5, false,    0, "#A11", GEQ);
kpeter@609: 
kpeter@609:     // Check the LEQ form
kpeter@609:     mcf.reset().problemType(mcf.LEQ);
kpeter@609:     mcf.upperMap(u).costMap(c).supplyMap(s5);
kpeter@609:     checkMcf(mcf, mcf.run(),
kpeter@609:              gr, l1, u, c, s5, true,  5080, "#A12", LEQ);
kpeter@609:     checkMcf(mcf, mcf.lowerMap(l2).run(),
kpeter@609:              gr, l2, u, c, s5, true,  5930, "#A13", LEQ);
kpeter@609:     mcf.problemType(mcf.SATISFY_DEMANDS).supplyMap(s4);
kpeter@609:     checkMcf(mcf, mcf.run(),
kpeter@609:              gr, l2, u, c, s4, false,    0, "#A14", LEQ);
kpeter@601:   }
kpeter@601: 
kpeter@605:   // B. Test NetworkSimplex with each pivot rule
kpeter@601:   {
kpeter@606:     NetworkSimplex<Digraph> mcf(gr);
kpeter@606:     mcf.supplyMap(s1).costMap(c).capacityMap(u).lowerMap(l2);
kpeter@601: 
kpeter@606:     checkMcf(mcf, mcf.run(NetworkSimplex<Digraph>::FIRST_ELIGIBLE),
kpeter@605:              gr, l2, u, c, s1, true,  5970, "#B1");
kpeter@606:     checkMcf(mcf, mcf.run(NetworkSimplex<Digraph>::BEST_ELIGIBLE),
kpeter@605:              gr, l2, u, c, s1, true,  5970, "#B2");
kpeter@606:     checkMcf(mcf, mcf.run(NetworkSimplex<Digraph>::BLOCK_SEARCH),
kpeter@605:              gr, l2, u, c, s1, true,  5970, "#B3");
kpeter@606:     checkMcf(mcf, mcf.run(NetworkSimplex<Digraph>::CANDIDATE_LIST),
kpeter@605:              gr, l2, u, c, s1, true,  5970, "#B4");
kpeter@606:     checkMcf(mcf, mcf.run(NetworkSimplex<Digraph>::ALTERING_LIST),
kpeter@605:              gr, l2, u, c, s1, true,  5970, "#B5");
kpeter@601:   }
kpeter@601: 
kpeter@601:   return 0;
kpeter@601: }