Skip to content

Commit 5b3e772

Browse files
committed
concept gen alignment
1 parent aff451f commit 5b3e772

11 files changed

Lines changed: 439 additions & 106 deletions

docs/concepts_cfg.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@
77
"groups": {
88
"GL": {
99
"prefix": "gl::",
10-
"filename": "gl_traits.md",
10+
"filename": "gl_concepts.md",
1111
"anchor": "gl-traits-concepts-documentation",
1212
"title": "GL Concepts",
1313
"description": "This page documents the C++20 concepts defined within the GL module of the library."
1414
},
1515
"HGL": {
1616
"prefix": "hgl::",
17-
"filename": "hgl_traits.md",
17+
"filename": "hgl_concepts.md",
1818
"anchor": "hgl-traits-concepts-documentation",
1919
"title": "HGL Concepts",
2020
"description": "This page documents the C++20 concepts defined within the HGL module of the library."

docs/groups.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
///
4949
/// @section concepts_link Detailed Concept Specifications
5050
/// For a detailed list of all GL module's concepts and their formal requirements, please refer to
51-
/// the [GL Traits & Concepts Documentation](gl_traits.md#gl-traits-concepts-documentation) page.
51+
/// the [GL Concepts Documentation](gl_concepts.md#gl-traits-concepts-documentation) page.
5252

5353
/// @defgroup GL-Types Generic Types
5454
/// @ingroup GL

include/gl/constants.hpp

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ namespace gl {
1515

1616
/// @ingroup GL GL-Core
1717
/// @brief A constant representing the initial ID value of 0 for graph elements.
18-
/// @tparam IdType The type of the ID, which must satisfy the [**c_id_type**](gl_traits.md#gl-traits-c-id-type) concept.
18+
/// @tparam IdType The type of the ID, which must satisfy the [**c_id_type**](gl_concepts.md#gl-traits-c-id-type) concept.
1919
/// ### See Also
20-
/// - [**c_id_type**](gl_traits.md#gl-traits-c-id-type)
20+
/// - [**c_id_type**](gl_concepts.md#gl-traits-c-id-type)
2121
/// - @ref gl::initial_id_t "initial_id_t"
2222
/// - @ref gl::initial_id "initial_id"
2323
template <traits::c_id_type IdType>
@@ -26,11 +26,11 @@ inline constexpr IdType initial_id_v{0};
2626
/// @ingroup GL GL-Core
2727
/// @brief A helper type that can be implicitly converted to the initial ID value of 0 for any valid ID type.
2828
/// ### See Also
29-
/// - [**c_id_type**](gl_traits.md#gl-traits-c-id-type)
29+
/// - [**c_id_type**](gl_concepts.md#gl-traits-c-id-type)
3030
/// - @ref gl::initial_id_v "initial_id_v"
3131
/// - @ref gl::initial_id "initial_id"
3232
struct initial_id_t {
33-
/// @brief Implicitly converts to the initial ID value of 0 for any type that satisfies the [**c_id_type**](gl_traits.md#gl-traits-c-id-type) concept.
33+
/// @brief Implicitly converts to the initial ID value of 0 for any type that satisfies the [**c_id_type**](gl_concepts.md#gl-traits-c-id-type) concept.
3434
template <traits::c_id_type IdType>
3535
[[nodiscard]] constexpr operator IdType() const noexcept {
3636
return initial_id_v<IdType>;
@@ -49,7 +49,7 @@ struct initial_id_t {
4949
/// 1\. The `initial_id` constant can be implicitly converted to the `v1`'s type (`vertex_id_t`), resulting in `v1` being initialized to the value of 0.
5050
///
5151
/// ### See Also
52-
/// - [**c_id_type**](gl_traits.md#gl-traits-c-id-type)
52+
/// - [**c_id_type**](gl_concepts.md#gl-traits-c-id-type)
5353
/// - @ref gl::initial_id_v "initial_id_v"
5454
/// - @ref gl::initial_id_t "initial_id_t"
5555
inline constexpr initial_id_t initial_id{};
@@ -58,9 +58,9 @@ inline constexpr initial_id_t initial_id{};
5858

5959
/// @ingroup GL GL-Core
6060
/// @brief A constant representing the invalid ID value for graph elements, defined as the maximum value of the specified ID type.
61-
/// @tparam IdType The type of the ID, which must satisfy the [**c_id_type**](gl_traits.md#gl-traits-c-id-type) concept.
61+
/// @tparam IdType The type of the ID, which must satisfy the [**c_id_type**](gl_concepts.md#gl-traits-c-id-type) concept.
6262
/// ### See Also
63-
/// - [**c_id_type**](gl_traits.md#gl-traits-c-id-type)
63+
/// - [**c_id_type**](gl_concepts.md#gl-traits-c-id-type)
6464
/// - @ref gl::invalid_id_t "invalid_id_t"
6565
/// - @ref gl::invalid_id "invalid_id"
6666
template <traits::c_id_type IdType>
@@ -69,11 +69,11 @@ inline constexpr IdType invalid_id_v{std::numeric_limits<IdType>::max()};
6969
/// @ingroup GL GL-Core
7070
/// @brief A helper type that can be implicitly converted to the invalid ID value for any valid ID type.
7171
/// ### See Also
72-
/// - [**c_id_type**](gl_traits.md#gl-traits-c-id-type)
72+
/// - [**c_id_type**](gl_concepts.md#gl-traits-c-id-type)
7373
/// - @ref gl::invalid_id_v "invalid_id_v"
7474
/// - @ref gl::invalid_id "invalid_id"
7575
struct invalid_id_t {
76-
/// @brief Implicitly converts to the invalid ID value for any type that satisfies the [**c_id_type**](gl_traits.md#gl-traits-c-id-type) concept.
76+
/// @brief Implicitly converts to the invalid ID value for any type that satisfies the [**c_id_type**](gl_concepts.md#gl-traits-c-id-type) concept.
7777
template <traits::c_id_type IdType>
7878
[[nodiscard]] constexpr operator IdType() const noexcept {
7979
return invalid_id_v<IdType>;
@@ -85,7 +85,7 @@ struct invalid_id_t {
8585
/// enabling easy checking if a given ID is invalid without needing to explicitly reference
8686
/// the `invalid_id_v` constant for the specific ID type.
8787
///
88-
/// @tparam IdType The type of the ID, which must satisfy the [**c_id_type**](gl_traits.md#gl-traits-c-id-type) concept.
88+
/// @tparam IdType The type of the ID, which must satisfy the [**c_id_type**](gl_concepts.md#gl-traits-c-id-type) concept.
8989
/// @param lhs The ID value to compare againsyt the invalid ID constant.
9090
/// @param rhs The `invalid_id` constant (of type `invalid_id_t`) to compare with the ID value.
9191
/// @return Returns `true` if `lhs` is equal to the invalid ID value for its type, and `false` otherwise.
@@ -107,7 +107,7 @@ struct invalid_id_t {
107107
/// 1\. The `invalid_id` constant can be implicitly converted to the `v1`'s type (`vertex_id_t`), resulting in `v1` being initialized to the maximum value of `vertex_id_t`, which represents an invalid ID.
108108
///
109109
/// ### See Also
110-
/// - [**c_id_type**](gl_traits.md#gl-traits-c-id-type)
110+
/// - [**c_id_type**](gl_concepts.md#gl-traits-c-id-type)
111111
/// - @ref gl::invalid_id_v "invalid_id_v"
112112
/// - @ref gl::invalid_id_t "invalid_id_t"
113113
inline constexpr invalid_id_t invalid_id{};

include/gl/directional_tags.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ concept c_undirected_edge =
6767
///
6868
/// ### See Also
6969
/// - @ref gl::undirected_t "undirected_t" : For the tag representing an undirected graph configuration.
70-
/// - [**c_graph_directional_tag**](gl_traits.md#gl-traits-c-graph-directional-tag) : For the concept used to validate graph directional tags.
70+
/// - [**c_graph_directional_tag**](gl_concepts.md#gl-traits-c-graph-directional-tag) : For the concept used to validate graph directional tags.
7171
/// - @ref gl::edge_descriptor "edge_descriptor" : For the edge descriptor type defined based on the graph traits, which includes the directional tag as part of its definition.
7272
struct directed_t {
7373
/// @brief A type identity alias for the directed_t tag, allowing for easier type comparisons and trait evaluations.
@@ -109,7 +109,7 @@ struct directed_t {
109109
///
110110
/// ### See Also
111111
/// - @ref gl::directed_t "directed_t" : For the tag representing a directed graph configuration.
112-
/// - [**c_graph_directional_tag**](gl_traits.md#gl-traits-c-graph-directional-tag) : For the concept used to validate graph directional tags.
112+
/// - [**c_graph_directional_tag**](gl_concepts.md#gl-traits-c-graph-directional-tag) : For the concept used to validate graph directional tags.
113113
/// - @ref gl::edge_descriptor "edge_descriptor" : For the edge descriptor type defined based on the graph traits, which includes the directional tag as part of its definition.
114114
struct undirected_t {
115115
/// @brief A type identity alias for the undirected_t tag, allowing for easier type comparisons and trait evaluations.

include/gl/edge_descriptor.hpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ namespace gl {
5959
/// ### Template Parameters
6060
/// | Parameter | Description | Default | Constraint |
6161
/// | :------------- | :--- | :--- | :--- |
62-
/// | DirectionalTag | Tag specifying if the edge is directed or undirected. | @ref gl::directed_t "directed_t" | [**c_graph_directional_tag**](gl_traits.md#gl-traits-c-graph-directional-tag) |
63-
/// | Properties | The type of property data attached to the edge. | @ref gl::empty_properties "empty_properties" | [**c_properties**](gl_traits.md#gl-traits-c-properties) |
64-
/// | IdType | The underlying integer type used for the IDs. | @ref gl::default_id_type "default_id_type" | [**c_id_type**](gl_traits.md#gl-traits-c-id-type) |
62+
/// | DirectionalTag | Tag specifying if the edge is directed or undirected. | @ref gl::directed_t "directed_t" | [**c_graph_directional_tag**](gl_concepts.md#gl-traits-c-graph-directional-tag) |
63+
/// | Properties | The type of property data attached to the edge. | @ref gl::empty_properties "empty_properties" | [**c_properties**](gl_concepts.md#gl-traits-c-properties) |
64+
/// | IdType | The underlying integer type used for the IDs. | @ref gl::default_id_type "default_id_type" | [**c_id_type**](gl_concepts.md#gl-traits-c-id-type) |
6565
///
6666
/// ### See Also
6767
/// * @ref gl::vertex_descriptor : For the corresponding vertex wrapper class.
@@ -382,8 +382,8 @@ class edge_descriptor final {
382382
/// ### Template Parameters
383383
/// | Parameter | Description | Default | Constraint |
384384
/// | :--------- | :--- | :--- | :--- |
385-
/// | Properties | The type of property data attached to the edge. | @ref gl::empty_properties "empty_properties" | [**c_properties**](gl_traits.md#gl-traits-c-properties) |
386-
/// | IdType | The underlying integer type used for the IDs. | @ref gl::default_id_type "default_id_type" | [**c_id_type**](gl_traits.md#gl-traits-c-id-type) |
385+
/// | Properties | The type of property data attached to the edge. | @ref gl::empty_properties "empty_properties" | [**c_properties**](gl_concepts.md#gl-traits-c-properties) |
386+
/// | IdType | The underlying integer type used for the IDs. | @ref gl::default_id_type "default_id_type" | [**c_id_type**](gl_concepts.md#gl-traits-c-id-type) |
387387
template <
388388
traits::c_properties Properties = empty_properties,
389389
traits::c_id_type IdType = default_id_type>
@@ -397,8 +397,8 @@ using directed_edge = edge_descriptor<directed_t, Properties, IdType>;
397397
/// ### Template Parameters
398398
/// | Parameter | Description | Default | Constraint |
399399
/// | :--------- | :--- | :--- | :--- |
400-
/// | Properties | The type of property data attached to the edge. | @ref gl::empty_properties "empty_properties" | [**c_properties**](gl_traits.md#gl-traits-c-properties) |
401-
/// | IdType | The underlying integer type used for the IDs. | @ref gl::default_id_type "default_id_type" | [**c_id_type**](gl_traits.md#gl-traits-c-id-type) |
400+
/// | Properties | The type of property data attached to the edge. | @ref gl::empty_properties "empty_properties" | [**c_properties**](gl_concepts.md#gl-traits-c-properties) |
401+
/// | IdType | The underlying integer type used for the IDs. | @ref gl::default_id_type "default_id_type" | [**c_id_type**](gl_concepts.md#gl-traits-c-id-type) |
402402
template <
403403
traits::c_properties Properties = empty_properties,
404404
traits::c_id_type IdType = default_id_type>

0 commit comments

Comments
 (0)