COIN-OR::LEMON - Graph Library

Changeset 2084:59769591eb60 in lemon-0.x for doc


Ignore:
Timestamp:
05/15/06 11:49:51 (13 years ago)
Author:
Balazs Dezso
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2749
Message:

Documentation improvements

Rearrangements:

IO modules
Algorithms

New documentation:

SwapBpUGraphAdaptor

Demos:

strongly_connected_orientation.cc

Benchmarks:

swap_bipartite_bench.cc

Location:
doc
Files:
2 added
2 edited

Legend:

Unmodified
Added
Removed
  • doc/graph-adaptors.dox

    r1949 r2084  
    3737   \code
    3838   ListGraph g;
    39    RevGraphAdaptor<ListGraph> rgw(g);
    40    int result=algorithm(rgw);
     39   RevGraphAdaptor<ListGraph> rga(g);
     40   int result=algorithm(rga);
    4141   \endcode
    4242   After running the algorithm, the original graph \c g
     
    5959   meaningless. This means that the concepts that they are models of depend
    6060   on the graph adaptor, and the wrapped graph(s).
    61    If an edge of \c rgw is deleted, this is carried out by
     61   If an edge of \c rga is deleted, this is carried out by
    6262   deleting the corresponding edge of \c g, thus the adaptor modifies the
    6363   original graph.
     
    7474   \code
    7575   int algorithm1(const ListGraph& g) {
    76    RevGraphAdaptor<const ListGraph> rgw(g);
    77    return algorithm2(rgw);
     76   RevGraphAdaptor<const ListGraph> rga(g);
     77   return algorithm2(rga);
    7878   }
    7979   \endcode
  • doc/groups.dox

    r2072 r2084  
    1515and thereafter the program code can be made efficient by small modifications.
    1616
    17 The most efficient implementation of diverse applications require the usage of different physical graph implementations. These differences appear in the size of
    18 graph we require to handle, memory or time usage limitations or in
    19 the set of operations through which the graph can be accessed.
    20 LEMON provides several physical graph structures to meet the
    21 diverging requirements of the possible users.
    22 In order to save on running time or on memory usage, some structures may
    23 fail to provide some graph features like edge or node deletion.
     17The most efficient implementation of diverse applications require the
     18usage of different physical graph implementations. These differences
     19appear in the size of graph we require to handle, memory or time usage
     20limitations or in the set of operations through which the graph can be
     21accessed.  LEMON provides several physical graph structures to meet
     22the diverging requirements of the possible users.  In order to save on
     23running time or on memory usage, some structures may fail to provide
     24some graph features like edge or node deletion.
    2425
    2526Alteration of standard containers need a very limited number of
     
    7778
    7879Most of them are \ref lemon::concept::ReadMap "ReadMap"s. They can
    79 make arithmetic oprerations between one or two maps (negation, scalig,
     80make arithmetic oprerations between one or two maps (negation, scaling,
    8081addition, multiplication etc.) or e.g. convert a map to another one
    8182of different Value type.
     
    8788\brief Two dimensional data storages.
    8889
    89 Two dimensional
    90 data storages.
    91 */
    92 
     90Two dimensional data storages.
     91*/
     92
     93/**
     94@defgroup paths Path Structures
     95@ingroup datas
     96\brief Path structures implemented in LEMON.
     97
     98LEMON provides flexible data structures
     99to work with paths.
     100
     101All of them have the same interface, especially they can be built or extended
     102using a standard Builder subclass. This make is easy to have e.g. the Dijkstra
     103algorithm to store its result in any kind of path structure.
     104
     105\sa lemon::concept::Path
     106
     107*/
    93108
    94109/**
     
    111126
    112127/**
    113 @defgroup galgs Graph Algorithms
    114 \brief This group describes the several graph algorithms
     128@defgroup algs Algorithms
     129\brief This group describes the several algorithms
    115130implemented in LEMON.
    116131
    117 This group describes the several graph algorithms
     132This group describes the several algorithms
    118133implemented in LEMON.
    119134*/
     
    121136/**
    122137@defgroup gutils General Graph Utilities
    123 @ingroup galgs
     138@ingroup algs
    124139\brief This group describes some simple general graph utilities.
    125140
    126141This group describes some simple general graph utilities.
     142*/
     143
     144/**
     145@defgroup flowalgs Path and Flow Algorithms
     146@ingroup algs
     147\brief This group describes the algorithms
     148for finding paths and flows in graphs.
     149
     150This group describes the algorithms
     151for finding paths and flows in graphs.
     152
     153\image html flow.png
     154\image latex flow.eps "Graph flow" width=\textwidth
     155*/
     156
     157/**
     158@defgroup topology Topology related algorithms
     159@ingroup algs
     160\brief This group describes the algorithms
     161for discover the topology of the graphs.
     162
     163This group describes the algorithms
     164for discover the topology of the graphs.
     165
     166\image html edge_biconnected_components.png
     167\image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
     168
     169*/
     170
     171/**
     172@defgroup matching Matching algorithms in graphs and bipartite graphs
     173@ingroup algs
     174\brief This group describes the algorithms
     175for find matchings in graphs and bipartite graphs.
     176
     177This group provides some algorithm objects and function
     178to calculate matchings in graphs and bipartite graphs.
     179
     180\image html bipartite_matching.png
     181\image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
     182
     183*/
     184
     185/**
     186@defgroup spantree Minimum Cost Spanning Tree Algorithms
     187@ingroup algs
     188\brief This group containes the algorithms for finding a minimum cost spanning
     189tree in a graph
     190
     191This group containes the algorithms for finding a minimum cost spanning
     192tree in a graph
     193*/
     194
     195
     196/**
     197@defgroup auxalg Auxiliary Algorithms
     198@ingroup algs
     199\brief Some algorithms implemented in LEMON.
     200
     201This group describes the algorithms in LEMON in order to make
     202it easier to implement complex algorithms.
     203
    127204*/
    128205
     
    135212implemented in LEMON.
    136213
    137 */
    138 
    139 /**
    140 @defgroup flowalgs Path and Flow Algorithms
    141 @ingroup galgs
    142 \brief This group describes the algorithms
    143 for finding paths and flows in graphs.
    144 
    145 This group describes the algorithms
    146 for finding paths and flows in graphs.
    147 
    148 \image html flow.png
    149 \image latex flow.eps "Graph flow" width=\textwidth
    150 */
    151 
    152 /**
    153 @defgroup topology Topology related algorithms
    154 @ingroup galgs
    155 \brief This group describes the algorithms
    156 for discover the topology of the graphs.
    157 
    158 This group describes the algorithms
    159 for discover the topology of the graphs.
    160 
    161 \image html edge_biconnected_components.png
    162 \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
    163 
    164 */
    165 
    166 /**
    167 @defgroup matching Matching algorithms in graphs and bipartite graphs
    168 @ingroup galgs
    169 \brief This group describes the algorithms
    170 for find matchings in graphs and bipartite graphs.
    171 
    172 This group provides some algorithm objects and function
    173 to calculate matchings in graphs and bipartite graphs.
    174 
    175 \image html bipartite_matching.png
    176 \image latex bipartite_matching.eps "Bipartite Matching" width=\textwidth
    177 
    178 */
    179 
    180 /**
    181 @defgroup exceptions Exceptions
    182 This group contains the exceptions thrown by LEMON library
    183214*/
    184215
     
    198229/**
    199230@defgroup io_group Input-Output
    200 Here you can find tools for imporing and exporting graphs and graph related
    201 data
     231\brief Several Graph Input-Output methods
     232
     233Here you can find tools for importing and exporting graphs
     234and graph related data. Now it supports the LEMON format, the
     235dimacs format and the encapsulated postscript format.
     236*/
     237
     238/**
     239@defgroup lemon_io Lemon Input-Output
     240@ingroup io_group
     241\brief Reading and writing LEMON format
     242
     243Methods for reading and writing LEMON format. More about this
     244format you can find on the \ref graph-io-page "Graph Input-Output"
     245tutorial pages.
     246
    202247*/
    203248
    204249/**
    205250@defgroup section_io Section readers and writers
    206 @ingroup io_group
     251@ingroup lemon_io
    207252\brief Section readers and writers for lemon Input-Output.
    208253
     
    213258/**
    214259@defgroup item_io Item Readers and Writers
    215 @ingroup io_group
     260@ingroup lemon_io
    216261\brief Item readers and writers for lemon Input-Output.
    217262
     
    222267
    223268/**
     269@defgroup eps_io Postscript exporting
     270@ingroup io_group
     271\brief General EPS drawer and graph exporter
     272
     273This group contains general EPS drawing methods and special
     274graph exporting tools.
     275*/
     276
     277/**
     278@defgroup exceptions Exceptions
     279This group contains the exceptions thrown by LEMON library
     280*/
     281
     282/**
    224283@defgroup concept Concepts
    225284\brief Skeleton classes and concept checking classes
     
    234293
    235294*/
     295
    236296
    237297/**
Note: See TracChangeset for help on using the changeset viewer.