File: kruskal.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 (137 lines) | stat: -rw-r--r-- 5,957 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
137
// ==========================================================================
//                 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 Kruskal's algorithm.
// ==========================================================================

#ifndef INCLUDE_SEQAN_GRAPH_ALGORITHMS_KRUSKAL_H_
#define INCLUDE_SEQAN_GRAPH_ALGORITHMS_KRUSKAL_H_

namespace seqan2 {

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

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

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

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

// ----------------------------------------------------------------------------
// Function kruskalsAlgorithm()
// ----------------------------------------------------------------------------

template <typename TWeight, typename TPair>
struct LessPairI1_ : public std::function<bool(Pair<TWeight, TPair>)>
{
    bool operator() (Pair<TWeight, TPair> const & a1,
                     Pair<TWeight, TPair> const & a2) const
    {
        return (a1.i1 < a2.i1);
    }
};

/*!
 * @fn kruskalsAlgorithm
 * @headerfile <seqan/graph_algorithms.h>
 * @brief Computes a minimum spanning tree on a graph.
 *
 * @signature void kruskalsAlgorithm(edges, g, source, weight);
 *
 * @param[out] edges A String of vertex descriptors that represent edges.  Each consecutive pair is an edge with the
 *                   two end points.
 * @param[in] g      An undirected graph. Types: Undirected Graph
 * @param[in] source A source vertex. Types: VertexDescriptor
 * @param[in] weight Edge weights.
 *
 * @section Example
 *
 * @include demos/dox/graph_algorithms/kruskals_algorithm.cpp
 *
 * @include demos/dox/graph_algorithms/kruskals_algorithm.cpp.stdout
 *
 * @see primsAlgorithm
 */
template <typename TSpec, typename TVertexDescriptor, typename TWeightMap, typename TEdges>
void kruskalsAlgorithm(TEdges & edges,
                       Graph<TSpec> const & g,
                       TVertexDescriptor const,
                       TWeightMap const & weight)
{
    typedef Graph<TSpec> TGraph;
    typedef typename Iterator<TGraph, EdgeIterator>::Type TEdgeIterator;
    typedef typename Value<TWeightMap>::Type TWeight;

    typedef Pair<TVertexDescriptor, TVertexDescriptor> TVertexPair;
    typedef Pair<TWeight, TVertexPair> TWeightEdgePair;
    typedef String<TWeightEdgePair>  TEdgeList;
    typedef typename Iterator<TEdgeList>::Type TEdgeListIter;
    TEdgeList edgeList;

    // Initialization
    reserve(edges, 2 * (numVertices(g) - 1));
    UnionFind<TVertexDescriptor> unionFind;
    resizeVertexMap(unionFind, g);

    // Sort the edges
    TEdgeIterator itE(g);
    for(;!atEnd(itE);goNext(itE)) appendValue(edgeList, TWeightEdgePair(getProperty(weight, getValue(itE)), TVertexPair(sourceVertex(itE),targetVertex(itE))));
    std::sort(begin(edgeList, Standard() ), end(edgeList, Standard() ), LessPairI1_<TWeight, TVertexPair>() );

    // Process each edge
    TEdgeListIter itEdgeList = begin(edgeList, Standard());
    TEdgeListIter itEdgeListEnd = end(edgeList, Standard());
    for (; itEdgeList != itEdgeListEnd; goNext(itEdgeList)) {
        TVertexDescriptor x = value(itEdgeList).i2.i1;
        TVertexDescriptor y = value(itEdgeList).i2.i2;

        if (findSet(unionFind, x) == findSet(unionFind, y))
            continue;

        appendValue(edges, x);
        appendValue(edges, y);
        joinSets(unionFind, findSet(unionFind, x), findSet(unionFind, y));
    }
}

}  // namespace seqan2

#endif  // #ifndef INCLUDE_SEQAN_GRAPH_ALGORITHMS_KRUSKAL_H_