Skip to content

Commit 940eaa3

Browse files
SpectraL519SpectraL519
committed
aligned the naming of callback parameters
1 parent f5f5e0c commit 940eaa3

7 files changed

Lines changed: 38 additions & 41 deletions

File tree

‎include/hgl/algorithm/templates/bfs.hpp‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,20 @@ template <
1515
traversal_direction Dir = traversal_direction::forward,
1616
traits::c_hypergraph H,
1717
traits::c_forward_range_of<search_node<H>> InitQueueRangeType = std::vector<search_node<H>>,
18-
traits::c_optional_predicate<const search_node<H>&> VisitVertexPredicate = empty_callback,
18+
traits::c_optional_predicate<const search_node<H>&> VisitPredicate = empty_callback,
1919
traits::c_optional_predicate<const search_node<H>&> VisitCallback = empty_callback,
2020
traits::c_optional_decision_predicate<typename H::id_type, typename H::id_type>
21-
TraverseHyperedgePred = empty_callback,
22-
traits::c_decision_predicate<const search_node<H>&> EnqueueVertexPred = empty_callback,
21+
TraverseHyperedgePredicate = empty_callback,
22+
traits::c_decision_predicate<const search_node<H>&> EnqueuePredicate = empty_callback,
2323
traits::c_optional_callback<void, const search_node<H>&> PreVisitCallback = empty_callback,
2424
traits::c_optional_callback<void, const search_node<H>&> PostVisitCallback = empty_callback>
2525
bool bfs(
2626
const H& hypergraph,
2727
const InitQueueRangeType& initial_queue_content,
28-
const VisitVertexPredicate& visit_vertex_pred = {},
28+
const VisitPredicate& visit_pred = {},
2929
const VisitCallback& visit = {},
30-
const TraverseHyperedgePred& traverse_he_pred = {},
31-
const EnqueueVertexPred& enqueue_vertex_pred = {},
30+
const TraverseHyperedgePredicate& traverse_he_pred = {},
31+
const EnqueuePredicate& enqueue_pred = {},
3232
const PreVisitCallback& pre_visit = {},
3333
const PostVisitCallback& post_visit = {}
3434
) {
@@ -45,8 +45,8 @@ bool bfs(
4545
const search_node curr_node = q.front();
4646
q.pop();
4747

48-
if constexpr (not traits::c_empty_callback<VisitVertexPredicate>)
49-
if (not visit_vertex_pred(curr_node))
48+
if constexpr (not traits::c_empty_callback<VisitPredicate>)
49+
if (not visit_pred(curr_node))
5050
continue;
5151

5252
if constexpr (not traits::c_empty_callback<PreVisitCallback>)
@@ -57,7 +57,7 @@ bool bfs(
5757
return false;
5858

5959
for (const auto he_id : policy::target_hyperedges(hypergraph, curr_node.vertex_id)) {
60-
if constexpr (not traits::c_empty_callback<TraverseHyperedgePred>) {
60+
if constexpr (not traits::c_empty_callback<TraverseHyperedgePredicate>) {
6161
const auto traverse = traverse_he_pred(he_id, curr_node.vertex_id);
6262
if (traverse == decision::abort)
6363
return false;
@@ -70,7 +70,7 @@ bool bfs(
7070
continue;
7171

7272
search_node<H> tgt_node{target_id, curr_node.vertex_id, he_id};
73-
const auto enqueue = enqueue_vertex_pred(tgt_node);
73+
const auto enqueue = enqueue_pred(tgt_node);
7474
if (enqueue == decision::abort)
7575
return false;
7676
if (enqueue)

‎include/hgl/algorithm/templates/dfs.hpp‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ template <
1414
traversal_direction Dir = traversal_direction::forward,
1515
traits::c_hypergraph H,
1616
traits::c_forward_range_of<search_node<H>> InitQueueRangeType = std::vector<search_node<H>>,
17-
traits::c_optional_predicate<const search_node<H>&> VisitVertexPredicate = empty_callback,
17+
traits::c_optional_predicate<const search_node<H>&> VisitPredicate = empty_callback,
1818
traits::c_optional_predicate<const search_node<H>&> VisitCallback = empty_callback,
1919
traits::c_optional_decision_predicate<typename H::id_type, typename H::id_type>
20-
TraverseHyperedgePred = empty_callback,
21-
traits::c_decision_predicate<const search_node<H>&> EnqueueVertexPred = empty_callback,
20+
TraverseHyperedgePredicate = empty_callback,
21+
traits::c_decision_predicate<const search_node<H>&> EnqueuePredicate = empty_callback,
2222
traits::c_optional_callback<void, const search_node<H>&> PreVisitCallback = empty_callback,
2323
traits::c_optional_callback<void, const search_node<H>&> PostVisitCallback = empty_callback>
2424
bool dfs(
2525
const H& hypergraph,
2626
const InitQueueRangeType& initial_queue_content,
27-
const VisitVertexPredicate& visit_vertex_pred = {},
27+
const VisitPredicate& visit_pred = {},
2828
const VisitCallback& visit = {},
29-
const TraverseHyperedgePred& traverse_he_pred = {},
30-
const EnqueueVertexPred& enqueue_vertex_pred = {},
29+
const TraverseHyperedgePredicate& traverse_he_pred = {},
30+
const EnqueuePredicate& enqueue_pred = {},
3131
const PreVisitCallback& pre_visit = {},
3232
const PostVisitCallback& post_visit = {}
3333
) {
@@ -44,8 +44,8 @@ bool dfs(
4444
const search_node curr_node = s.top();
4545
s.pop();
4646

47-
if constexpr (not traits::c_empty_callback<VisitVertexPredicate>)
48-
if (not visit_vertex_pred(curr_node))
47+
if constexpr (not traits::c_empty_callback<VisitPredicate>)
48+
if (not visit_pred(curr_node))
4949
continue;
5050

5151
if constexpr (not traits::c_empty_callback<PreVisitCallback>)
@@ -56,7 +56,7 @@ bool dfs(
5656
return false;
5757

5858
for (const auto he_id : policy::target_hyperedges(hypergraph, curr_node.vertex_id)) {
59-
if constexpr (not traits::c_empty_callback<TraverseHyperedgePred>) {
59+
if constexpr (not traits::c_empty_callback<TraverseHyperedgePredicate>) {
6060
const auto traverse = traverse_he_pred(he_id, curr_node.vertex_id);
6161
if (traverse == decision::abort)
6262
return false;
@@ -69,7 +69,7 @@ bool dfs(
6969
continue;
7070

7171
search_node<H> tgt_node{target_id, curr_node.vertex_id, he_id};
72-
const auto enqueue = enqueue_vertex_pred(tgt_node);
72+
const auto enqueue = enqueue_pred(tgt_node);
7373
if (enqueue == decision::abort)
7474
return false;
7575
if (enqueue)

‎include/hgl/algorithm/traversal/backward_search.hpp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ result_type<Result, search_tree<H>> backward_bfs(
3939
bfs<traversal_direction::forward>(
4040
hypergraph,
4141
root_queue,
42-
default_visit_vertex_predicate<H>(visited_vertices),
42+
default_visit_predicate<H>(visited_vertices),
4343
default_visit_callback<H, Result>(visited_vertices, stree),
4444
blocking_traverse_hyperedge_predicate(tail_unvisited),
45-
default_enqueue_vertex_predicate<H, true>(visited_vertices),
45+
default_enqueue_predicate<H, true>(visited_vertices),
4646
pre_visit,
4747
post_visit
4848
);
@@ -80,10 +80,10 @@ result_type<Result, search_tree<H>> backward_dfs(
8080
dfs<traversal_direction::forward>(
8181
hypergraph,
8282
root_queue,
83-
default_visit_vertex_predicate<H>(visited_vertices),
83+
default_visit_predicate<H>(visited_vertices),
8484
default_visit_callback<H, Result>(visited_vertices, stree),
8585
blocking_traverse_hyperedge_predicate(tail_unvisited),
86-
default_enqueue_vertex_predicate<H, true>(visited_vertices),
86+
default_enqueue_predicate<H, true>(visited_vertices),
8787
pre_visit,
8888
post_visit
8989
);

‎include/hgl/algorithm/traversal/breadth_first_search.hpp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ result_type<Result, search_tree<H>> breadth_first_search(
3232
bfs(
3333
hypergraph,
3434
init_range<H>(root_vertex_id),
35-
default_visit_vertex_predicate<H>(visited_vertices),
35+
default_visit_predicate<H>(visited_vertices),
3636
default_visit_callback<H, Result>(visited_vertices, stree),
3737
default_traverse_hyperedge_predicate(visited_hyperedges),
38-
default_enqueue_vertex_predicate<H, true>(visited_vertices),
38+
default_enqueue_predicate<H, true>(visited_vertices),
3939
pre_visit,
4040
post_visit
4141
);
@@ -45,10 +45,10 @@ result_type<Result, search_tree<H>> breadth_first_search(
4545
bfs(
4646
hypergraph,
4747
init_range<H>(root_id),
48-
default_visit_vertex_predicate<H>(visited_vertices),
48+
default_visit_predicate<H>(visited_vertices),
4949
default_visit_callback<H, Result>(visited_vertices, stree),
5050
default_traverse_hyperedge_predicate(visited_hyperedges),
51-
default_enqueue_vertex_predicate<H, true>(visited_vertices),
51+
default_enqueue_predicate<H, true>(visited_vertices),
5252
pre_visit,
5353
post_visit
5454
);

‎include/hgl/algorithm/traversal/depth_first_search.hpp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ result_type<Result, search_tree<H>> depth_first_search(
3232
dfs(
3333
hypergraph,
3434
init_range<H>(root_vertex_id),
35-
default_visit_vertex_predicate<H>(visited_vertices),
35+
default_visit_predicate<H>(visited_vertices),
3636
default_visit_callback<H, Result>(visited_vertices, stree),
3737
default_traverse_hyperedge_predicate(visited_hyperedges),
38-
default_enqueue_vertex_predicate<H, true>(visited_vertices),
38+
default_enqueue_predicate<H, true>(visited_vertices),
3939
pre_visit,
4040
post_visit
4141
);
@@ -45,10 +45,10 @@ result_type<Result, search_tree<H>> depth_first_search(
4545
dfs(
4646
hypergraph,
4747
init_range<H>(root_id),
48-
default_visit_vertex_predicate<H>(visited_vertices),
48+
default_visit_predicate<H>(visited_vertices),
4949
default_visit_callback<H, Result>(visited_vertices, stree),
5050
default_traverse_hyperedge_predicate(visited_hyperedges),
51-
default_enqueue_vertex_predicate<H, true>(visited_vertices),
51+
default_enqueue_predicate<H, true>(visited_vertices),
5252
pre_visit,
5353
post_visit
5454
);

‎include/hgl/algorithm/traversal/forward_search.hpp‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ result_type<Result, search_tree<H>> forward_bfs(
3939
bfs<traversal_direction::backward>(
4040
hypergraph,
4141
root_queue,
42-
default_visit_vertex_predicate<H>(visited_vertices),
42+
default_visit_predicate<H>(visited_vertices),
4343
default_visit_callback<H, Result>(visited_vertices, stree),
4444
blocking_traverse_hyperedge_predicate(head_unvisited),
45-
default_enqueue_vertex_predicate<H, true>(visited_vertices),
45+
default_enqueue_predicate<H, true>(visited_vertices),
4646
pre_visit,
4747
post_visit
4848
);
@@ -80,10 +80,10 @@ result_type<Result, search_tree<H>> forward_dfs(
8080
dfs<traversal_direction::backward>(
8181
hypergraph,
8282
root_queue,
83-
default_visit_vertex_predicate<H>(visited_vertices),
83+
default_visit_predicate<H>(visited_vertices),
8484
default_visit_callback<H, Result>(visited_vertices, stree),
8585
blocking_traverse_hyperedge_predicate(head_unvisited),
86-
default_enqueue_vertex_predicate<H, true>(visited_vertices),
86+
default_enqueue_predicate<H, true>(visited_vertices),
8787
pre_visit,
8888
post_visit
8989
);

‎include/hgl/algorithm/util.hpp‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ template <traits::c_hypergraph H>
3434
}
3535

3636
template <traits::c_hypergraph H>
37-
[[nodiscard]] gl_attr_force_inline auto default_visit_vertex_predicate(std::vector<bool>& visited_v
38-
) {
37+
[[nodiscard]] gl_attr_force_inline auto default_visit_predicate(std::vector<bool>& visited_v) {
3938
return [&](const search_node<H>& node) -> bool {
4039
return not visited_v[to_idx(node.vertex_id)];
4140
};
@@ -76,9 +75,7 @@ template <traits::c_hypergraph H, result_discriminator Result>
7675
}
7776

7877
template <traits::c_hypergraph H, bool AsResult = false>
79-
[[nodiscard]] gl_attr_force_inline auto default_enqueue_vertex_predicate(
80-
std::vector<bool>& visited_v
81-
) {
78+
[[nodiscard]] gl_attr_force_inline auto default_enqueue_predicate(std::vector<bool>& visited_v) {
8279
using return_t = std::conditional_t<AsResult, decision, bool>;
8380
return [&](const search_node<H>& node) -> return_t {
8481
return return_t(not visited_v[to_idx(node.vertex_id)]);

0 commit comments

Comments
 (0)