RhodeCode

/* -*- C++ -*-

 *

 * This file is a part of LEMON, a generic C++ optimization library

 *

 * Copyright (C) 2003-2008

 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport

 * (Egervary Research Group on Combinatorial Optimization, EGRES).

 *

 * Permission to use, modify and distribute this software is granted

 * provided that this copyright notice appears in all copies. For

 * precise terms see the accompanying LICENSE file.

 *

 * This software is provided "AS IS" with no warranty of any kind,

 * express or implied, and with no claim as to its suitability for any

 * purpose.

 *

 */

#ifndef LEMON_BELLMAN_FORD_H

#define LEMON_BELLMAN_FORD_H

/// \ingroup shortest_path

/// \file

/// \brief Bellman-Ford algorithm.

#include <lemon/bits/path_dump.h>

#include <lemon/core.h>

#include <lemon/error.h>

#include <lemon/maps.h>

#include <lemon/path.h>

#include <limits>

namespace lemon {

  /// \brief Default OperationTraits for the BellmanFord algorithm class.

  ///  

  /// This operation traits class defines all computational operations

  /// and constants that are used in the Bellman-Ford algorithm.

  /// The default implementation is based on the \c numeric_limits class.

  /// If the numeric type does not have infinity value, then the maximum

  /// value is used as extremal infinity value.

  template <

    typename V, 

    bool has_inf = std::numeric_limits<V>::has_infinity>

  struct BellmanFordDefaultOperationTraits {

    /// \e

    typedef V Value;

    /// \brief Gives back the zero value of the type.

    static Value zero() {

      return static_cast<Value>(0);

    }

    /// \brief Gives back the positive infinity value of the type.

    static Value infinity() {

      return std::numeric_limits<Value>::infinity();

    }

    /// \brief Gives back the sum of the given two elements.

    /// Returns a const reference to the node map that stores the distances

    /// of the nodes calculated by the algorithm.

    ///

    /// \pre Either \ref run() or \ref init() must be called before

    /// using this function.

    const DistMap &distMap() const { return *_dist;}

    /// \brief Returns a const reference to the node map that stores the

    /// predecessor arcs.

    ///

    /// Returns a const reference to the node map that stores the predecessor

    /// arcs, which form the shortest path tree (forest).

    ///

    /// \pre Either \ref run() or \ref init() must be called before

    /// using this function.

    const PredMap &predMap() const { return *_pred; }

    /// \brief Checks if a node is reached from the root(s).

    ///

    /// Returns \c true if \c v is reached from the root(s).

    ///

    /// \pre Either \ref run() or \ref init() must be called before

    /// using this function.

    bool reached(Node v) const {

      return (*_dist)[v] != OperationTraits::infinity();

    }

    /// \brief Gives back a negative cycle.

    ///    

    /// This function gives back a directed cycle with negative total

    /// length if the algorithm has already found one.

    /// Otherwise it gives back an empty path.

      typename Digraph::template NodeMap<int> state(*_gr, -1);

      lemon::Path<Digraph> cycle;

      for (int i = 0; i < int(_process.size()); ++i) {

        if (state[_process[i]] != -1) continue;

        for (Node v = _process[i]; (*_pred)[v] != INVALID;

             v = _gr->source((*_pred)[v])) {

          if (state[v] == i) {

            cycle.addFront((*_pred)[v]);

            for (Node u = _gr->source((*_pred)[v]); u != v;

                 u = _gr->source((*_pred)[u])) {

              cycle.addFront((*_pred)[u]);

            }

            return cycle;

          }

          else if (state[v] >= 0) {

            break;

          }

          state[v] = i;

        }

      }

      return cycle;

    }

    ///@}

  };

  /// \brief Default traits class of bellmanFord() function.

  ///

  /// Default traits class of bellmanFord() function.

  /// \tparam GR The type of the digraph.

  /// \tparam LEN The type of the length map.

  template <typename GR, typename LEN>

  Value l;

  int k;

  bool b;

  BF::DistMap d(gr);

  BF::PredMap p(gr);

  LengthMap length;

  concepts::Path<Digraph> pp;

  {

    BF bf_test(gr,length);

    const BF& const_bf_test = bf_test;

    bf_test.run(s);

    bf_test.run(s,k);

    bf_test.init();

    bf_test.addSource(s);

    bf_test.addSource(s, 1);

    b = bf_test.processNextRound();

    b = bf_test.processNextWeakRound();

    bf_test.start();

    bf_test.checkedStart();

    bf_test.limitedStart(k);

    l  = const_bf_test.dist(t);

    e  = const_bf_test.predArc(t);

    s  = const_bf_test.predNode(t);

    b  = const_bf_test.reached(t);

    d  = const_bf_test.distMap();

    p  = const_bf_test.predMap();

    pp = const_bf_test.path(t);

    for (BF::ActiveIt it(const_bf_test); it != INVALID; ++it) {}

  }

  {

    BF::SetPredMap<concepts::ReadWriteMap<Node,Arc> >

      ::SetDistMap<concepts::ReadWriteMap<Node,Value> >

      ::SetOperationTraits<BellmanFordDefaultOperationTraits<Value> >

      ::Create bf_test(gr,length);

    LengthMap length_map;

    concepts::ReadWriteMap<Node,Arc> pred_map;

    concepts::ReadWriteMap<Node,Value> dist_map;

    bf_test

      .lengthMap(length_map)

      .predMap(pred_map)

      .distMap(dist_map);

    bf_test.run(s);

    bf_test.run(s,k);

    bf_test.init();

    bf_test.addSource(s);

    bf_test.addSource(s, 1);

    b = bf_test.processNextRound();

    b = bf_test.processNextWeakRound();

    bf_test.start();

    bf_test.checkedStart();

    bf_test.limitedStart(k);

    l  = bf_test.dist(t);

    e  = bf_test.predArc(t);

    s  = bf_test.predNode(t);

    b  = bf_test.reached(t);

    pp = bf_test.path(t);

  }

}

void checkBellmanFordFunctionCompile()

{

  typedef int Value;

  typedef concepts::Digraph Digraph;

  typedef Digraph::Arc Arc;

  typedef Digraph::Node Node;

  typedef concepts::ReadMap<Digraph::Arc,Value> LengthMap;

  Digraph g;

  bool b;

  bellmanFord(g,LengthMap()).run(Node());

  b = bellmanFord(g,LengthMap()).run(Node(),Node());

  bellmanFord(g,LengthMap())

    .predMap(concepts::ReadWriteMap<Node,Arc>())

    .distMap(concepts::ReadWriteMap<Node,Value>())

    .run(Node());

  b=bellmanFord(g,LengthMap())

    .predMap(concepts::ReadWriteMap<Node,Arc>())

    .distMap(concepts::ReadWriteMap<Node,Value>())

    .path(concepts::Path<Digraph>())

    .dist(Value())

    .run(Node(),Node());

}

template <typename Digraph, typename Value>

void checkBellmanFord() {

  TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);

  typedef typename Digraph::template ArcMap<Value> LengthMap;