4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Dekel Tsur (original code)
8 * \author Richard Heck (re-implementation)
10 * Full author contact details are available in file CREDITS.
25 /// Represents a directed graph, possibly with multiple edges
26 /// connecting the vertices.
29 Graph() : numedges_(0) {}
31 typedef std::vector<int> EdgePath;
32 /// \return a vector of the vertices from which "to" can be reached
33 EdgePath const getReachableTo(int to, bool clear_visited);
34 /// \return a vector of the vertices that can be reached from "from"
36 getReachable(int from, bool only_viewable, bool clear_visited);
37 /// can "from" be reached from "to"?
38 bool isReachable(int from, int to);
39 /// find a path from "from" to "to". always returns one of the
40 /// shortest such paths.
41 EdgePath const getPath(int from, int to);
42 /// called repeatedly to build the graph
43 void addEdge(int from, int to);
44 /// reset the internal data structures
49 bool bfs_init(int, bool clear_visited, std::queue<int> & Q);
50 /// used to recover a marked path
51 void getMarkedPath(int from, int to, EdgePath & path);
52 /// these represent the arrows connecting the nodes of the graph.
53 /// this is the basic representation of the graph: as a bunch of
57 Arrow(int f, int t, int i):
58 from(f), to(t), id(i) {}
59 /// the vertex at the tail of the arrow
61 /// the vertex at the head
63 /// an id for this arrow, e.g., for use in describing paths
67 /// a container for the arrows
68 /// we use a list because we want pointers to the arrows,
69 /// and a vector might invalidate them
70 typedef std::list<Arrow> Arrows;
72 /// Represents a vertex of the graph. Note that we could recover
73 /// the in_arrows and out_arrows from the Arrows, so these are in
74 /// effect a kind of cache.
76 /// arrows that point at this one
77 std::vector<Arrow *> in_arrows;
78 /// arrows out from here
79 std::vector<Arrow *> out_arrows;
80 /// used in the search routines
83 /// a container for the vertices
84 /// the index into the vector functions as the identifier by which
85 /// these are referenced in the Arrow struct
86 /// the code making use of the Graph must keep track of the relation
87 /// between these indices and the objects they represent. (in the case
88 /// of Format, this is easy, since the Format objects already have ints
90 std::vector<Vertex> vertices_;
92 /// a counter that we use to assign id's to the arrows
93 /// FIXME This technique assumes a correspondence between the
94 /// ids of the arrows and ids associated with Converters that
95 /// seems kind of fragile. Perhaps a better solution would be
96 /// to pass the ids as we create the arrows.