File: bellman_ford.h

package info (click to toggle)
seqan2 2.5.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 228,748 kB
  • sloc: cpp: 257,602; ansic: 91,967; python: 8,326; sh: 1,056; xml: 570; makefile: 229; awk: 51; javascript: 21
file content (136 lines) | stat: -rw-r--r-- 6,082 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2026, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of Knut Reinert or the FU Berlin nor the names of
//       its contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: Tobias Raussch <rausch@embl.de>
// ==========================================================================
// Implementation of Bellman-Ford algorithm.
// ==========================================================================

#ifndef INCLUDE_SEQAN_GRAPH_ALGORITHMS_BELLMAN_FORD_H_
#define INCLUDE_SEQAN_GRAPH_ALGORITHMS_BELLMAN_FORD_H_

namespace seqan2 {

// ============================================================================
// Forwards
// ============================================================================

// ============================================================================
// Tags, Classes, Enums
// ============================================================================

// ============================================================================
// Metafunctions
// ============================================================================

// ============================================================================
// Functions
// ============================================================================

// ----------------------------------------------------------------------------
// Function bellmanFordAlgorithm()
// ----------------------------------------------------------------------------

/*!
 * @fn bellmanFordAlgorithm
 *
 * @headerfile <seqan/graph_algorithms.h>
 *
 * @brief Computes shortest paths from a single source in a directed graph.
 *
 * @signature bool bellmanFordAlgorithm(g, source, weight, predecessor, distance)
 *
 * @param[out] predecessor A property map.  A property map that represents predecessor relationships among vertices.
 *                         It determines a shortest-paths tree.
 * @param[out] distance    A property map.Indicates for each vertex the distance from the source.
 * @param[in]  g           A directed graph. Types: Directed Graph
 * @param[in]  source      A source vertex. Types: VertexDescriptor
 * @param[in]  weight      A weight map.A property map with edge weights.  Edge weights may be negative.
 *
 * @return bool true if the graph has no negative weight cycles, false otherwise.
 *
 * Edge weights may be negative in the Bellman-Ford algorithm.  The out parameters are only valid if the algorithm
 * returns true.
 *
 * @section Example
 *
 * @include demos/dox/graph_algorithms/bellman_ford_algorithm.cpp
 *
 * @include demos/dox/graph_algorithms/bellman_ford_algorithm.cpp.stdout
 *
 * @see dagShortestPath
 * @see dijkstra
 */
template <typename TSpec, typename TVertexDescriptor, typename TWeightMap, typename TPredecessorMap, typename TDistanceMap>
bool bellmanFordAlgorithm(TPredecessorMap & predecessor,
                          TDistanceMap & distance,
                          Graph<TSpec> const & g,
                          TVertexDescriptor const source,
                          TWeightMap const & weight)
{
    typedef typename Size<Graph<TSpec> >::Type TSize;

    // Initialization
    typedef typename Iterator<Graph<TSpec>, VertexIterator>::Type TVertexIterator;
    typedef typename Iterator<Graph<TSpec>, OutEdgeIterator>::Type TOutEdgeIterator;
    resizeVertexMap(predecessor, g);
    resizeVertexMap(distance, g);
    _initializeSingleSource(predecessor, distance, g, source, weight);

    // Run Bellman-Ford
    for(TSize i=0; i<numVertices(g) - 1; ++i) {
        TVertexIterator it(g);
        for(;!atEnd(it);goNext(it)) {
            TVertexDescriptor u = getValue(it);
            TOutEdgeIterator itout(g, u);
            for(;!atEnd(itout);++itout) {
                _relax(g,weight,predecessor, distance, u, getValue(itout));
            }
        }
    }

    TVertexIterator it(g);
    for(;!atEnd(it);goNext(it)) {
        TVertexDescriptor u = getValue(it);
        TOutEdgeIterator itout(g, u);
        for(;!atEnd(itout);++itout) {
            TVertexDescriptor v = targetVertex(g, getValue(itout));
            if (getProperty(distance, v) > getProperty(distance,u) + getProperty(weight,getValue(itout))) {
                return false;
            }
        }
    }
    return true;
}

}  // namespace seqan2

#endif  // #ifndef INCLUDE_SEQAN_GRAPH_ALGORITHMS_BELLMAN_FORD_H_