RhodeCode

    /// of the class or the last \ref reset() call, then the \ref reset()

    /// function must be used, otherwise \ref resetParams() is sufficient.

    ///

    /// See \ref resetParams() for examples.

    ///

    /// \return <tt>(*this)</tt>

    ///

    /// \see resetParams(), run()

    NetworkSimplex& reset() {

      // Resize vectors

      _node_num = countNodes(_graph);

      _arc_num = countArcs(_graph);

      int all_node_num = _node_num + 1;

      int max_arc_num = _arc_num + 2 * _node_num;

      _source.resize(max_arc_num);

      _target.resize(max_arc_num);

      _lower.resize(_arc_num);

      _upper.resize(_arc_num);

      _cap.resize(max_arc_num);

      _cost.resize(max_arc_num);

      _supply.resize(all_node_num);

      _flow.resize(max_arc_num);

      _pi.resize(all_node_num);

      _parent.resize(all_node_num);

      _pred.resize(all_node_num);

      _forward.resize(all_node_num);

      _thread.resize(all_node_num);

      _rev_thread.resize(all_node_num);

      _succ_num.resize(all_node_num);

      _last_succ.resize(all_node_num);

      _state.resize(max_arc_num);

      // Copy the graph

      int i = 0;

      for (NodeIt n(_graph); n != INVALID; ++n, ++i) {

        _node_id[n] = i;

      }

      if (_arc_mixing) {

        // Store the arcs in a mixed order

        int k = std::max(int(std::sqrt(double(_arc_num))), 10);

        int i = 0, j = 0;

        for (ArcIt a(_graph); a != INVALID; ++a) {

          _arc_id[a] = i;

          _source[i] = _node_id[_graph.source(a)];

          _target[i] = _node_id[_graph.target(a)];

          if ((i += k) >= _arc_num) i = ++j;

        }

      } else {

        // Store the arcs in the original order

        int i = 0;

        for (ArcIt a(_graph); a != INVALID; ++a, ++i) {

          _arc_id[a] = i;

          _source[i] = _node_id[_graph.source(a)];

          _target[i] = _node_id[_graph.target(a)];

        }

      }

      // Reset parameters

      resetParams();

      return *this;

    }

    /// @}

    /// \name Query Functions

    /// The results of the algorithm can be obtained using these

    /// functions.\n

    /// The \ref run() function must be called before using them.

    /// @{

    /// \brief Return the total cost of the found flow.

    ///

    /// This function returns the total cost of the found flow.

    /// Its complexity is O(e).

    ///

    /// \note The return type of the function can be specified as a

    /// template parameter. For example,

    /// \code

    ///   ns.totalCost<double>();

    /// \endcode

    /// It is useful if the total cost cannot be stored in the \c Cost

    /// type of the algorithm, which is the default return type of the

    /// function.

    ///

    /// \pre \ref run() must be called before using this function.

    template <typename Number>

    Number totalCost() const {

      Number c = 0;

      for (ArcIt a(_graph); a != INVALID; ++a) {

        int i = _arc_id[a];

        c += Number(_flow[i]) * Number(_cost[i]);

      }

      return c;

    }

#ifndef DOXYGEN

    Cost totalCost() const {

      return totalCost<Cost>();

    }

#endif

    /// \brief Return the flow on the given arc.

    ///

    /// This function returns the flow on the given arc.

    ///

    /// \pre \ref run() must be called before using this function.

    Value flow(const Arc& a) const {

      return _flow[_arc_id[a]];

    }

    /// \brief Return the flow map (the primal solution).

    ///

    /// This function copies the flow value on each arc into the given

    /// map. The \c Value type of the algorithm must be convertible to

    /// the \c Value type of the map.

    ///

    /// \pre \ref run() must be called before using this function.

    template <typename FlowMap>

    void flowMap(FlowMap &map) const {

      for (ArcIt a(_graph); a != INVALID; ++a) {

        map.set(a, _flow[_arc_id[a]]);

      }

    }

    /// \brief Return the potential (dual value) of the given node.

    ///

    /// This function returns the potential (dual value) of the

    /// given node.

    ///

    /// \pre \ref run() must be called before using this function.

    Cost potential(const Node& n) const {

      return _pi[_node_id[n]];

    }

    /// \brief Return the potential map (the dual solution).

    ///

    /// This function copies the potential (dual value) of each node

    /// into the given map.

    /// The \c Cost type of the algorithm must be convertible to the

    /// \c Value type of the map.

    ///

    /// \pre \ref run() must be called before using this function.

    template <typename PotentialMap>

    void potentialMap(PotentialMap &map) const {

      for (NodeIt n(_graph); n != INVALID; ++n) {

        map.set(n, _pi[_node_id[n]]);

      }

    }

    /// @}

  private:

    // Initialize internal data structures

    bool init() {

      if (_node_num == 0) return false;

      // Check the sum of supply values

      _sum_supply = 0;

      for (int i = 0; i != _node_num; ++i) {

        _sum_supply += _supply[i];

      }

      if ( !((_stype == GEQ && _sum_supply <= 0) ||

             (_stype == LEQ && _sum_supply >= 0)) ) return false;

      // Remove non-zero lower bounds

      if (_have_lower) {

        for (int i = 0; i != _arc_num; ++i) {

          Value c = _lower[i];

          if (c >= 0) {

            _cap[i] = _upper[i] < MAX ? _upper[i] - c : INF;

          } else {

            _cap[i] = _upper[i] < MAX + c ? _upper[i] - c : INF;

          }

          _supply[_source[i]] -= c;

          _supply[_target[i]] += c;

        }

      } else {

        for (int i = 0; i != _arc_num; ++i) {

          _cap[i] = _upper[i];

        }

      }

      // Initialize artifical cost

      Cost ART_COST;

      if (std::numeric_limits<Cost>::is_exact) {

        ART_COST = std::numeric_limits<Cost>::max() / 2 + 1;

      } else {

        for (int i = 0; i != _arc_num; ++i) {

          if (_cost[i] > ART_COST) ART_COST = _cost[i];

        }

        ART_COST = (ART_COST + 1) * _node_num;

      }

      // Initialize arc maps

      for (int i = 0; i != _arc_num; ++i) {

        _flow[i] = 0;

        _state[i] = STATE_LOWER;

      }

      // Set data for the artificial root node

      _root = _node_num;

      _parent[_root] = -1;

      _pred[_root] = -1;

      _thread[_root] = 0;

      _rev_thread[0] = _root;

      _succ_num[_root] = _node_num + 1;

      _last_succ[_root] = _root - 1;

      _supply[_root] = -_sum_supply;

      _pi[_root] = 0;

      // Add artificial arcs and initialize the spanning tree data structure

      if (_sum_supply == 0) {

        // EQ supply constraints

        _search_arc_num = _arc_num;

        _all_arc_num = _arc_num + _node_num;

        for (int u = 0, e = _arc_num; u != _node_num; ++u, ++e) {

          _parent[u] = _root;

          _pred[u] = e;

          _thread[u] = u + 1;

          _rev_thread[u + 1] = u;

          _succ_num[u] = 1;

          _last_succ[u] = u;

          _cap[e] = INF;

          _state[e] = STATE_TREE;

          if (_supply[u] >= 0) {

            _forward[u] = true;

            _pi[u] = 0;

            _source[e] = u;

            _target[e] = _root;

            _flow[e] = _supply[u];

            _cost[e] = 0;

          } else {

            _forward[u] = false;

            _pi[u] = ART_COST;

            _source[e] = _root;

            _target[e] = u;

            _flow[e] = -_supply[u];

            _cost[e] = ART_COST;

          }

        }

      }

      else if (_sum_supply > 0) {

        // LEQ supply constraints

        _search_arc_num = _arc_num + _node_num;

        int f = _arc_num + _node_num;

        for (int u = 0, e = _arc_num; u != _node_num; ++u, ++e) {

          _parent[u] = _root;

          _thread[u] = u + 1;

          _rev_thread[u + 1] = u;

          _succ_num[u] = 1;

          _last_succ[u] = u;

          if (_supply[u] >= 0) {

            _forward[u] = true;

            _pi[u] = 0;

            _pred[u] = e;

            _source[e] = u;

            _target[e] = _root;

            _cap[e] = INF;

            _flow[e] = _supply[u];

            _cost[e] = 0;

            _state[e] = STATE_TREE;

          } else {

            _forward[u] = false;

            _pi[u] = ART_COST;

            _pred[u] = f;

            _source[f] = _root;

            _target[f] = u;

            _cap[f] = INF;

            _flow[f] = -_supply[u];

            _cost[f] = ART_COST;

            _state[f] = STATE_TREE;

            _source[e] = u;

            _target[e] = _root;

            _cap[e] = INF;

            _flow[e] = 0;

            _cost[e] = 0;

            _state[e] = STATE_LOWER;

            ++f;

          }

        }

        _all_arc_num = f;

      }

      else {

        // GEQ supply constraints

        _search_arc_num = _arc_num + _node_num;

        int f = _arc_num + _node_num;

        for (int u = 0, e = _arc_num; u != _node_num; ++u, ++e) {

          _parent[u] = _root;

          _thread[u] = u + 1;

          _rev_thread[u + 1] = u;

          _succ_num[u] = 1;

          _last_succ[u] = u;

          if (_supply[u] <= 0) {

            _forward[u] = false;

            _pi[u] = 0;

            _pred[u] = e;

            _source[e] = _root;

            _target[e] = u;

            _cap[e] = INF;

            _flow[e] = -_supply[u];

            _cost[e] = 0;

            _state[e] = STATE_TREE;

          } else {

            _forward[u] = true;

            _pi[u] = -ART_COST;

            _pred[u] = f;

            _source[f] = u;

            _target[f] = _root;

            _cap[f] = INF;

            _flow[f] = _supply[u];

            _state[f] = STATE_TREE;

            _cost[f] = ART_COST;

            _source[e] = _root;

            _target[e] = u;

            _cap[e] = INF;

            _flow[e] = 0;

            _cost[e] = 0;

            _state[e] = STATE_LOWER;

            ++f;

          }

        }

        _all_arc_num = f;

      }

      return true;

    }

    // Find the join node

    void findJoinNode() {

      int u = _source[in_arc];

      int v = _target[in_arc];

      while (u != v) {

        if (_succ_num[u] < _succ_num[v]) {

          u = _parent[u];

        } else {

          v = _parent[v];

        }

      }

      join = u;

    }

    // Find the leaving arc of the cycle and returns true if the

    // leaving arc is not the same as the entering arc

    bool findLeavingArc() {

      // Initialize first and second nodes according to the direction

      // of the cycle

      if (_state[in_arc] == STATE_LOWER) {

        first  = _source[in_arc];

        second = _target[in_arc];

      } else {

        first  = _target[in_arc];

        second = _source[in_arc];

      }

      delta = _cap[in_arc];

      int result = 0;

      Value d;

      int e;

      // Search the cycle along the path form the first node to the root

      for (int u = first; u != join; u = _parent[u]) {

        e = _pred[u];

        d = _forward[u] ?

          _flow[e] : (_cap[e] >= MAX ? INF : _cap[e] - _flow[e]);

        if (d < delta) {

          delta = d;

          u_out = u;

          result = 1;

        }

      }

      // Search the cycle along the path form the second node to the root

      for (int u = second; u != join; u = _parent[u]) {

        e = _pred[u];

        d = _forward[u] ?

          (_cap[e] >= MAX ? INF : _cap[e] - _flow[e]) : _flow[e];

        if (d <= delta) {

          delta = d;

          u_out = u;

          result = 2;

        }

      // Update _last_succ from v_in towards the root

      for (u = v_in; u != up_limit_in && _last_succ[u] == v_in;

           u = _parent[u]) {

        _last_succ[u] = _last_succ[u_out];

      }

      // Update _last_succ from v_out towards the root

      if (join != old_rev_thread && v_in != old_rev_thread) {

        for (u = v_out; u != up_limit_out && _last_succ[u] == old_last_succ;

             u = _parent[u]) {

          _last_succ[u] = old_rev_thread;

        }

      } else {

        for (u = v_out; u != up_limit_out && _last_succ[u] == old_last_succ;

             u = _parent[u]) {

          _last_succ[u] = _last_succ[u_out];

        }

      }

      // Update _succ_num from v_in to join

      for (u = v_in; u != join; u = _parent[u]) {

        _succ_num[u] += old_succ_num;

      }

      // Update _succ_num from v_out to join

      for (u = v_out; u != join; u = _parent[u]) {

        _succ_num[u] -= old_succ_num;

      }

    }

    // Update potentials

    void updatePotential() {

      Cost sigma = _forward[u_in] ?

        _pi[v_in] - _pi[u_in] - _cost[_pred[u_in]] :

        _pi[v_in] - _pi[u_in] + _cost[_pred[u_in]];

      // Update potentials in the subtree, which has been moved

      int end = _thread[_last_succ[u_in]];

      for (int u = u_in; u != end; u = _thread[u]) {

        _pi[u] += sigma;

      }

    }

    // Heuristic initial pivots

    bool initialPivots() {

      Value curr, total = 0;

      std::vector<Node> supply_nodes, demand_nodes;

      for (NodeIt u(_graph); u != INVALID; ++u) {

        curr = _supply[_node_id[u]];

        if (curr > 0) {

          total += curr;

          supply_nodes.push_back(u);

        }

        else if (curr < 0) {

          demand_nodes.push_back(u);

        }

      }

      if (_sum_supply > 0) total -= _sum_supply;

      if (total <= 0) return true;

      IntVector arc_vector;

      if (_sum_supply >= 0) {

        if (supply_nodes.size() == 1 && demand_nodes.size() == 1) {

          // Perform a reverse graph search from the sink to the source

          typename GR::template NodeMap<bool> reached(_graph, false);

          Node s = supply_nodes[0], t = demand_nodes[0];

          std::vector<Node> stack;

          reached[t] = true;

          stack.push_back(t);

          while (!stack.empty()) {

            Node u, v = stack.back();

            stack.pop_back();

            if (v == s) break;

            for (InArcIt a(_graph, v); a != INVALID; ++a) {

              if (reached[u = _graph.source(a)]) continue;

              int j = _arc_id[a];

              if (_cap[j] >= total) {

                arc_vector.push_back(j);

                reached[u] = true;

                stack.push_back(u);

              }

            }

          }

        } else {

          // Find the min. cost incomming arc for each demand node

          for (int i = 0; i != int(demand_nodes.size()); ++i) {

            Node v = demand_nodes[i];

            Cost c, min_cost = std::numeric_limits<Cost>::max();

            Arc min_arc = INVALID;

            for (InArcIt a(_graph, v); a != INVALID; ++a) {

              c = _cost[_arc_id[a]];

              if (c < min_cost) {

                min_cost = c;

                min_arc = a;

              }

            }

            if (min_arc != INVALID) {

              arc_vector.push_back(_arc_id[min_arc]);

            }

          }

        }

      } else {

        // Find the min. cost outgoing arc for each supply node

        for (int i = 0; i != int(supply_nodes.size()); ++i) {

          Node u = supply_nodes[i];

          Cost c, min_cost = std::numeric_limits<Cost>::max();

          Arc min_arc = INVALID;

          for (OutArcIt a(_graph, u); a != INVALID; ++a) {

            c = _cost[_arc_id[a]];

            if (c < min_cost) {

              min_cost = c;

              min_arc = a;

            }

          }

          if (min_arc != INVALID) {

            arc_vector.push_back(_arc_id[min_arc]);

          }

        }

      }

      // Perform heuristic initial pivots

      for (int i = 0; i != int(arc_vector.size()); ++i) {

        in_arc = arc_vector[i];

        if (_state[in_arc] * (_cost[in_arc] + _pi[_source[in_arc]] -

            _pi[_target[in_arc]]) >= 0) continue;

        findJoinNode();

        bool change = findLeavingArc();

        if (delta >= MAX) return false;

        changeFlow(change);

        if (change) {

          updateTreeStructure();

          updatePotential();

        }

      }

      return true;

    }

    // Execute the algorithm

    ProblemType start(PivotRule pivot_rule) {

      // Select the pivot rule implementation

      switch (pivot_rule) {

        case FIRST_ELIGIBLE:

          return start<FirstEligiblePivotRule>();

        case BEST_ELIGIBLE:

          return start<BestEligiblePivotRule>();

        case BLOCK_SEARCH:

          return start<BlockSearchPivotRule>();

        case CANDIDATE_LIST:

          return start<CandidateListPivotRule>();

        case ALTERING_LIST:

          return start<AlteringListPivotRule>();

      }

      return INFEASIBLE; // avoid warning

    }

    template <typename PivotRuleImpl>

    ProblemType start() {

      PivotRuleImpl pivot(*this);

      // Perform heuristic initial pivots

      if (!initialPivots()) return UNBOUNDED;

      // Execute the Network Simplex algorithm

      while (pivot.findEnteringArc()) {

        findJoinNode();

        bool change = findLeavingArc();

        if (delta >= MAX) return UNBOUNDED;

        changeFlow(change);

        if (change) {

          updateTreeStructure();

          updatePotential();

        }

      }

      // Check feasibility

      for (int e = _search_arc_num; e != _all_arc_num; ++e) {

        if (_flow[e] != 0) return INFEASIBLE;

      }

      // Transform the solution and the supply map to the original form

      if (_have_lower) {

        for (int i = 0; i != _arc_num; ++i) {

          Value c = _lower[i];

          if (c != 0) {

            _flow[i] += c;

            _supply[_source[i]] += c;

            _supply[_target[i]] -= c;

          }

        }

      }

      // Shift potentials to meet the requirements of the GEQ/LEQ type

      // optimality conditions

      if (_sum_supply == 0) {

        if (_stype == GEQ) {

          for (int i = 0; i != _node_num; ++i) {

            if (_pi[i] > max_pot) max_pot = _pi[i];

          }

          if (max_pot > 0) {

            for (int i = 0; i != _node_num; ++i)

              _pi[i] -= max_pot;

          }

        } else {

          Cost min_pot = std::numeric_limits<Cost>::max();

          for (int i = 0; i != _node_num; ++i) {

            if (_pi[i] < min_pot) min_pot = _pi[i];

          }

          if (min_pot < 0) {

            for (int i = 0; i != _node_num; ++i)

              _pi[i] -= min_pot;

          }

        }

      }

      return OPTIMAL;

    }

  }; //class NetworkSimplex

  ///@}

} //namespace lemon

#endif //LEMON_NETWORK_SIMPLEX_H