[814] | 1 | |
---|
[678] | 2 | /** |
---|
| 3 | @defgroup datas Data Structures |
---|
| 4 | This group describes the several graph structures implemented in HugoLib. |
---|
| 5 | */ |
---|
[430] | 6 | |
---|
[678] | 7 | /** |
---|
| 8 | @defgroup graphs Graph Structures |
---|
| 9 | @ingroup datas |
---|
| 10 | \brief Graph structures implemented in Hugo. |
---|
[430] | 11 | |
---|
[774] | 12 | Hugolib provides several data structures to meet the diverging requirements |
---|
[678] | 13 | of the possible users. |
---|
| 14 | In order to save on running time or on memory usage, some structures may |
---|
| 15 | fail to provide |
---|
| 16 | some graph features like edge or node deletion. |
---|
[430] | 17 | |
---|
[678] | 18 | Hugolib also offers special graphs that cannot be used alone but only |
---|
[774] | 19 | in conjunction with other graph representation. The examples for this are |
---|
[814] | 20 | \ref hugo::EdgeSet "EdgeSet", \ref hugo::NodeSet "NodeSet" |
---|
| 21 | and the large variety of \ref gwrappers "graph wrappers". |
---|
[430] | 22 | |
---|
[678] | 23 | You are free to use the graph structure that fit your requirements |
---|
| 24 | the best, most graph algorithms and auxiliary data structures can be used |
---|
| 25 | with any graph structures. |
---|
| 26 | */ |
---|
[430] | 27 | |
---|
[678] | 28 | /** |
---|
| 29 | @defgroup auxdat Auxiliary Data Structures |
---|
| 30 | @ingroup datas |
---|
| 31 | \brief Some data structures implemented in HugoLib. |
---|
[406] | 32 | |
---|
[678] | 33 | This group describes the data structures implemented in HugoLib in |
---|
| 34 | order to make it easier to implement combinatorial algorithms. |
---|
| 35 | */ |
---|
[406] | 36 | |
---|
[678] | 37 | /** |
---|
[785] | 38 | @defgroup graphmapfactory Tools to Make It Easier to Make Graph Maps |
---|
| 39 | @ingroup auxdat |
---|
| 40 | \brief Tools to Make It Easier to Make Graph Maps. |
---|
| 41 | |
---|
| 42 | This group describes the tools that makes it easier to make graph maps that |
---|
| 43 | dynamically update with the graph changes. |
---|
| 44 | */ |
---|
| 45 | |
---|
| 46 | /** |
---|
[678] | 47 | @defgroup gwrappers Wrapper Classes for Graphs |
---|
| 48 | \brief This group contains several wrapper classes for graphs |
---|
| 49 | @ingroup graphs |
---|
| 50 | */ |
---|
| 51 | |
---|
| 52 | /** |
---|
| 53 | @defgroup galgs Graph Algorithms |
---|
| 54 | \brief This group describes the several graph algorithms |
---|
| 55 | implemented in HugoLib. |
---|
| 56 | */ |
---|
| 57 | |
---|
| 58 | /** |
---|
[758] | 59 | @defgroup flowalgs Path and Flow Algorithms |
---|
[678] | 60 | @ingroup galgs |
---|
[758] | 61 | \brief This group describes the algorithms |
---|
| 62 | for finding paths and flows in graphs. |
---|
[678] | 63 | */ |
---|
| 64 | |
---|
| 65 | /** |
---|
| 66 | @defgroup misc Miscellaneous Tools |
---|
| 67 | Here you can find several useful tools for development, |
---|
| 68 | debugging and testing. |
---|
| 69 | */ |
---|
| 70 | |
---|
| 71 | /** |
---|
[794] | 72 | @defgroup skeletons Skeletons |
---|
| 73 | \brief Skeletons (a.k.a. concept checking classes) |
---|
| 74 | |
---|
| 75 | This group describes the data/algorithm skeletons implemented in HugoLib in |
---|
| 76 | order to make it easier to check if a certain template class or |
---|
| 77 | template function is correctly implemented. |
---|
| 78 | */ |
---|
| 79 | |
---|
| 80 | |
---|
| 81 | /** |
---|
[678] | 82 | @defgroup experimental Experimental Structures and Algorithms |
---|
| 83 | This group contains some Experimental structures and algorithms. |
---|
| 84 | The stuff here is subject to change. |
---|
| 85 | */ |
---|