annotate gcc/shortest-paths.h @ 145:1830386684a0

gcc-9.2.0
author anatofuz
date Thu, 13 Feb 2020 11:34:05 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
145
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
1 /* Template class for Dijkstra's algorithm on directed graphs.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
2 Copyright (C) 2019-2020 Free Software Foundation, Inc.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
3 Contributed by David Malcolm <dmalcolm@redhat.com>.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
4
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
5 This file is part of GCC.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
6
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
7 GCC is free software; you can redistribute it and/or modify it
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
8 under the terms of the GNU General Public License as published by
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
9 the Free Software Foundation; either version 3, or (at your option)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
10 any later version.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
11
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
12 GCC is distributed in the hope that it will be useful, but
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
13 WITHOUT ANY WARRANTY; without even the implied warranty of
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
15 General Public License for more details.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
16
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
18 along with GCC; see the file COPYING3. If not see
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
19 <http://www.gnu.org/licenses/>. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
20
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
21 #ifndef GCC_SHORTEST_PATHS_H
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
22 #define GCC_SHORTEST_PATHS_H
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
23
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
24 #include "timevar.h"
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
25
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
26 /* A record of the shortest path to each node in an graph
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
27 from the origin node.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
28 The constructor runs Dijkstra's algorithm, and the results are
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
29 stored in this class. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
30
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
31 template <typename GraphTraits, typename Path_t>
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
32 class shortest_paths
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
33 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
34 public:
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
35 typedef typename GraphTraits::graph_t graph_t;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
36 typedef typename GraphTraits::node_t node_t;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
37 typedef typename GraphTraits::edge_t edge_t;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
38 typedef Path_t path_t;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
39
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
40 shortest_paths (const graph_t &graph, const node_t *origin);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
41
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
42 path_t get_shortest_path (const node_t *to) const;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
43
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
44 private:
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
45 const graph_t &m_graph;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
46
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
47 /* For each node (by index), the minimal distance to that node from the
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
48 origin. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
49 auto_vec<int> m_dist;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
50
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
51 /* For each exploded_node (by index), the previous edge in the shortest
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
52 path from the origin. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
53 auto_vec<const edge_t *> m_prev;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
54 };
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
55
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
56 /* shortest_paths's constructor.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
57
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
58 Use Dijkstra's algorithm relative to ORIGIN to populate m_dist and
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
59 m_prev with enough information to be able to generate Path_t instances
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
60 to give the shortest path to any node in GRAPH from ORIGIN. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
61
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
62 template <typename GraphTraits, typename Path_t>
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
63 inline
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
64 shortest_paths<GraphTraits, Path_t>::shortest_paths (const graph_t &graph,
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
65 const node_t *origin)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
66 : m_graph (graph),
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
67 m_dist (graph.m_nodes.length ()),
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
68 m_prev (graph.m_nodes.length ())
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
69 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
70 auto_timevar tv (TV_ANALYZER_SHORTEST_PATHS);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
71
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
72 auto_vec<int> queue (graph.m_nodes.length ());
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
73
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
74 for (unsigned i = 0; i < graph.m_nodes.length (); i++)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
75 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
76 m_dist.quick_push (INT_MAX);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
77 m_prev.quick_push (NULL);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
78 queue.quick_push (i);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
79 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
80 m_dist[origin->m_index] = 0;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
81
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
82 while (queue.length () > 0)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
83 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
84 /* Get minimal distance in queue.
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
85 FIXME: this is O(N^2); replace with a priority queue. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
86 int idx_with_min_dist = -1;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
87 int idx_in_queue_with_min_dist = -1;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
88 int min_dist = INT_MAX;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
89 for (unsigned i = 0; i < queue.length (); i++)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
90 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
91 int idx = queue[i];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
92 if (m_dist[queue[i]] < min_dist)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
93 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
94 min_dist = m_dist[idx];
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
95 idx_with_min_dist = idx;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
96 idx_in_queue_with_min_dist = i;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
97 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
98 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
99 gcc_assert (idx_with_min_dist != -1);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
100 gcc_assert (idx_in_queue_with_min_dist != -1);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
101
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
102 // FIXME: this is confusing: there are two indices here
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
103
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
104 queue.unordered_remove (idx_in_queue_with_min_dist);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
105
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
106 node_t *n
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
107 = static_cast <node_t *> (m_graph.m_nodes[idx_with_min_dist]);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
108
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
109 int i;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
110 edge_t *succ;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
111 FOR_EACH_VEC_ELT (n->m_succs, i, succ)
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
112 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
113 // TODO: only for dest still in queue
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
114 node_t *dest = succ->m_dest;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
115 int alt = m_dist[n->m_index] + 1;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
116 if (alt < m_dist[dest->m_index])
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
117 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
118 m_dist[dest->m_index] = alt;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
119 m_prev[dest->m_index] = succ;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
120 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
121 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
122 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
123 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
124
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
125 /* Generate an Path_t instance giving the shortest path to the node
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
126 TO from the origin node. */
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
127
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
128 template <typename GraphTraits, typename Path_t>
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
129 inline Path_t
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
130 shortest_paths<GraphTraits, Path_t>::get_shortest_path (const node_t *to) const
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
131 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
132 Path_t result;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
133
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
134 while (m_prev[to->m_index])
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
135 {
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
136 result.m_edges.safe_push (m_prev[to->m_index]);
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
137 to = m_prev[to->m_index]->m_src;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
138 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
139
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
140 result.m_edges.reverse ();
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
141
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
142 return result;
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
143 }
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
144
1830386684a0 gcc-9.2.0
anatofuz
parents:
diff changeset
145 #endif /* GCC_SHORTEST_PATHS_H */