YT-CPPGL-52: Naming cleanup

- Renamed
  - The `algorithm::detail` namespace to `algorithm::impl`
  - The `{bds/dfs}_impl` functions to `{bfs/dfs}`
  - `destination` to `target` in the context of vertices
- Aligned the documentation

Author: SpectraL519

CMakeLists.txt

@@ -8,7 +8,7 @@ else()
 endif()
 
 project(cpp-gl
-    VERSION 1.0.2
+    VERSION 1.0.3
     DESCRIPTION "General purpose header-only template graph library for C++20"
     HOMEPAGE_URL "https://github.com/SpectraL519/cpp-gl"
     LANGUAGES CXX

docs/algoithms.md

@@ -161,7 +161,7 @@ This section covers the specific types and type traits used for the algorithm im
     - `post_visit: const PostVisitCallback&` (default = `{}`) - The callback function to be called after visiting a vertex.
 
   - *Return type*:
-    - `detail::alg_return_graph_type<SearchTreeType>` - If `SearchTreeType` is not `types::no_return`, returns a search tree of type `SearchTreeType`. Otherwise, the return type is `void`.
+    - `impl::alg_return_graph_type<SearchTreeType>` - If `SearchTreeType` is not `types::no_return`, returns a search tree of type `SearchTreeType`. Otherwise, the return type is `void`.
 
   - *Defined in*: [gl/algorithm/depth_first_search.hpp](/include/gl/algorithm/deapth_first_search.hpp)
 
@@ -190,7 +190,7 @@ This section covers the specific types and type traits used for the algorithm im
     - `post_visit: const PostVisitCallback&` (default = `{}`) - The callback function to be called after visiting a vertex.
 
   - *Return type*:
-    - `detail::alg_return_graph_type<SearchTreeType>` - If `SearchTreeType` is not `types::no_return`, returns a search tree of type `SearchTreeType`. Otherwise, the return type is `void`.
+    - `impl::alg_return_graph_type<SearchTreeType>` - If `SearchTreeType` is not `types::no_return`, returns a search tree of type `SearchTreeType`. Otherwise, the return type is `void`.
 
   - *Defined in*: [gl/algorithm/breadth_first_search.hpp](/include/gl/algorithm/breadth_first_search.hpp)
 
@@ -352,14 +352,14 @@ This section covers the specific types and type traits used for the algorithm im
 
 To write custom graph algorithms you can use the types and concepts described in the [Algorithm-specific types and concepts](#algorithm-specific-types-and-concepts) as well as the general graph utility described in the [graph class documentation page](/docs/graph.md#additional-utility).
 
-Additionaly you can use the depth-first/breadth-first search algorithm templates which are defined in the `gl::algorithm::detail` namespace:
+Additionaly you can use the depth-first/breadth-first search algorithm templates which are defined in the `gl::algorithm::impl` namespace:
 
 ### Depth-first search templates
 
 > [!NOTE]
-> The DFS algorithm templates are defined in the [gl/algorithm/detail/dfs_impl.hpp](/include/gl/algorithm/detail/dfs_impl.hpp) file.
+> The DFS algorithm templates are defined in the [gl/algorithm/impl/dfs.hpp](/include/gl/algorithm/impl/dfs.hpp) file.
 
-- `dfs_impl(graph, root_vertex, visit_vertex_pred, visit, enque_vertex_pred, pre_visit, post_visit)`
+- `dfs(graph, root_vertex, visit_vertex_pred, visit, enque_vertex_pred, pre_visit, post_visit)`
   - *Desciption*: An iterative DFS algoithm template.
 
   - *Template parameters*:
@@ -381,7 +381,7 @@ Additionaly you can use the depth-first/breadth-first search algorithm templates
 
   - *Return type*: `void`
 
-- `rdfs_impl(graph, vertex, source_id, visit_vertex_pred, visit, enque_vertex_pred, pre_visit, post_visit)`
+- `r_dfs(graph, vertex, source_id, visit_vertex_pred, visit, enque_vertex_pred, pre_visit, post_visit)`
   - *Description*: A recursive DFS algorithm template.
 
   - *Template parameters*:
@@ -407,9 +407,9 @@ Additionaly you can use the depth-first/breadth-first search algorithm templates
 ### Breadth-first search templates
 
 > [!NOTE]
-> The BFS algorithm templates are defined in the [gl/algorithm/detail/bfs_impl.hpp](/include/gl/algorithm/detail/bfs_impl.hpp) file.
+> The BFS algorithm templates are defined in the [gl/algorithm/impl/bfs.hpp](/include/gl/algorithm/impl/bfs.hpp) file.
 
-- `bfs_impl(graph, initial_queue_content, visit_vertex_pred, visit, enque_vertex_pred, pre_visit, post_visit)`
+- `bfs(graph, initial_queue_content, visit_vertex_pred, visit, enque_vertex_pred, pre_visit, post_visit)`
   - *Desciption*: A *standard* BFS algorithm template.
 
   - *Template parameters*:
@@ -434,7 +434,7 @@ Additionaly you can use the depth-first/breadth-first search algorithm templates
 
   - *Return type*: `void`
 
-- `pq_bfs_impl(graph, pq_compare, initial_queue_content, visit_vertex_pred, visit, enque_vertex_pred, pre_visit, post_visit)`
+- `pq_bfs(graph, pq_compare, initial_queue_content, visit_vertex_pred, visit, enque_vertex_pred, pre_visit, post_visit)`
   - *Desciption*: A *priority queue* BFS algorithm template.
 
   - *Template parameters*:

docs/graph.md

@@ -320,29 +320,29 @@ Based on the specified traits, the `graph` class defines the following types:
   - *Return type*: `const edge_type&`
   - *Requires*: non-default `edge_properties_type`
 
-- **`graph.add_edges_from(source_id, destination_id_range)`**:
-  - *Description*: Adds multiple edges from a source vertex (specified by ID) to a range of destination vertices (also specified by IDs).
+- **`graph.add_edges_from(source_id, target_id_range)`**:
+  - *Description*: Adds multiple edges from a source vertex (specified by ID) to a range of target vertices (also specified by IDs).
   - *Template parameters*:
     - `IdRange: type_traits::c_sized_range_of<types::id_type>` – a range of vertex IDs that must satisfy the size and type constraints.
   - *Parameters*:
     - `source_id: types::id_type` – the ID of the source vertex.
-    - `destination_id_range: const IdRange&` – a range of destination vertex IDs to connect to the source vertex.
+    - `target_id_range: const IdRange&` – a range of target vertex IDs to connect to the source vertex.
   - *Return type*: `void`
 
-- **`graph.add_edges_from(source, destination_range)`**:
-  - *Description*: Adds multiple edges from a specified source vertex to a range of destination vertices (specified by references).
+- **`graph.add_edges_from(source, target_range)`**:
+  - *Description*: Adds multiple edges from a specified source vertex to a range of target vertices (specified by references).
   - *Template parameters*:
     - `VertexRefRange: type_traits::c_sized_range_of<types::const_ref_wrap<vertex_type>>` – a range of vertex references that must satisfy the size and type constraints.
   - *Parameters*:
     - `source: const vertex_type&` – the source vertex.
-    - `destination_range: const VertexRefRange&` – a range of destination vertex references to connect to the source vertex.
+    - `target_range: const VertexRefRange&` – a range of target vertex references to connect to the source vertex.
   - *Return type*: `void`
 
 > [!IMPORTANT]
 > Behaviour of adding an edge between `first` and `second`:
 >
-> - for *directed* graphs: adds a one-directional edge where `first` is the source vertex and `second` is the destination vertex
-> - for *undirected* graphs: adds a bidirectional edge where both vertices are source and destination vertices
+> - for *directed* graphs: adds a one-directional edge where `first` is the source vertex and `second` is the target vertex
+> - for *undirected* graphs: adds a bidirectional edge where both vertices are source and target vertices
 
 - **`graph.has_edge(first_id, second_id) const`**:
   - *Description*: Returns true if there is an edge between the vertices with the specified IDs.

docs/graph_elements.md

@@ -186,12 +186,12 @@ The destructor is *defaulted*, allowing proper cleanup of the `edge_descriptor`
   - *Return type*: `bool`
 
 - **`is_incident_to(const vertex_type& vertex) const`**:
-  - *Description*: Returns `true` if the provided vertex is the destination of the edge (for directed edges).
+  - *Description*: Returns `true` if the provided vertex is the target vertex of the edge (for directed edges).
   - *Returned value*:
     - For directed edges: $\text{vertex} = v$
     - For undirected edges: `is_incident_with(vertex)`
   - *Parameters*:
-    - `vertex: const vertex_type&` – the vertex to check if it is the destination.
+    - `vertex: const vertex_type&` – the vertex to check if it is the target.
   - *Return type*: `bool`
 
 - **`is_loop() const`**:

include/gl/algorithm/breadth_first_search.hpp

@@ -5,7 +5,7 @@
 #pragma once
 
 #include "constants.hpp"
-#include "detail/bfs_impl.hpp"
+#include "impl/bfs.hpp"
 #include "types.hpp"
 
 namespace gl::algorithm {
@@ -17,7 +17,7 @@ template <
         types::empty_callback,
     type_traits::c_optional_vertex_callback<GraphType, void> PostVisitCallback =
         types::empty_callback>
-detail::alg_return_graph_type<SearchTreeType> breadth_first_search(
+impl::alg_return_graph_type<SearchTreeType> breadth_first_search(
     const GraphType& graph,
     const std::optional<types::id_type>& root_vertex_id_opt = no_root_vertex,
     const PreVisitCallback& pre_visit = {},
@@ -29,27 +29,27 @@ detail::alg_return_graph_type<SearchTreeType> breadth_first_search(
     std::vector<bool> visited(graph.n_vertices(), false);
     std::vector<types::id_type> sources(graph.n_vertices());
 
-    auto search_tree = detail::init_search_tree<SearchTreeType>(graph);
+    auto search_tree = impl::init_search_tree<SearchTreeType>(graph);
 
     if (root_vertex_id_opt) {
-        detail::bfs_impl(
+        impl::bfs(
             graph,
-            detail::init_range(root_vertex_id_opt.value()),
-            detail::default_visit_vertex_predicate<GraphType>(visited),
-            detail::default_visit_callback<GraphType>(visited, search_tree),
-            detail::default_enqueue_vertex_predicate<GraphType, true>(visited),
+            impl::init_range(root_vertex_id_opt.value()),
+            impl::default_visit_vertex_predicate<GraphType>(visited),
+            impl::default_visit_callback<GraphType>(visited, search_tree),
+            impl::default_enqueue_vertex_predicate<GraphType, true>(visited),
             pre_visit,
             post_visit
         );
     }
     else {
         for (const auto root_id : graph.vertex_ids())
-            detail::bfs_impl(
+            impl::bfs(
                 graph,
-                detail::init_range(root_id),
-                detail::default_visit_vertex_predicate<GraphType>(visited),
-                detail::default_visit_callback<GraphType>(visited, search_tree),
-                detail::default_enqueue_vertex_predicate<GraphType, true>(visited),
+                impl::init_range(root_id),
+                impl::default_visit_vertex_predicate<GraphType>(visited),
+                impl::default_visit_callback<GraphType>(visited, search_tree),
+                impl::default_enqueue_vertex_predicate<GraphType, true>(visited),
                 pre_visit,
                 post_visit
             );

include/gl/algorithm/coloring.hpp

@@ -4,7 +4,7 @@
 
 #pragma once
 
-#include "detail/bfs_impl.hpp"
+#include "impl/bfs.hpp"
 
 namespace gl::algorithm {
 
@@ -36,9 +36,9 @@ template <
         // color the root vertex
         coloring[root_id] = bin_color_value::black;
 
-        const bool is_bipartite = detail::bfs_impl(
+        const bool is_bipartite = impl::bfs(
             graph,
-            detail::init_range(root_id),
+            impl::init_range(root_id),
             types::empty_callback{}, // visit predicate
             types::empty_callback{}, // visit callback
             [&coloring](const vertex_type& vertex, const edge_type& in_edge)

include/gl/algorithm/deapth_first_search.hpp

@@ -5,7 +5,7 @@
 #pragma once
 
 #include "constants.hpp"
-#include "detail/dfs_impl.hpp"
+#include "impl/dfs.hpp"
 
 namespace gl::algorithm {
 
@@ -16,7 +16,7 @@ template <
         types::empty_callback,
     type_traits::c_optional_vertex_callback<GraphType, void> PostVisitCallback =
         types::empty_callback>
-detail::alg_return_graph_type<SearchTreeType> depth_first_search(
+impl::alg_return_graph_type<SearchTreeType> depth_first_search(
     const GraphType& graph,
     const std::optional<types::id_type>& root_vertex_id_opt = no_root_vertex,
     const PreVisitCallback& pre_visit = {},
@@ -28,27 +28,27 @@ detail::alg_return_graph_type<SearchTreeType> depth_first_search(
     std::vector<bool> visited(graph.n_vertices(), false);
     std::vector<types::id_type> sources(graph.n_vertices());
 
-    auto search_tree = detail::init_search_tree<SearchTreeType>(graph);
+    auto search_tree = impl::init_search_tree<SearchTreeType>(graph);
 
     if (root_vertex_id_opt) {
-        detail::dfs_impl(
+        impl::dfs(
             graph,
             graph.get_vertex(root_vertex_id_opt.value()),
-            detail::default_visit_vertex_predicate<GraphType>(visited),
-            detail::default_visit_callback<GraphType>(visited, search_tree),
-            detail::default_enqueue_vertex_predicate<GraphType>(visited),
+            impl::default_visit_vertex_predicate<GraphType>(visited),
+            impl::default_visit_callback<GraphType>(visited, search_tree),
+            impl::default_enqueue_vertex_predicate<GraphType>(visited),
             pre_visit,
             post_visit
         );
     }
     else {
         for (const auto& root_vertex : graph.vertices())
-            detail::dfs_impl(
+            impl::dfs(
                 graph,
                 root_vertex,
-                detail::default_visit_vertex_predicate<GraphType>(visited),
-                detail::default_visit_callback<GraphType>(visited, search_tree),
-                detail::default_enqueue_vertex_predicate<GraphType>(visited),
+                impl::default_visit_vertex_predicate<GraphType>(visited),
+                impl::default_visit_callback<GraphType>(visited, search_tree),
+                impl::default_enqueue_vertex_predicate<GraphType>(visited),
                 pre_visit,
                 post_visit
             );
@@ -65,7 +65,7 @@ template <
         types::empty_callback,
     type_traits::c_optional_vertex_callback<GraphType, void> PostVisitCallback =
         types::empty_callback>
-detail::alg_return_graph_type<SearchTreeType> recursive_depth_first_search(
+impl::alg_return_graph_type<SearchTreeType> recursive_depth_first_search(
     const GraphType& graph,
     const std::optional<types::id_type>& root_vertex_id_opt = no_root_vertex,
     const PreVisitCallback& pre_visit = {},
@@ -77,30 +77,30 @@ detail::alg_return_graph_type<SearchTreeType> recursive_depth_first_search(
     std::vector<bool> visited(graph.n_vertices(), false);
     std::vector<types::id_type> sources(graph.n_vertices());
 
-    auto search_tree = detail::init_search_tree<SearchTreeType>(graph);
+    auto search_tree = impl::init_search_tree<SearchTreeType>(graph);
 
     if (root_vertex_id_opt) {
         const auto root_id = root_vertex_id_opt.value();
-        detail::rdfs_impl(
+        impl::r_dfs(
             graph,
             graph.get_vertex(root_id),
             root_id,
-            detail::default_visit_vertex_predicate<GraphType>(visited),
-            detail::default_visit_callback<GraphType>(visited, search_tree),
-            detail::default_enqueue_vertex_predicate<GraphType>(visited),
+            impl::default_visit_vertex_predicate<GraphType>(visited),
+            impl::default_visit_callback<GraphType>(visited, search_tree),
+            impl::default_enqueue_vertex_predicate<GraphType>(visited),
             pre_visit,
             post_visit
         );
     }
     else {
         for (const auto& root_vertex : graph.vertices())
-            detail::rdfs_impl(
+            impl::r_dfs(
                 graph,
                 root_vertex,
                 root_vertex.id(),
-                detail::default_visit_vertex_predicate<GraphType>(visited),
-                detail::default_visit_callback<GraphType>(visited, search_tree),
-                detail::default_enqueue_vertex_predicate<GraphType>(visited),
+                impl::default_visit_vertex_predicate<GraphType>(visited),
+                impl::default_visit_callback<GraphType>(visited, search_tree),
+                impl::default_enqueue_vertex_predicate<GraphType>(visited),
                 pre_visit,
                 post_visit
             );

include/gl/algorithm/dijkstra.hpp

@@ -4,8 +4,8 @@
 
 #pragma once
 
-#include "detail/bfs_impl.hpp"
 #include "gl/graph_utility.hpp"
+#include "impl/bfs.hpp"
 
 #include <deque>
 
@@ -29,18 +29,14 @@ struct paths_descriptor {
     std::vector<distance_type> distances;
 };
 
-namespace detail {
-
 template <type_traits::c_graph GraphType>
 using paths_descriptor_type = paths_descriptor<types::vertex_distance_type<GraphType>>;
 
-} // namespace detail
-
 template <type_traits::c_graph GraphType>
-[[nodiscard]] gl_attr_force_inline detail::paths_descriptor_type<GraphType> make_paths_descriptor(
+[[nodiscard]] gl_attr_force_inline paths_descriptor_type<GraphType> make_paths_descriptor(
     const GraphType& graph
 ) {
-    return detail::paths_descriptor_type<GraphType>{graph.n_vertices()};
+    return paths_descriptor_type<GraphType>{graph.n_vertices()};
 }
 
 template <
@@ -49,7 +45,7 @@ template <
         types::empty_callback,
     type_traits::c_optional_vertex_callback<GraphType, void> PostVisitCallback =
         types::empty_callback>
-[[nodiscard]] detail::paths_descriptor_type<GraphType> dijkstra_shortest_paths(
+[[nodiscard]] paths_descriptor_type<GraphType> dijkstra_shortest_paths(
     const GraphType& graph,
     const types::id_type source_id,
     const PreVisitCallback& pre_visit = {},
@@ -66,12 +62,12 @@ template <
 
     std::optional<types::const_ref_wrap<edge_type>> negative_edge;
 
-    detail::pq_bfs_impl(
+    impl::pq_bfs(
         graph,
         [&paths](const types::vertex_info& lhs, const types::vertex_info& rhs) {
             return paths.distances[lhs.id] > paths.distances[rhs.id];
         },
-        detail::init_range(source_id),
+        impl::init_range(source_id),
         types::empty_callback{}, // visit predicate
         types::empty_callback{}, // visit callback
         [&paths, &negative_edge](const vertex_type& vertex, const edge_type& in_edge)

include/gl/algorithm/detail/bfs_impl.hpp include/gl/algorithm/impl/bfs.hppinclude/gl/algorithm/detail/bfs_impl.hpp renamed to include/gl/algorithm/impl/bfs.hpp

@@ -8,7 +8,7 @@
 
 #include <queue>
 
-namespace gl::algorithm::detail {
+namespace gl::algorithm::impl {
 
 template <
     type_traits::c_graph GraphType,
@@ -23,7 +23,7 @@ template <
         types::empty_callback,
     type_traits::c_optional_vertex_callback<GraphType, void> PostVisitCallback =
         types::empty_callback>
-bool bfs_impl(
+bool bfs(
     const GraphType& graph,
     const InitQueueRangeType& initial_queue_content,
     const VisitVertexPredicate& visit_vertex_pred = {},
@@ -92,7 +92,7 @@ template <
         types::empty_callback,
     type_traits::c_optional_vertex_callback<GraphType, void> PostVisitCallback =
         types::empty_callback>
-bool pq_bfs_impl(
+bool pq_bfs(
     const GraphType& graph,
     const PQCompare& pq_compare,
     const InitQueueRangeType& initial_queue_content,
@@ -148,4 +148,4 @@ bool pq_bfs_impl(
     return true;
 }
 
-} // namespace gl::algorithm::detail
+} // namespace gl::algorithm::impl