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
|
/**
*
* This file is part of Tulip (www.tulip-software.org)
*
* Authors: David Auber and the Tulip development Team
* from LaBRI, University of Bordeaux
*
* Tulip is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* Tulip is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
*/
#ifndef PATHALGORITHM_H_
#define PATHALGORITHM_H_
#include <tulip/Node.h>
#include <float.h>
namespace tlp {
class BooleanProperty;
class DoubleProperty;
class Graph;
/**
* @brief An facade for any path finding algorithm.
* This class will initiate and run the correct path finding algorithm relative to the parameters given.
*/
class PathAlgorithm {
public:
/**
* By default, Tulip works on oriented edges. This behavior can be overloaded by forcing the edges to be Oriented, non oriented or reversed.
*/
enum EdgeOrientation { Oriented, NonOriented, Reversed };
/**
* A path algorithm can look for only one (shortest) path, all the shortest paths or all the paths.
*/
enum PathType { OneShortest, AllShortest, AllPaths };
/**
* Compute a path between two nodes.
* @param pathType the type of path to look for.
* @param edgesOrientation The edge orientation policy.
* @param src The source node
* @param tgt The target node
* @param result Nodes and edges located in the path will be set to true in a resulting boolean property.
* @param weights The edges weights
* @param tolerance (only when all paths are selected) The length tolerance factor.
* @return
*
* @see PathType
* @see EdgeOrientation
* @see Dikjstra
* @see DFS
*/
static bool computePath(tlp::Graph *graph, PathType pathType, EdgeOrientation edgesOrientation, tlp::node src, tlp::node tgt, tlp::BooleanProperty *result, tlp::DoubleProperty *weights=0, double tolerance=DBL_MAX);
};
}
#endif /* PATHALGORITHM_H_ */
|
