Skip to content

Commit 5b0fbc4

Browse files
committed
removed duplcated gl group tags
1 parent e838684 commit 5b0fbc4

37 files changed

Lines changed: 204 additions & 204 deletions

include/gl/algorithm/core.hpp

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace gl::algorithm {
1818

1919
// --- general types ---
2020

21-
/// @ingroup GL GL-Algorithm
21+
/// @ingroup GL-Algorithm
2222
/// @brief A tag type used to explicitly indicate the absence of a callback function.
2323
///
2424
/// > [!NOTE] Performance vs. Empty Lambdas
@@ -30,7 +30,7 @@ namespace gl::algorithm {
3030
/// > and speeds up compilation times.
3131
struct empty_callback {};
3232

33-
/// @ingroup GL GL-Algorithm GL-Types
33+
/// @ingroup GL-Algorithm GL-Types
3434
/// @brief Represents a generic tri-state decision for control flow.
3535
///
3636
/// Used by custom predicates to determine how to proceed with a given item, execution step, or operation.
@@ -78,7 +78,7 @@ struct decision {
7878
eval value;
7979
};
8080

81-
/// @ingroup GL GL-Algorithm
81+
/// @ingroup GL-Algorithm
8282
/// @brief Tag used to statically dictate whether an algorithm should return a constructed result or execute purely for side effects.
8383
///
8484
/// > [!NOTE] Namespace Availability
@@ -96,7 +96,7 @@ enum class result_discriminator : bool {
9696
};
9797
using enum result_discriminator;
9898

99-
/// @ingroup GL GL-Algorithm
99+
/// @ingroup GL-Algorithm
100100
/// @brief Resolves to the specified `ResultType` if `Result` is `ret`, otherwise resolves to `void`.
101101
///
102102
/// ### See Also
@@ -105,7 +105,7 @@ using enum result_discriminator;
105105
template <result_discriminator Result, typename ResultType>
106106
using result_type = std::conditional_t<Result == algorithm::ret, ResultType, void>;
107107

108-
/// @ingroup GL GL-Algorithm
108+
/// @ingroup GL-Algorithm
109109
/// @brief Resolves to the specified `ResultType` if `Result` is `ret`, otherwise resolves to `std::monostate`.
110110
///
111111
/// Useful for returning dummy values from conditionally compiled algorithm branches.
@@ -119,13 +119,13 @@ using non_void_result_type =
119119

120120
// --- traversal types ---
121121

122-
/// @ingroup GL GL-Algorithm
122+
/// @ingroup GL-Algorithm
123123
/// @brief Maps a vertex ID to its predecessor's ID in a traversal tree.
124124
/// @tparam GraphType The type of the graph being traversed.
125125
template <traits::c_graph GraphType>
126126
using predecessors_map = std::vector<typename GraphType::id_type>;
127127

128-
/// @ingroup GL GL-Algorithm
128+
/// @ingroup GL-Algorithm
129129
/// @brief Represents an active node in a search container (e.g., a BFS queue or DFS stack).
130130
/// @tparam GraphType The type of the graph being searched.
131131
template <traits::c_graph GraphType>
@@ -155,7 +155,7 @@ struct search_node {
155155

156156
// --- constants ---
157157

158-
/// @ingroup GL GL-Algorithm
158+
/// @ingroup GL-Algorithm
159159
/// @brief Constant representing the absence of a root vertex ID for a specific ID type.
160160
///
161161
/// ### See Also
@@ -165,7 +165,7 @@ struct search_node {
165165
template <traits::c_id_type IdType>
166166
inline constexpr IdType no_root_v = invalid_id_v<IdType>;
167167

168-
/// @ingroup GL GL-Algorithm
168+
/// @ingroup GL-Algorithm
169169
/// @brief Tag type providing an implicit conversion to the appropriate `no_root_v` for any numeric ID type.
170170
///
171171
/// ### See Also
@@ -185,7 +185,7 @@ struct no_root_t {
185185
}
186186
};
187187

188-
/// @ingroup GL GL-Algorithm
188+
/// @ingroup GL-Algorithm
189189
/// @brief Global constant representing the absence of a root vertex.
190190
///
191191
/// ### See Also

include/gl/algorithm/pathfinding/dijkstra.hpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
namespace gl::algorithm {
1717

18-
/// @ingroup GL GL-Algorithm
18+
/// @ingroup GL-Algorithm
1919
/// @brief A descriptor structure holding the results of a single-source shortest path execution.
2020
///
2121
/// ### Template Parameters
@@ -39,13 +39,13 @@ struct paths_descriptor {
3939
std::vector<distance_type> distances;
4040
};
4141

42-
/// @ingroup GL GL-Algorithm
42+
/// @ingroup GL-Algorithm
4343
/// @brief An alias for @ref gl::algorithm::paths_descriptor "paths_descriptor" that automatically deduces the appropriate distance type for the graph.
4444
/// @tparam G The type of the graph.
4545
template <traits::c_graph G>
4646
using paths_descriptor_type = paths_descriptor<G, vertex_distance_type<G>>;
4747

48-
/// @ingroup GL GL-Algorithm
48+
/// @ingroup GL-Algorithm
4949
/// @brief Factory function to create an initialized paths descriptor sized for the given graph.
5050
/// @tparam G The type of the graph.
5151
/// @param graph The graph to size the descriptor against.
@@ -55,7 +55,7 @@ template <traits::c_graph G>
5555
return paths_descriptor_type<G>{graph.n_vertices()};
5656
}
5757

58-
/// @ingroup GL GL-Algorithm
58+
/// @ingroup GL-Algorithm
5959
/// @brief Internal node structure for Dijkstra's algorithm to snapshot distances and preserve heap invariants.
6060
///
6161
/// This structure is used in the @ref gl::algorithm::dijkstra_shortest_paths "dijkstra_shortest_paths" algorithm
@@ -74,7 +74,7 @@ struct dijkstra_search_node {
7474
distance; ///< The accumulated distance from the source to this vertex at the time of enqueueing.
7575
};
7676

77-
/// @ingroup GL GL-Algorithm
77+
/// @ingroup GL-Algorithm
7878
/// @brief Computes the shortest paths from a single source vertex to all reachable vertices using Dijkstra's algorithm.
7979
///
8080
/// This algorithm utilizes the generic @ref gl::algorithm::pfs "pfs" template using the dedicated
@@ -203,7 +203,7 @@ template <
203203
return paths;
204204
}
205205

206-
/// @ingroup GL GL-Algorithm
206+
/// @ingroup GL-Algorithm
207207
/// @brief Reconstructs the sequence of vertices forming a path to a specific target.
208208
///
209209
/// This utility walks backward through a predecessor map, starting from the `vertex_id`

include/gl/algorithm/spanning_tree/prim_mst.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
namespace gl::algorithm {
1717

18-
/// @ingroup GL GL-Algorithm
18+
/// @ingroup GL-Algorithm
1919
/// @brief A descriptor structure holding the results of a Minimum Spanning Tree (MST) execution.
2020
///
2121
/// @tparam G The type of the undirected graph. Must satisfy the [**c_undirected_graph**](gl_concepts.md#gl-traits-c-undirected-graph) concept.
@@ -40,7 +40,7 @@ struct mst_descriptor {
4040
weight_type weight = static_cast<weight_type>(0);
4141
};
4242

43-
/// @ingroup GL GL-Algorithm
43+
/// @ingroup GL-Algorithm
4444
/// @brief Computes the Minimum Spanning Tree (MST) of an undirected graph using Prim's algorithm with an edge-based priority queue.
4545
///
4646
/// This implementation uses a standard binary heap (`std::priority_queue`) to store and sort edges based on their weight.
@@ -133,7 +133,7 @@ template <traits::c_undirected_graph G>
133133
return mst;
134134
}
135135

136-
/// @ingroup GL GL-Algorithm
136+
/// @ingroup GL-Algorithm
137137
/// @brief Computes the Minimum Spanning Tree (MST) of an undirected graph using Prim's algorithm with a vertex-based array heap.
138138
///
139139
/// This variation maintains a heap of vertex IDs based on their minimum known connection cost.

include/gl/algorithm/templates/bfs.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
namespace gl::algorithm {
1717

18-
/// @ingroup GL GL-Algorithm
18+
/// @ingroup GL-Algorithm
1919
/// @brief A highly customizable, generic Breadth-First Search (BFS) algorithm engine.
2020
///
2121
/// This template does not implement a specific algorithm (like finding a shortest path).

include/gl/algorithm/templates/dfs.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
namespace gl::algorithm {
1717

18-
/// @ingroup GL GL-Algorithm
18+
/// @ingroup GL-Algorithm
1919
/// @brief A highly customizable, generic iterative Depth-First Search (DFS) algorithm engine.
2020
///
2121
/// This engine provides the strict structural execution of a stack-based Depth-First Search.
@@ -130,7 +130,7 @@ bool dfs(
130130
return true;
131131
}
132132

133-
/// @ingroup GL GL-Algorithm
133+
/// @ingroup GL-Algorithm
134134
/// @brief A highly customizable, generic recursive Depth-First Search (DFS) algorithm engine.
135135
///
136136
/// This engine mirrors the iterative `dfs` behavior but utilizes the C++ call stack.

include/gl/algorithm/templates/pfs.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
namespace gl::algorithm {
1919

20-
/// @ingroup GL GL-Algorithm
20+
/// @ingroup GL-Algorithm
2121
/// @brief A highly customizable, generic Priority-First Search (PFS) algorithm engine.
2222
///
2323
/// This template provides the strict structural execution of a priority queue-based search.

include/gl/algorithm/topology/coloring.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212

1313
namespace gl::algorithm {
1414

15-
/// @ingroup GL GL-Algorithm
15+
/// @ingroup GL-Algorithm
1616
/// @brief Alias for a container mapping vertex indices to their calculated binary (bipartite) colors.
1717
using bicoloring_type = std::vector<binary_color>;
1818

19-
/// @ingroup GL GL-Algorithm
19+
/// @ingroup GL-Algorithm
2020
/// @brief Attempts to compute a valid bipartite (2-color) coloring for the given graph.
2121
///
2222
/// This algorithm utilizes the generic @ref gl::algorithm::bfs "bfs" template to traverse the graph and
@@ -113,7 +113,7 @@ template <
113113
return coloring;
114114
}
115115

116-
/// @ingroup GL GL-Algorithm
116+
/// @ingroup GL-Algorithm
117117
/// @brief Convenience wrapper for the @ref gl::algorithm::bipartite_coloring "bipartite_coloring" algorithm to check if a graph is bipartite without extracting the exact coloring map.
118118
/// @param graph The graph to evaluate.
119119
/// @return `true` if the graph is bipartite (2-colorable), `false` otherwise.
@@ -123,7 +123,7 @@ template <
123123
return bipartite_coloring(graph).has_value();
124124
}
125125

126-
/// @ingroup GL GL-Algorithm
126+
/// @ingroup GL-Algorithm
127127
/// @brief Applies a computed range of binary colors to the property payload of each vertex in the graph.
128128
///
129129
/// ### Template Parameters

include/gl/algorithm/topology/topological_sort.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
namespace gl::algorithm {
1414

15-
/// @ingroup GL GL-Algorithm
15+
/// @ingroup GL-Algorithm
1616
/// @brief Computes a topological ordering of the vertices in a Directed Acyclic Graph (DAG).
1717
///
1818
/// This implementation relies on Kahn's Algorithm. It utilizes the generic @ref gl::algorithm::bfs "bfs"

include/gl/algorithm/traits.hpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,40 +13,40 @@
1313

1414
namespace gl::traits {
1515

16-
/// @ingroup GL GL-Traits
16+
/// @ingroup GL-Traits
1717
/// @brief Concept checking if a given type is the @ref gl::algorithm::empty_callback "empty_callback" tag.
1818
template <typename F>
1919
concept c_empty_callback = std::same_as<F, algorithm::empty_callback>;
2020

21-
/// @ingroup GL GL-Traits
21+
/// @ingroup GL-Traits
2222
/// @brief Concept checking if a type is callable with specific arguments and returns a specific type.
2323
/// @tparam F The callable type.
2424
/// @tparam ReturnType The expected return type.
2525
/// @tparam Args The parameter types the callable must accept.
2626
template <typename F, typename ReturnType, typename... Args>
2727
concept c_callback = std::is_invocable_r_v<ReturnType, F, Args...>;
2828

29-
/// @ingroup GL GL-Traits
29+
/// @ingroup GL-Traits
3030
/// @brief Concept allowing either a valid callback or the explicit absence of one through the use of @ref gl::algorithm::empty_callback "empty_callback".
3131
template <typename F, typename ReturnType, typename... Args>
3232
concept c_optional_callback = c_empty_callback<F> or c_callback<F, ReturnType, Args...>;
3333

34-
/// @ingroup GL GL-Traits
34+
/// @ingroup GL-Traits
3535
/// @brief Concept checking if a type is a boolean predicate callable with specific arguments.
3636
template <typename F, typename... Args>
3737
concept c_predicate = std::predicate<F, Args...>;
3838

39-
/// @ingroup GL GL-Traits
39+
/// @ingroup GL-Traits
4040
/// @brief Concept allowing either a valid boolean predicate or the explicit absence of one through the use of @ref gl::algorithm::empty_callback "empty_callback".
4141
template <typename F, typename... Args>
4242
concept c_optional_predicate = c_empty_callback<F> or c_predicate<F, Args...>;
4343

44-
/// @ingroup GL GL-Traits
44+
/// @ingroup GL-Traits
4545
/// @brief Concept checking if a type is a predicate returning a @ref gl::algorithm::decision "decision".
4646
template <typename F, typename... Args>
4747
concept c_decision_predicate = std::is_invocable_r_v<algorithm::decision, F, Args...>;
4848

49-
/// @ingroup GL GL-Traits
49+
/// @ingroup GL-Traits
5050
/// @brief Concept allowing either a valid decision predicate or the explicit absence of one.
5151
template <typename F, typename... Args>
5252
concept c_optional_decision_predicate = c_empty_callback<F> or c_decision_predicate<F, Args...>;

include/gl/algorithm/traversal/breadth_first_search.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
namespace gl::algorithm {
1616

17-
/// @ingroup GL GL-Algorithm
17+
/// @ingroup GL-Algorithm
1818
/// @brief Executes a concrete Breadth-First Search (BFS) traversal over the graph.
1919
///
2020
/// This function utilizes the generic @ref gl::algorithm::bfs "bfs" template to perform a standard queue-based traversal.

0 commit comments

Comments
 (0)