Skip to content

Commit 8af890c

Browse files
committed
vars and comments alignment
1 parent 94ff55c commit 8af890c

11 files changed

Lines changed: 68 additions & 73 deletions

File tree

include/gl/algorithm/pathfinding/dijkstra.hpp

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,8 @@ template <traits::c_id_type IdType, traits::c_random_access_range_of<IdType> IdR
117117
while (true) {
118118
path.push_front(current_vertex);
119119
IdType predecessor = predecessor_map[to_idx(current_vertex)];
120-
121120
if (predecessor == current_vertex)
122121
break;
123-
124122
current_vertex = predecessor;
125123
}
126124

include/gl/algorithm/spanning_tree/prim_mst.hpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ template <traits::c_undirected_graph G>
4747
std::vector<bool> visited(n_vertices, false);
4848
queue_type edge_queue;
4949

50-
// insert the edges adjacent to the root vertex to the queue
50+
// insert the edges incident with the root vertex to the queue
5151
if (root_id == invalid_id)
5252
root_id = initial_id;
5353

@@ -74,7 +74,7 @@ template <traits::c_undirected_graph G>
7474
visited[min_edge_tgt] = true;
7575
++n_vertices_in_mst;
7676

77-
// enqueue all edges adjacent to the `target` vertex if they lead to unvisited verties
77+
// enqueue all edges incident with the `target` vertex if they lead to unvisited verties
7878
for (const auto& edge : graph.incidenct_edges(min_edge.target()))
7979
if (not visited[to_idx(edge.incident_vertex(min_edge.target()))])
8080
edge_queue.emplace(edge);
@@ -134,11 +134,11 @@ requires traits::c_has_numeric_limits_max<vertex_distance_type<G>>
134134
// Update adjacent vertices
135135
for (const auto& edge : graph.incidenct_edges(vertex_id)) {
136136
const auto edge_weight = get_weight<G>(edge);
137-
const auto incident_vertex_idx = to_idx(edge.incident_vertex(vertex_id));
137+
const auto target_vertex_idx = to_idx(edge.incident_vertex(vertex_id));
138138

139-
if (not in_mst[incident_vertex_idx] and edge_weight < min_cost[incident_vertex_idx]) {
140-
min_cost[incident_vertex_idx] = edge_weight;
141-
min_cost_edges[incident_vertex_idx].emplace(edge);
139+
if (not in_mst[target_vertex_idx] and edge_weight < min_cost[target_vertex_idx]) {
140+
min_cost[target_vertex_idx] = edge_weight;
141+
min_cost_edges[target_vertex_idx].emplace(edge);
142142
}
143143
}
144144

include/gl/algorithm/templates/bfs.hpp

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,12 @@ bool bfs(
5656
return false;
5757

5858
for (const auto& edge : graph.incidenct_edges(node.vertex_id)) {
59-
const auto incident_vertex_id = edge.incident_vertex(node.vertex_id);
60-
61-
const auto enqueue = enqueue_vertex_pred(incident_vertex_id, edge);
59+
const auto target_vertex_id = edge.incident_vertex(node.vertex_id);
60+
const auto enqueue = enqueue_vertex_pred(target_vertex_id, edge);
6261
if (enqueue == decision::abort)
6362
return false;
64-
6563
if (enqueue)
66-
q.emplace(incident_vertex_id, node.vertex_id);
64+
q.emplace(target_vertex_id, node.vertex_id);
6765
}
6866

6967
if constexpr (not traits::c_empty_callback<PostVisitCallback>)

include/gl/algorithm/templates/dfs.hpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ bool dfs(
5656
return false;
5757

5858
for (const auto& edge : graph.incidenct_edges(node.vertex_id)) {
59-
const auto incident_vertex_id = edge.incident_vertex(node.vertex_id);
60-
if (enqueue_vertex_pred(incident_vertex_id, edge))
61-
s.emplace(incident_vertex_id, node.vertex_id);
59+
const auto target_vertex_id = edge.incident_vertex(node.vertex_id);
60+
if (enqueue_vertex_pred(target_vertex_id, edge))
61+
s.emplace(target_vertex_id, node.vertex_id);
6262
}
6363

6464
if constexpr (not traits::c_empty_callback<PostVisitCallback>)
@@ -97,11 +97,11 @@ void r_dfs(
9797

9898
// recursively search vertices adjacent to the current vertex
9999
for (const auto& edge : graph.incidenct_edges(vertex_id)) {
100-
const auto& incident_vertex_id = edge.incident_vertex(vertex_id);
101-
if (enqueue_vertex_pred(incident_vertex_id, edge))
100+
const auto target_vertex_id = edge.incident_vertex(vertex_id);
101+
if (enqueue_vertex_pred(target_vertex_id, edge))
102102
r_dfs(
103103
graph,
104-
incident_vertex_id,
104+
target_vertex_id,
105105
vertex_id,
106106
visit_vertex_pred,
107107
visit,

include/gl/algorithm/templates/pfs.hpp

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,12 @@ bool pfs(
6060
return false;
6161

6262
for (const auto& edge : graph.incidenct_edges(node.vertex_id)) {
63-
const auto incident_vertex_id = edge.incident_vertex(node.vertex_id);
64-
65-
const auto enqueue = enqueue_vertex_pred(incident_vertex_id, edge);
63+
const auto target_vertex_id = edge.incident_vertex(node.vertex_id);
64+
const auto enqueue = enqueue_vertex_pred(target_vertex_id, edge);
6665
if (enqueue == decision::abort)
6766
return false;
68-
6967
if (enqueue)
70-
q.emplace(incident_vertex_id, node.vertex_id);
68+
q.emplace(target_vertex_id, node.vertex_id);
7169
}
7270
if constexpr (not traits::c_empty_callback<PostVisitCallback>)
7371
post_visit(node.vertex_id);

include/gl/conversion.hpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,14 @@ struct to_impl<impl::flat_list_t, impl::list_t> {
8686
auto& source_list = source._impl._list;
8787

8888
std::size_t total_items = 0uz;
89-
for (const auto& adj : source_list)
90-
total_items += adj.size();
89+
for (const auto& inc : source_list)
90+
total_items += inc.size();
9191

9292
target_list.reserve_segments(source_list.size());
9393
target_list.reserve_data(total_items);
9494

95-
for (auto& adj : source_list)
96-
target_list.push_back(std::move(adj));
95+
for (auto& inc : source_list)
96+
target_list.push_back(std::move(inc));
9797
}
9898
};
9999

@@ -106,8 +106,8 @@ struct to_impl<impl::list_t, impl::flat_list_t> {
106106
auto& source_list = source._impl._list;
107107

108108
target_list.reserve(source_list.size());
109-
for (auto adj : source_list)
110-
target_list.emplace_back(adj.begin(), adj.end());
109+
for (auto inc : source_list)
110+
target_list.emplace_back(inc.begin(), inc.end());
111111
}
112112
};
113113

include/gl/graph.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ class graph final {
693693
);
694694

695695
for (const auto& vertex : this->vertices()) {
696-
os << "- " << vertex << "\n adjacent edges:\n";
696+
os << "- " << vertex << "\n incident edges:\n";
697697
for (const auto& edge : this->incidenct_edges(vertex.id()))
698698
os << "\t- " << edge << '\n';
699699
}

include/gl/impl/adjacency_list.hpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class adjacency_list final {
3535

3636
using vertex_type = typename GraphTraits::vertex_type;
3737
using edge_type = typename GraphTraits::edge_type;
38-
using item_type = specialized::adjacency_list_item<id_type>;
38+
using item_type = specialized::incidence_item<id_type>;
3939
using adjacency_storage_type = typename specialized::adjacency_list_impl_traits<
4040
adjacency_list>::template storage_type<item_type>;
4141

@@ -173,8 +173,8 @@ class adjacency_list final {
173173

174174
gl_attr_force_inline void remove_edge(const edge_type& edge) {
175175
specialized_impl::remove_edge(*this, edge);
176-
for (auto&& adj : this->_list)
177-
for (auto& item : adj)
176+
for (auto&& inc : this->_list)
177+
for (auto& item : inc)
178178
item.edge_id -= static_cast<id_type>(item.edge_id > edge.id());
179179
}
180180

@@ -290,8 +290,8 @@ class adjacency_list final {
290290
std::ranges::unique(removed_edge_ids).begin(), removed_edge_ids.end()
291291
);
292292

293-
for (auto&& adj : this->_list) {
294-
for (auto& edge_item : adj) {
293+
for (auto&& inc : this->_list) {
294+
for (auto& edge_item : inc) {
295295
auto it = std::ranges::lower_bound(removed_edge_ids, edge_item.edge_id);
296296
if (it != removed_edge_ids.end() and *it == edge_item.edge_id)
297297
edge_item.edge_id = invalid_id; // edge was removed

include/gl/impl/specialized/adjacency_list.hpp

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,18 @@ class adjacency_list;
2525
namespace specialized {
2626

2727
template <traits::c_id_type IdType>
28-
struct adjacency_list_item {
28+
struct incidence_item {
2929
using id_type = IdType;
3030

3131
id_type vertex_id;
3232
id_type edge_id;
3333

34-
[[nodiscard]] bool operator==(const adjacency_list_item&) const = default;
34+
[[nodiscard]] bool operator==(const incidence_item&) const = default;
3535
};
3636

3737
namespace detail {
3838

39-
template <traits::c_instantiation_of<adjacency_list_item> AdjListItem>
39+
template <traits::c_instantiation_of<incidence_item> AdjListItem>
4040
[[nodiscard]] auto strict_find(traits::c_range_of<AdjListItem> auto& edge_list, const auto& edge) {
4141
const auto it = std::ranges::find(edge_list, edge.id(), &AdjListItem::edge_id);
4242
if (it == edge_list.end())
@@ -58,7 +58,7 @@ struct directed_adjacency_list {
5858
using impl_type = AdjacencyList;
5959
using id_type = typename impl_type::id_type;
6060
using edge_type = typename impl_type::edge_type;
61-
using item_type = adjacency_list_item<id_type>;
61+
using item_type = incidence_item<id_type>;
6262

6363
[[nodiscard]] static auto in_edges(const impl_type& self, id_type vertex_id) {
6464
std::vector<item_type> in_edges;
@@ -69,7 +69,7 @@ struct directed_adjacency_list {
6969
return item.vertex_id == tgt_id;
7070
})
7171
| std::views::transform([src_id](const auto& item) {
72-
return adjacency_list_item{src_id, item.edge_id};
72+
return incidence_item{src_id, item.edge_id};
7373
});
7474
in_edges.insert(in_edges.end(), in_edges_view.begin(), in_edges_view.end());
7575
}
@@ -101,8 +101,8 @@ struct directed_adjacency_list {
101101
[[nodiscard]] static std::vector<size_type> in_degree_map(const impl_type& self) {
102102
std::vector<size_type> in_degree_map(self._list.size(), 0uz);
103103

104-
for (const auto& adj_edges : self._list)
105-
for (const auto& item : adj_edges)
104+
for (const auto& inc_edges : self._list)
105+
for (const auto& item : inc_edges)
106106
++in_degree_map[to_idx(item.vertex_id)];
107107

108108
return in_degree_map;
@@ -112,7 +112,7 @@ struct directed_adjacency_list {
112112
const impl_type& self
113113
) {
114114
return self._list
115-
| std::views::transform([](const auto& adj_edges) { return adj_edges.size(); })
115+
| std::views::transform([](const auto& inc_edges) { return inc_edges.size(); })
116116
| std::ranges::to<std::vector<size_type>>();
117117
}
118118

@@ -138,19 +138,19 @@ struct directed_adjacency_list {
138138

139139
// remove all edges incident to the vertex
140140
for (auto idx = 0uz; idx < self._list.size(); ++idx) {
141-
auto& adj_edges = self._list[idx];
142-
if (idx == vertex_idx or adj_edges.empty())
141+
auto& inc_edges = self._list[idx];
142+
if (idx == vertex_idx or inc_edges.empty())
143143
continue;
144144

145145
const auto removed_subrng =
146-
std::ranges::remove_if(adj_edges, [vertex_id, &removed_edges](const auto& item) {
146+
std::ranges::remove_if(inc_edges, [vertex_id, &removed_edges](const auto& item) {
147147
if (item.vertex_id == vertex_id) {
148148
removed_edges.push_back(item.edge_id);
149149
return true;
150150
}
151151
return false;
152152
});
153-
adj_edges.erase(removed_subrng.begin(), removed_subrng.end());
153+
inc_edges.erase(removed_subrng.begin(), removed_subrng.end());
154154
}
155155

156156
// remove the list of edges incident from the vertex entirely
@@ -170,16 +170,16 @@ struct directed_adjacency_list {
170170
id_type source_id,
171171
const traits::c_forward_range_of<id_type> auto& target_ids
172172
) {
173-
auto& adjacent_edges_source = self._list[to_idx(source_id)];
174-
adjacent_edges_source.reserve(adjacent_edges_source.size() + target_ids.size());
173+
auto& inc_edges_source = self._list[to_idx(source_id)];
174+
inc_edges_source.reserve(inc_edges_source.size() + target_ids.size());
175175

176176
for (auto [edge_id, target_id] : std::views::zip(edge_ids, target_ids))
177-
adjacent_edges_source.emplace_back(target_id, edge_id);
177+
inc_edges_source.emplace_back(target_id, edge_id);
178178
}
179179

180180
gl_attr_force_inline static void remove_edge(impl_type& self, const edge_type& edge) {
181-
auto& adj_edges = self._list[to_idx(edge.source())];
182-
adj_edges.erase(detail::strict_find<item_type>(adj_edges, edge));
181+
auto& inc_edges = self._list[to_idx(edge.source())];
182+
inc_edges.erase(detail::strict_find<item_type>(inc_edges, edge));
183183
}
184184
};
185185

@@ -189,7 +189,7 @@ struct undirected_adjacency_list {
189189
using impl_type = AdjacencyList;
190190
using id_type = typename impl_type::id_type;
191191
using edge_type = typename impl_type::edge_type;
192-
using item_type = adjacency_list_item<id_type>;
192+
using item_type = incidence_item<id_type>;
193193

194194
[[nodiscard]] gl_attr_force_inline static auto in_edges(
195195
const impl_type& self, id_type vertex_id
@@ -244,11 +244,11 @@ struct undirected_adjacency_list {
244244
if (item.vertex_id == vertex_id)
245245
continue; // will be removed with the vertex's list
246246

247-
auto& adj_edges = self._list[to_idx(item.vertex_id)];
247+
auto& inc_edges = self._list[to_idx(item.vertex_id)];
248248
const auto removed_subrng = std::ranges::remove_if(
249-
adj_edges, [vertex_id](const auto& item) { return item.vertex_id == vertex_id; }
249+
inc_edges, [vertex_id](const auto& item) { return item.vertex_id == vertex_id; }
250250
);
251-
adj_edges.erase(removed_subrng.begin(), removed_subrng.end());
251+
inc_edges.erase(removed_subrng.begin(), removed_subrng.end());
252252
}
253253

254254
// remove the list of edges incident from the vertex entirely
@@ -271,23 +271,23 @@ struct undirected_adjacency_list {
271271
id_type source_id,
272272
const traits::c_forward_range_of<id_type> auto& target_ids
273273
) {
274-
auto& adjacent_edges_source = self._list[to_idx(source_id)];
275-
adjacent_edges_source.reserve(adjacent_edges_source.size() + target_ids.size());
274+
auto& inc_edges_source = self._list[to_idx(source_id)];
275+
inc_edges_source.reserve(inc_edges_source.size() + target_ids.size());
276276

277277
for (auto [edge_id, target_id] : std::views::zip(edge_ids, target_ids)) {
278-
adjacent_edges_source.emplace_back(target_id, edge_id);
278+
inc_edges_source.emplace_back(target_id, edge_id);
279279
if (source_id != target_id)
280280
self._list[to_idx(target_id)].emplace_back(source_id, edge_id);
281281
}
282282
}
283283

284284
static void remove_edge(impl_type& self, const edge_type& edge) {
285-
auto& adj_edges_first = self._list[to_idx(edge.source())];
286-
auto& adj_edges_second = self._list[to_idx(edge.target())];
285+
auto& inc_edges_first = self._list[to_idx(edge.source())];
286+
auto& inc_edges_second = self._list[to_idx(edge.target())];
287287

288-
adj_edges_first.erase(detail::strict_find<item_type>(adj_edges_first, edge));
288+
inc_edges_first.erase(detail::strict_find<item_type>(inc_edges_first, edge));
289289
if (not edge.is_loop())
290-
adj_edges_second.erase(detail::strict_find<item_type>(adj_edges_second, edge));
290+
inc_edges_second.erase(detail::strict_find<item_type>(inc_edges_second, edge));
291291
}
292292
};
293293

include/gl/impl/specialized/flat_adjacency_list.hpp

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ struct directed_flat_adjacency_list {
2323
using impl_type = AdjacencyList;
2424
using id_type = typename impl_type::id_type;
2525
using edge_type = typename impl_type::edge_type;
26-
using item_type = adjacency_list_item<id_type>;
26+
using item_type = incidence_item<id_type>;
2727

2828
[[nodiscard]] static auto in_edges(const impl_type& self, id_type vertex_id) {
2929
std::vector<item_type> in_edges;
@@ -34,7 +34,7 @@ struct directed_flat_adjacency_list {
3434
return item.vertex_id == tgt_id;
3535
})
3636
| std::views::transform([src_id](const auto& item) {
37-
return adjacency_list_item{src_id, item.edge_id};
37+
return incidence_item{src_id, item.edge_id};
3838
});
3939
in_edges.insert(in_edges.end(), in_edges_view.begin(), in_edges_view.end());
4040
}
@@ -151,7 +151,7 @@ struct undirected_flat_adjacency_list {
151151
using impl_type = AdjacencyList;
152152
using id_type = typename impl_type::id_type;
153153
using edge_type = typename impl_type::edge_type;
154-
using item_type = adjacency_list_item<id_type>;
154+
using item_type = incidence_item<id_type>;
155155

156156
[[nodiscard]] gl_attr_force_inline static auto in_edges(
157157
const impl_type& self, id_type vertex_id
@@ -255,17 +255,17 @@ struct undirected_flat_adjacency_list {
255255

256256
// remove from the source segment
257257
{
258-
auto adj_edges = self._list[src_idx];
259-
const auto it = detail::strict_find<item_type>(adj_edges, edge);
260-
const auto pos = static_cast<size_type>(std::distance(adj_edges.begin(), it));
258+
auto inc_edges = self._list[src_idx];
259+
const auto it = detail::strict_find<item_type>(inc_edges, edge);
260+
const auto pos = static_cast<size_type>(std::distance(inc_edges.begin(), it));
261261
self._list.erase(src_idx, pos);
262262
}
263263

264264
// remove from the target segment (if edge not a self-loop)
265265
if (src_idx != tgt_idx) {
266-
auto adj_edges = self._list[tgt_idx];
267-
const auto it = detail::strict_find<item_type>(adj_edges, edge);
268-
const auto pos = static_cast<size_type>(std::distance(adj_edges.begin(), it));
266+
auto inc_edges = self._list[tgt_idx];
267+
const auto it = detail::strict_find<item_type>(inc_edges, edge);
268+
const auto pos = static_cast<size_type>(std::distance(inc_edges.begin(), it));
269269
self._list.erase(tgt_idx, pos);
270270
}
271271
}

0 commit comments

Comments
 (0)