... |
... |
@@ -4,151 +4,161 @@
|
4 |
4 |
*
|
5 |
5 |
* Copyright (C) 2003-2009
|
6 |
6 |
* Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
|
7 |
7 |
* (Egervary Research Group on Combinatorial Optimization, EGRES).
|
8 |
8 |
*
|
9 |
9 |
* Permission to use, modify and distribute this software is granted
|
10 |
10 |
* provided that this copyright notice appears in all copies. For
|
11 |
11 |
* precise terms see the accompanying LICENSE file.
|
12 |
12 |
*
|
13 |
13 |
* This software is provided "AS IS" with no warranty of any kind,
|
14 |
14 |
* express or implied, and with no claim as to its suitability for any
|
15 |
15 |
* purpose.
|
16 |
16 |
*
|
17 |
17 |
*/
|
18 |
18 |
|
19 |
19 |
#ifndef LEMON_SUURBALLE_H
|
20 |
20 |
#define LEMON_SUURBALLE_H
|
21 |
21 |
|
22 |
22 |
///\ingroup shortest_path
|
23 |
23 |
///\file
|
24 |
24 |
///\brief An algorithm for finding arc-disjoint paths between two
|
25 |
25 |
/// nodes having minimum total length.
|
26 |
26 |
|
27 |
27 |
#include <vector>
|
|
28 |
#include <limits>
|
28 |
29 |
#include <lemon/bin_heap.h>
|
29 |
30 |
#include <lemon/path.h>
|
30 |
31 |
#include <lemon/list_graph.h>
|
31 |
32 |
#include <lemon/maps.h>
|
32 |
33 |
|
33 |
34 |
namespace lemon {
|
34 |
35 |
|
35 |
36 |
/// \addtogroup shortest_path
|
36 |
37 |
/// @{
|
37 |
38 |
|
38 |
39 |
/// \brief Algorithm for finding arc-disjoint paths between two nodes
|
39 |
40 |
/// having minimum total length.
|
40 |
41 |
///
|
41 |
42 |
/// \ref lemon::Suurballe "Suurballe" implements an algorithm for
|
42 |
43 |
/// finding arc-disjoint paths having minimum total length (cost)
|
43 |
44 |
/// from a given source node to a given target node in a digraph.
|
44 |
45 |
///
|
45 |
|
/// In fact, this implementation is the specialization of the
|
46 |
|
/// \ref CapacityScaling "successive shortest path" algorithm.
|
|
46 |
/// Note that this problem is a special case of the \ref min_cost_flow
|
|
47 |
/// "minimum cost flow problem". This implementation is actually an
|
|
48 |
/// efficient specialized version of the \ref CapacityScaling
|
|
49 |
/// "Successive Shortest Path" algorithm directly for this problem.
|
|
50 |
/// Therefore this class provides query functions for flow values and
|
|
51 |
/// node potentials (the dual solution) just like the minimum cost flow
|
|
52 |
/// algorithms.
|
47 |
53 |
///
|
48 |
54 |
/// \tparam GR The digraph type the algorithm runs on.
|
49 |
|
/// The default value is \c ListDigraph.
|
50 |
|
/// \tparam LEN The type of the length (cost) map.
|
51 |
|
/// The default value is <tt>Digraph::ArcMap<int></tt>.
|
|
55 |
/// \tparam LEN The type of the length map.
|
|
56 |
/// The default value is <tt>GR::ArcMap<int></tt>.
|
52 |
57 |
///
|
53 |
58 |
/// \warning Length values should be \e non-negative \e integers.
|
54 |
59 |
///
|
55 |
60 |
/// \note For finding node-disjoint paths this algorithm can be used
|
56 |
|
/// with \ref SplitNodes.
|
|
61 |
/// along with the \ref SplitNodes adaptor.
|
57 |
62 |
#ifdef DOXYGEN
|
58 |
63 |
template <typename GR, typename LEN>
|
59 |
64 |
#else
|
60 |
|
template < typename GR = ListDigraph,
|
|
65 |
template < typename GR,
|
61 |
66 |
typename LEN = typename GR::template ArcMap<int> >
|
62 |
67 |
#endif
|
63 |
68 |
class Suurballe
|
64 |
69 |
{
|
65 |
70 |
TEMPLATE_DIGRAPH_TYPEDEFS(GR);
|
66 |
71 |
|
67 |
72 |
typedef ConstMap<Arc, int> ConstArcMap;
|
68 |
73 |
typedef typename GR::template NodeMap<Arc> PredMap;
|
69 |
74 |
|
70 |
75 |
public:
|
71 |
76 |
|
72 |
77 |
/// The type of the digraph the algorithm runs on.
|
73 |
78 |
typedef GR Digraph;
|
74 |
79 |
/// The type of the length map.
|
75 |
80 |
typedef LEN LengthMap;
|
76 |
81 |
/// The type of the lengths.
|
77 |
82 |
typedef typename LengthMap::Value Length;
|
|
83 |
#ifdef DOXYGEN
|
|
84 |
/// The type of the flow map.
|
|
85 |
typedef GR::ArcMap<int> FlowMap;
|
|
86 |
/// The type of the potential map.
|
|
87 |
typedef GR::NodeMap<Length> PotentialMap;
|
|
88 |
#else
|
78 |
89 |
/// The type of the flow map.
|
79 |
90 |
typedef typename Digraph::template ArcMap<int> FlowMap;
|
80 |
91 |
/// The type of the potential map.
|
81 |
92 |
typedef typename Digraph::template NodeMap<Length> PotentialMap;
|
|
93 |
#endif
|
|
94 |
|
82 |
95 |
/// The type of the path structures.
|
83 |
|
typedef SimplePath<Digraph> Path;
|
|
96 |
typedef SimplePath<GR> Path;
|
84 |
97 |
|
85 |
98 |
private:
|
86 |
99 |
|
87 |
|
/// \brief Special implementation of the Dijkstra algorithm
|
88 |
|
/// for finding shortest paths in the residual network.
|
89 |
|
///
|
90 |
|
/// \ref ResidualDijkstra is a special implementation of the
|
91 |
|
/// \ref Dijkstra algorithm for finding shortest paths in the
|
92 |
|
/// residual network of the digraph with respect to the reduced arc
|
93 |
|
/// lengths and modifying the node potentials according to the
|
94 |
|
/// distance of the nodes.
|
|
100 |
// ResidualDijkstra is a special implementation of the
|
|
101 |
// Dijkstra algorithm for finding shortest paths in the
|
|
102 |
// residual network with respect to the reduced arc lengths
|
|
103 |
// and modifying the node potentials according to the
|
|
104 |
// distance of the nodes.
|
95 |
105 |
class ResidualDijkstra
|
96 |
106 |
{
|
97 |
107 |
typedef typename Digraph::template NodeMap<int> HeapCrossRef;
|
98 |
108 |
typedef BinHeap<Length, HeapCrossRef> Heap;
|
99 |
109 |
|
100 |
110 |
private:
|
101 |
111 |
|
102 |
112 |
// The digraph the algorithm runs on
|
103 |
113 |
const Digraph &_graph;
|
104 |
114 |
|
105 |
115 |
// The main maps
|
106 |
116 |
const FlowMap &_flow;
|
107 |
117 |
const LengthMap &_length;
|
108 |
118 |
PotentialMap &_potential;
|
109 |
119 |
|
110 |
120 |
// The distance map
|
111 |
121 |
PotentialMap _dist;
|
112 |
122 |
// The pred arc map
|
113 |
123 |
PredMap &_pred;
|
114 |
124 |
// The processed (i.e. permanently labeled) nodes
|
115 |
125 |
std::vector<Node> _proc_nodes;
|
116 |
126 |
|
117 |
127 |
Node _s;
|
118 |
128 |
Node _t;
|
119 |
129 |
|
120 |
130 |
public:
|
121 |
131 |
|
122 |
132 |
/// Constructor.
|
123 |
|
ResidualDijkstra( const Digraph &digraph,
|
|
133 |
ResidualDijkstra( const Digraph &graph,
|
124 |
134 |
const FlowMap &flow,
|
125 |
135 |
const LengthMap &length,
|
126 |
136 |
PotentialMap &potential,
|
127 |
137 |
PredMap &pred,
|
128 |
138 |
Node s, Node t ) :
|
129 |
|
_graph(digraph), _flow(flow), _length(length), _potential(potential),
|
130 |
|
_dist(digraph), _pred(pred), _s(s), _t(t) {}
|
|
139 |
_graph(graph), _flow(flow), _length(length), _potential(potential),
|
|
140 |
_dist(graph), _pred(pred), _s(s), _t(t) {}
|
131 |
141 |
|
132 |
142 |
/// \brief Run the algorithm. It returns \c true if a path is found
|
133 |
143 |
/// from the source node to the target node.
|
134 |
144 |
bool run() {
|
135 |
145 |
HeapCrossRef heap_cross_ref(_graph, Heap::PRE_HEAP);
|
136 |
146 |
Heap heap(heap_cross_ref);
|
137 |
147 |
heap.push(_s, 0);
|
138 |
148 |
_pred[_s] = INVALID;
|
139 |
149 |
_proc_nodes.clear();
|
140 |
150 |
|
141 |
151 |
// Process nodes
|
142 |
152 |
while (!heap.empty() && heap.top() != _t) {
|
143 |
153 |
Node u = heap.top(), v;
|
144 |
154 |
Length d = heap.prio() + _potential[u], nd;
|
145 |
155 |
_dist[u] = heap.prio();
|
146 |
156 |
heap.pop();
|
147 |
157 |
_proc_nodes.push_back(u);
|
148 |
158 |
|
149 |
159 |
// Traverse outgoing arcs
|
150 |
160 |
for (OutArcIt e(_graph, u); e != INVALID; ++e) {
|
151 |
161 |
if (_flow[e] == 0) {
|
152 |
162 |
v = _graph.target(e);
|
153 |
163 |
switch(heap.state(v)) {
|
154 |
164 |
case Heap::PRE_HEAP:
|
... |
... |
@@ -215,294 +225,311 @@
|
215 |
225 |
PotentialMap *_potential;
|
216 |
226 |
bool _local_potential;
|
217 |
227 |
|
218 |
228 |
// The source node
|
219 |
229 |
Node _source;
|
220 |
230 |
// The target node
|
221 |
231 |
Node _target;
|
222 |
232 |
|
223 |
233 |
// Container to store the found paths
|
224 |
234 |
std::vector< SimplePath<Digraph> > paths;
|
225 |
235 |
int _path_num;
|
226 |
236 |
|
227 |
237 |
// The pred arc map
|
228 |
238 |
PredMap _pred;
|
229 |
239 |
// Implementation of the Dijkstra algorithm for finding augmenting
|
230 |
240 |
// shortest paths in the residual network
|
231 |
241 |
ResidualDijkstra *_dijkstra;
|
232 |
242 |
|
233 |
243 |
public:
|
234 |
244 |
|
235 |
245 |
/// \brief Constructor.
|
236 |
246 |
///
|
237 |
247 |
/// Constructor.
|
238 |
248 |
///
|
239 |
|
/// \param digraph The digraph the algorithm runs on.
|
|
249 |
/// \param graph The digraph the algorithm runs on.
|
240 |
250 |
/// \param length The length (cost) values of the arcs.
|
241 |
|
/// \param s The source node.
|
242 |
|
/// \param t The target node.
|
243 |
|
Suurballe( const Digraph &digraph,
|
244 |
|
const LengthMap &length,
|
245 |
|
Node s, Node t ) :
|
246 |
|
_graph(digraph), _length(length), _flow(0), _local_flow(false),
|
247 |
|
_potential(0), _local_potential(false), _source(s), _target(t),
|
248 |
|
_pred(digraph) {}
|
|
251 |
Suurballe( const Digraph &graph,
|
|
252 |
const LengthMap &length ) :
|
|
253 |
_graph(graph), _length(length), _flow(0), _local_flow(false),
|
|
254 |
_potential(0), _local_potential(false), _pred(graph)
|
|
255 |
{
|
|
256 |
LEMON_ASSERT(std::numeric_limits<Length>::is_integer,
|
|
257 |
"The length type of Suurballe must be integer");
|
|
258 |
}
|
249 |
259 |
|
250 |
260 |
/// Destructor.
|
251 |
261 |
~Suurballe() {
|
252 |
262 |
if (_local_flow) delete _flow;
|
253 |
263 |
if (_local_potential) delete _potential;
|
254 |
264 |
delete _dijkstra;
|
255 |
265 |
}
|
256 |
266 |
|
257 |
267 |
/// \brief Set the flow map.
|
258 |
268 |
///
|
259 |
269 |
/// This function sets the flow map.
|
|
270 |
/// If it is not used before calling \ref run() or \ref init(),
|
|
271 |
/// an instance will be allocated automatically. The destructor
|
|
272 |
/// deallocates this automatically allocated map, of course.
|
260 |
273 |
///
|
261 |
|
/// The found flow contains only 0 and 1 values. It is the union of
|
262 |
|
/// the found arc-disjoint paths.
|
|
274 |
/// The found flow contains only 0 and 1 values, since it is the
|
|
275 |
/// union of the found arc-disjoint paths.
|
263 |
276 |
///
|
264 |
277 |
/// \return <tt>(*this)</tt>
|
265 |
278 |
Suurballe& flowMap(FlowMap &map) {
|
266 |
279 |
if (_local_flow) {
|
267 |
280 |
delete _flow;
|
268 |
281 |
_local_flow = false;
|
269 |
282 |
}
|
270 |
283 |
_flow = ↦
|
271 |
284 |
return *this;
|
272 |
285 |
}
|
273 |
286 |
|
274 |
287 |
/// \brief Set the potential map.
|
275 |
288 |
///
|
276 |
289 |
/// This function sets the potential map.
|
|
290 |
/// If it is not used before calling \ref run() or \ref init(),
|
|
291 |
/// an instance will be allocated automatically. The destructor
|
|
292 |
/// deallocates this automatically allocated map, of course.
|
277 |
293 |
///
|
278 |
|
/// The potentials provide the dual solution of the underlying
|
279 |
|
/// minimum cost flow problem.
|
|
294 |
/// The node potentials provide the dual solution of the underlying
|
|
295 |
/// \ref min_cost_flow "minimum cost flow problem".
|
280 |
296 |
///
|
281 |
297 |
/// \return <tt>(*this)</tt>
|
282 |
298 |
Suurballe& potentialMap(PotentialMap &map) {
|
283 |
299 |
if (_local_potential) {
|
284 |
300 |
delete _potential;
|
285 |
301 |
_local_potential = false;
|
286 |
302 |
}
|
287 |
303 |
_potential = ↦
|
288 |
304 |
return *this;
|
289 |
305 |
}
|
290 |
306 |
|
291 |
307 |
/// \name Execution Control
|
292 |
308 |
/// The simplest way to execute the algorithm is to call the run()
|
293 |
309 |
/// function.
|
294 |
310 |
/// \n
|
295 |
311 |
/// If you only need the flow that is the union of the found
|
296 |
312 |
/// arc-disjoint paths, you may call init() and findFlow().
|
297 |
313 |
|
298 |
314 |
/// @{
|
299 |
315 |
|
300 |
316 |
/// \brief Run the algorithm.
|
301 |
317 |
///
|
302 |
318 |
/// This function runs the algorithm.
|
303 |
319 |
///
|
|
320 |
/// \param s The source node.
|
|
321 |
/// \param t The target node.
|
304 |
322 |
/// \param k The number of paths to be found.
|
305 |
323 |
///
|
306 |
324 |
/// \return \c k if there are at least \c k arc-disjoint paths from
|
307 |
325 |
/// \c s to \c t in the digraph. Otherwise it returns the number of
|
308 |
326 |
/// arc-disjoint paths found.
|
309 |
327 |
///
|
310 |
|
/// \note Apart from the return value, <tt>s.run(k)</tt> is just a
|
311 |
|
/// shortcut of the following code.
|
|
328 |
/// \note Apart from the return value, <tt>s.run(s, t, k)</tt> is
|
|
329 |
/// just a shortcut of the following code.
|
312 |
330 |
/// \code
|
313 |
|
/// s.init();
|
314 |
|
/// s.findFlow(k);
|
|
331 |
/// s.init(s);
|
|
332 |
/// s.findFlow(t, k);
|
315 |
333 |
/// s.findPaths();
|
316 |
334 |
/// \endcode
|
317 |
|
int run(int k = 2) {
|
318 |
|
init();
|
319 |
|
findFlow(k);
|
|
335 |
int run(const Node& s, const Node& t, int k = 2) {
|
|
336 |
init(s);
|
|
337 |
findFlow(t, k);
|
320 |
338 |
findPaths();
|
321 |
339 |
return _path_num;
|
322 |
340 |
}
|
323 |
341 |
|
324 |
342 |
/// \brief Initialize the algorithm.
|
325 |
343 |
///
|
326 |
344 |
/// This function initializes the algorithm.
|
327 |
|
void init() {
|
|
345 |
///
|
|
346 |
/// \param s The source node.
|
|
347 |
void init(const Node& s) {
|
|
348 |
_source = s;
|
|
349 |
|
328 |
350 |
// Initialize maps
|
329 |
351 |
if (!_flow) {
|
330 |
352 |
_flow = new FlowMap(_graph);
|
331 |
353 |
_local_flow = true;
|
332 |
354 |
}
|
333 |
355 |
if (!_potential) {
|
334 |
356 |
_potential = new PotentialMap(_graph);
|
335 |
357 |
_local_potential = true;
|
336 |
358 |
}
|
337 |
359 |
for (ArcIt e(_graph); e != INVALID; ++e) (*_flow)[e] = 0;
|
338 |
360 |
for (NodeIt n(_graph); n != INVALID; ++n) (*_potential)[n] = 0;
|
339 |
|
|
340 |
|
_dijkstra = new ResidualDijkstra( _graph, *_flow, _length,
|
341 |
|
*_potential, _pred,
|
342 |
|
_source, _target );
|
343 |
361 |
}
|
344 |
362 |
|
345 |
|
/// \brief Execute the successive shortest path algorithm to find
|
346 |
|
/// an optimal flow.
|
|
363 |
/// \brief Execute the algorithm to find an optimal flow.
|
347 |
364 |
///
|
348 |
365 |
/// This function executes the successive shortest path algorithm to
|
349 |
|
/// find a minimum cost flow, which is the union of \c k or less
|
|
366 |
/// find a minimum cost flow, which is the union of \c k (or less)
|
350 |
367 |
/// arc-disjoint paths.
|
351 |
368 |
///
|
|
369 |
/// \param t The target node.
|
|
370 |
/// \param k The number of paths to be found.
|
|
371 |
///
|
352 |
372 |
/// \return \c k if there are at least \c k arc-disjoint paths from
|
353 |
|
/// \c s to \c t in the digraph. Otherwise it returns the number of
|
354 |
|
/// arc-disjoint paths found.
|
|
373 |
/// the source node to the given node \c t in the digraph.
|
|
374 |
/// Otherwise it returns the number of arc-disjoint paths found.
|
355 |
375 |
///
|
356 |
376 |
/// \pre \ref init() must be called before using this function.
|
357 |
|
int findFlow(int k = 2) {
|
|
377 |
int findFlow(const Node& t, int k = 2) {
|
|
378 |
_target = t;
|
|
379 |
_dijkstra =
|
|
380 |
new ResidualDijkstra( _graph, *_flow, _length, *_potential, _pred,
|
|
381 |
_source, _target );
|
|
382 |
|
358 |
383 |
// Find shortest paths
|
359 |
384 |
_path_num = 0;
|
360 |
385 |
while (_path_num < k) {
|
361 |
386 |
// Run Dijkstra
|
362 |
387 |
if (!_dijkstra->run()) break;
|
363 |
388 |
++_path_num;
|
364 |
389 |
|
365 |
390 |
// Set the flow along the found shortest path
|
366 |
391 |
Node u = _target;
|
367 |
392 |
Arc e;
|
368 |
393 |
while ((e = _pred[u]) != INVALID) {
|
369 |
394 |
if (u == _graph.target(e)) {
|
370 |
395 |
(*_flow)[e] = 1;
|
371 |
396 |
u = _graph.source(e);
|
372 |
397 |
} else {
|
373 |
398 |
(*_flow)[e] = 0;
|
374 |
399 |
u = _graph.target(e);
|
375 |
400 |
}
|
376 |
401 |
}
|
377 |
402 |
}
|
378 |
403 |
return _path_num;
|
379 |
404 |
}
|
380 |
405 |
|
381 |
406 |
/// \brief Compute the paths from the flow.
|
382 |
407 |
///
|
383 |
|
/// This function computes the paths from the flow.
|
|
408 |
/// This function computes the paths from the found minimum cost flow,
|
|
409 |
/// which is the union of some arc-disjoint paths.
|
384 |
410 |
///
|
385 |
411 |
/// \pre \ref init() and \ref findFlow() must be called before using
|
386 |
412 |
/// this function.
|
387 |
413 |
void findPaths() {
|
388 |
|
// Create the residual flow map (the union of the paths not found
|
389 |
|
// so far)
|
390 |
414 |
FlowMap res_flow(_graph);
|
391 |
415 |
for(ArcIt a(_graph); a != INVALID; ++a) res_flow[a] = (*_flow)[a];
|
392 |
416 |
|
393 |
417 |
paths.clear();
|
394 |
418 |
paths.resize(_path_num);
|
395 |
419 |
for (int i = 0; i < _path_num; ++i) {
|
396 |
420 |
Node n = _source;
|
397 |
421 |
while (n != _target) {
|
398 |
422 |
OutArcIt e(_graph, n);
|
399 |
423 |
for ( ; res_flow[e] == 0; ++e) ;
|
400 |
424 |
n = _graph.target(e);
|
401 |
425 |
paths[i].addBack(e);
|
402 |
426 |
res_flow[e] = 0;
|
403 |
427 |
}
|
404 |
428 |
}
|
405 |
429 |
}
|
406 |
430 |
|
407 |
431 |
/// @}
|
408 |
432 |
|
409 |
433 |
/// \name Query Functions
|
410 |
434 |
/// The results of the algorithm can be obtained using these
|
411 |
435 |
/// functions.
|
412 |
436 |
/// \n The algorithm should be executed before using them.
|
413 |
437 |
|
414 |
438 |
/// @{
|
415 |
439 |
|
416 |
|
/// \brief Return a const reference to the arc map storing the
|
|
440 |
/// \brief Return the total length of the found paths.
|
|
441 |
///
|
|
442 |
/// This function returns the total length of the found paths, i.e.
|
|
443 |
/// the total cost of the found flow.
|
|
444 |
/// The complexity of the function is O(e).
|
|
445 |
///
|
|
446 |
/// \pre \ref run() or \ref findFlow() must be called before using
|
|
447 |
/// this function.
|
|
448 |
Length totalLength() const {
|
|
449 |
Length c = 0;
|
|
450 |
for (ArcIt e(_graph); e != INVALID; ++e)
|
|
451 |
c += (*_flow)[e] * _length[e];
|
|
452 |
return c;
|
|
453 |
}
|
|
454 |
|
|
455 |
/// \brief Return the flow value on the given arc.
|
|
456 |
///
|
|
457 |
/// This function returns the flow value on the given arc.
|
|
458 |
/// It is \c 1 if the arc is involved in one of the found arc-disjoint
|
|
459 |
/// paths, otherwise it is \c 0.
|
|
460 |
///
|
|
461 |
/// \pre \ref run() or \ref findFlow() must be called before using
|
|
462 |
/// this function.
|
|
463 |
int flow(const Arc& arc) const {
|
|
464 |
return (*_flow)[arc];
|
|
465 |
}
|
|
466 |
|
|
467 |
/// \brief Return a const reference to an arc map storing the
|
417 |
468 |
/// found flow.
|
418 |
469 |
///
|
419 |
|
/// This function returns a const reference to the arc map storing
|
|
470 |
/// This function returns a const reference to an arc map storing
|
420 |
471 |
/// the flow that is the union of the found arc-disjoint paths.
|
421 |
472 |
///
|
422 |
473 |
/// \pre \ref run() or \ref findFlow() must be called before using
|
423 |
474 |
/// this function.
|
424 |
475 |
const FlowMap& flowMap() const {
|
425 |
476 |
return *_flow;
|
426 |
477 |
}
|
427 |
478 |
|
428 |
|
/// \brief Return a const reference to the node map storing the
|
429 |
|
/// found potentials (the dual solution).
|
430 |
|
///
|
431 |
|
/// This function returns a const reference to the node map storing
|
432 |
|
/// the found potentials that provide the dual solution of the
|
433 |
|
/// underlying minimum cost flow problem.
|
434 |
|
///
|
435 |
|
/// \pre \ref run() or \ref findFlow() must be called before using
|
436 |
|
/// this function.
|
437 |
|
const PotentialMap& potentialMap() const {
|
438 |
|
return *_potential;
|
439 |
|
}
|
440 |
|
|
441 |
|
/// \brief Return the flow on the given arc.
|
442 |
|
///
|
443 |
|
/// This function returns the flow on the given arc.
|
444 |
|
/// It is \c 1 if the arc is involved in one of the found paths,
|
445 |
|
/// otherwise it is \c 0.
|
446 |
|
///
|
447 |
|
/// \pre \ref run() or \ref findFlow() must be called before using
|
448 |
|
/// this function.
|
449 |
|
int flow(const Arc& arc) const {
|
450 |
|
return (*_flow)[arc];
|
451 |
|
}
|
452 |
|
|
453 |
479 |
/// \brief Return the potential of the given node.
|
454 |
480 |
///
|
455 |
481 |
/// This function returns the potential of the given node.
|
|
482 |
/// The node potentials provide the dual solution of the
|
|
483 |
/// underlying \ref min_cost_flow "minimum cost flow problem".
|
456 |
484 |
///
|
457 |
485 |
/// \pre \ref run() or \ref findFlow() must be called before using
|
458 |
486 |
/// this function.
|
459 |
487 |
Length potential(const Node& node) const {
|
460 |
488 |
return (*_potential)[node];
|
461 |
489 |
}
|
462 |
490 |
|
463 |
|
/// \brief Return the total length (cost) of the found paths (flow).
|
|
491 |
/// \brief Return a const reference to a node map storing the
|
|
492 |
/// found potentials (the dual solution).
|
464 |
493 |
///
|
465 |
|
/// This function returns the total length (cost) of the found paths
|
466 |
|
/// (flow). The complexity of the function is O(e).
|
|
494 |
/// This function returns a const reference to a node map storing
|
|
495 |
/// the found potentials that provide the dual solution of the
|
|
496 |
/// underlying \ref min_cost_flow "minimum cost flow problem".
|
467 |
497 |
///
|
468 |
498 |
/// \pre \ref run() or \ref findFlow() must be called before using
|
469 |
499 |
/// this function.
|
470 |
|
Length totalLength() const {
|
471 |
|
Length c = 0;
|
472 |
|
for (ArcIt e(_graph); e != INVALID; ++e)
|
473 |
|
c += (*_flow)[e] * _length[e];
|
474 |
|
return c;
|
|
500 |
const PotentialMap& potentialMap() const {
|
|
501 |
return *_potential;
|
475 |
502 |
}
|
476 |
503 |
|
477 |
504 |
/// \brief Return the number of the found paths.
|
478 |
505 |
///
|
479 |
506 |
/// This function returns the number of the found paths.
|
480 |
507 |
///
|
481 |
508 |
/// \pre \ref run() or \ref findFlow() must be called before using
|
482 |
509 |
/// this function.
|
483 |
510 |
int pathNum() const {
|
484 |
511 |
return _path_num;
|
485 |
512 |
}
|
486 |
513 |
|
487 |
514 |
/// \brief Return a const reference to the specified path.
|
488 |
515 |
///
|
489 |
516 |
/// This function returns a const reference to the specified path.
|
490 |
517 |
///
|
491 |
|
/// \param i The function returns the \c i-th path.
|
|
518 |
/// \param i The function returns the <tt>i</tt>-th path.
|
492 |
519 |
/// \c i must be between \c 0 and <tt>%pathNum()-1</tt>.
|
493 |
520 |
///
|
494 |
521 |
/// \pre \ref run() or \ref findPaths() must be called before using
|
495 |
522 |
/// this function.
|
496 |
523 |
Path path(int i) const {
|
497 |
524 |
return paths[i];
|
498 |
525 |
}
|
499 |
526 |
|
500 |
527 |
/// @}
|
501 |
528 |
|
502 |
529 |
}; //class Suurballe
|
503 |
530 |
|
504 |
531 |
///@}
|
505 |
532 |
|
506 |
533 |
} //namespace lemon
|
507 |
534 |
|
508 |
535 |
#endif //LEMON_SUURBALLE_H
|