COIN-OR::LEMON - Graph Library

Ticket #303: 303-rearrange-98a30824fe36.patch

File 303-rearrange-98a30824fe36.patch, 5.6 KB (added by Peter Kovacs, 10 years ago)
  • doc/groups.dox

    # HG changeset patch
    # User Peter Kovacs <kpeter@inf.elte.hu>
    # Date 1248426472 -7200
    # Node ID 98a30824fe36884df74899663c07eb29b0efd435
    # Parent  4ac30454f1c13ba27b62fec6b649a2a6a944480e
    Rearrange modules (#303)
    
    diff --git a/doc/groups.dox b/doc/groups.dox
    a b  
    226226*/
    227227
    228228/**
    229 @defgroup matrices Matrices
    230 @ingroup datas
    231 \brief Two dimensional data storages implemented in LEMON.
    232 
    233 This group contains two dimensional data storages implemented in LEMON.
    234 */
    235 
    236 /**
    237229@defgroup paths Path Structures
    238230@ingroup datas
    239231\brief %Path structures implemented in LEMON.
     
    259251*/
    260252
    261253/**
     254@defgroup geomdat Geometric Data Structures
     255@ingroup auxdat
     256\brief Geometric data structures implemented in LEMON.
     257
     258This group contains geometric data structures implemented in LEMON.
     259
     260 - \ref lemon::dim2::Point "dim2::Point" implements a two dimensional
     261   vector with the usual operations.
     262 - \ref lemon::dim2::Box "dim2::Box" can be used to determine the
     263   rectangular bounding box of a set of \ref lemon::dim2::Point
     264   "dim2::Point"'s.
     265*/
     266
     267/**
     268@defgroup matrices Matrices
     269@ingroup auxdat
     270\brief Two dimensional data storages implemented in LEMON.
     271
     272This group contains two dimensional data storages implemented in LEMON.
     273*/
     274
     275/**
    262276@defgroup algs Algorithms
    263277\brief This group contains the several algorithms
    264278implemented in LEMON.
     
    298312*/
    299313
    300314/**
     315@defgroup spantree Minimum Spanning Tree Algorithms
     316@ingroup algs
     317\brief Algorithms for finding minimum cost spanning trees and arborescences.
     318
     319This group contains the algorithms for finding minimum cost spanning
     320trees and arborescences.
     321*/
     322
     323/**
    301324@defgroup max_flow Maximum Flow Algorithms
    302325@ingroup algs
    303326\brief Algorithms for finding maximum flows.
     
    391414*/
    392415
    393416/**
    394 @defgroup graph_properties Connectivity and Other Graph Properties
    395 @ingroup algs
    396 \brief Algorithms for discovering the graph properties
    397 
    398 This group contains the algorithms for discovering the graph properties
    399 like connectivity, bipartiteness, euler property, simplicity etc.
    400 
    401 \image html connected_components.png
    402 \image latex connected_components.eps "Connected components" width=\textwidth
    403 */
    404 
    405 /**
    406 @defgroup planar Planarity Embedding and Drawing
    407 @ingroup algs
    408 \brief Algorithms for planarity checking, embedding and drawing
    409 
    410 This group contains the algorithms for planarity checking,
    411 embedding and drawing.
    412 
    413 \image html planar.png
    414 \image latex planar.eps "Plane graph" width=\textwidth
    415 */
    416 
    417 /**
    418417@defgroup matching Matching Algorithms
    419418@ingroup algs
    420419\brief Algorithms for finding matchings in graphs and bipartite graphs.
     
    455454*/
    456455
    457456/**
    458 @defgroup spantree Minimum Spanning Tree Algorithms
     457@defgroup graph_properties Connectivity and Other Graph Properties
    459458@ingroup algs
    460 \brief Algorithms for finding minimum cost spanning trees and arborescences.
     459\brief Algorithms for discovering the graph properties
    461460
    462 This group contains the algorithms for finding minimum cost spanning
    463 trees and arborescences.
     461This group contains the algorithms for discovering the graph properties
     462like connectivity, bipartiteness, euler property, simplicity etc.
     463
     464\image html connected_components.png
     465\image latex connected_components.eps "Connected components" width=\textwidth
     466*/
     467
     468/**
     469@defgroup planar Planarity Embedding and Drawing
     470@ingroup algs
     471\brief Algorithms for planarity checking, embedding and drawing
     472
     473This group contains the algorithms for planarity checking,
     474embedding and drawing.
     475
     476\image html planar.png
     477\image latex planar.eps "Plane graph" width=\textwidth
     478*/
     479
     480/**
     481@defgroup approx Approximation Algorithms
     482@ingroup algs
     483\brief Approximation algorithms.
     484
     485This group contains the approximation and heuristic algorithms
     486implemented in LEMON.
    464487*/
    465488
    466489/**
     
    473496*/
    474497
    475498/**
    476 @defgroup approx Approximation Algorithms
    477 @ingroup algs
    478 \brief Approximation algorithms.
    479 
    480 This group contains the approximation and heuristic algorithms
    481 implemented in LEMON.
    482 */
    483 
    484 /**
    485499@defgroup gen_opt_group General Optimization Tools
    486500\brief This group contains some general optimization frameworks
    487501implemented in LEMON.
     
    587601*/
    588602
    589603/**
    590 @defgroup dimacs_group DIMACS format
     604@defgroup dimacs_group DIMACS Format
    591605@ingroup io_group
    592606\brief Read and write files in DIMACS format
    593607
     
    649663*/
    650664
    651665/**
     666@defgroup tools Standalone Utility Applications
     667
     668Some utility applications are listed here.
     669
     670The standard compilation procedure (<tt>./configure;make</tt>) will compile
     671them, as well.
     672*/
     673
     674/**
    652675\anchor demoprograms
    653676
    654677@defgroup demos Demo Programs
     
    660683<tt>make check</tt> commands.
    661684*/
    662685
    663 /**
    664 @defgroup tools Standalone Utility Applications
    665 
    666 Some utility applications are listed here.
    667 
    668 The standard compilation procedure (<tt>./configure;make</tt>) will compile
    669 them, as well.
    670 */
    671 
    672686}
  • lemon/dim2.h

    diff --git a/lemon/dim2.h b/lemon/dim2.h
    a b  
    2121
    2222#include <iostream>
    2323
    24 ///\ingroup misc
     24///\ingroup geomdat
    2525///\file
    2626///\brief A simple two dimensional vector and a bounding box implementation
    27 ///
    28 /// The class \ref lemon::dim2::Point "dim2::Point" implements
    29 /// a two dimensional vector with the usual operations.
    30 ///
    31 /// The class \ref lemon::dim2::Box "dim2::Box" can be used to determine
    32 /// the rectangular bounding box of a set of
    33 /// \ref lemon::dim2::Point "dim2::Point"'s.
    3427
    3528namespace lemon {
    3629
     
    4033  ///tools for handling two dimensional coordinates
    4134  namespace dim2 {
    4235
    43   /// \addtogroup misc
     36  /// \addtogroup geomdat
    4437  /// @{
    4538
    4639  /// Two dimensional vector (plain vector)