COIN-OR::LEMON - Graph Library

Changeset 633:7c12061bd271 in lemon for lemon


Ignore:
Timestamp:
04/15/09 04:26:13 (16 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Add images + fixes in the doc of connectivity tools (#262)

Location:
lemon
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • lemon/connectivity.h

    r606 r633  
    3333#include <functional>
    3434
    35 /// \ingroup connectivity
     35/// \ingroup graph_properties
    3636/// \file
    3737/// \brief Connectivity algorithms
     
    4141namespace lemon {
    4242
    43   /// \ingroup connectivity
     43  /// \ingroup graph_properties
    4444  ///
    4545  /// \brief Check whether the given undirected graph is connected.
     
    6464  }
    6565
    66   /// \ingroup connectivity
     66  /// \ingroup graph_properties
    6767  ///
    6868  /// \brief Count the number of connected components of an undirected graph
     
    106106  }
    107107
    108   /// \ingroup connectivity
     108  /// \ingroup graph_properties
    109109  ///
    110110  /// \brief Find the connected components of an undirected graph
    111111  ///
    112112  /// Find the connected components of an undirected graph.
     113  ///
     114  /// \image html connected_components.png
     115  /// \image latex connected_components.eps "Connected components" width=\textwidth
    113116  ///
    114117  /// \param graph The graph. It must be undirected.
     
    118121  /// set continuously.
    119122  /// \return The number of components
    120   ///
    121123  template <class Graph, class NodeMap>
    122124  int connectedComponents(const Graph &graph, NodeMap &compMap) {
     
    228230
    229231
    230   /// \ingroup connectivity
     232  /// \ingroup graph_properties
    231233  ///
    232234  /// \brief Check whether the given directed graph is strongly connected.
     
    286288  }
    287289
    288   /// \ingroup connectivity
     290  /// \ingroup graph_properties
    289291  ///
    290292  /// \brief Count the strongly connected components of a directed graph
     
    350352  }
    351353
    352   /// \ingroup connectivity
     354  /// \ingroup graph_properties
    353355  ///
    354356  /// \brief Find the strongly connected components of a directed graph
     
    362364  /// a lower.
    363365  ///
     366  /// \image html strongly_connected_components.png
     367  /// \image latex strongly_connected_components.eps "Strongly connected components" width=\textwidth
     368  ///
    364369  /// \param digraph The digraph.
    365370  /// \retval compMap A writable node map. The values will be set from 0 to
     
    368373  /// will be set continuously.
    369374  /// \return The number of components
    370   ///
    371375  template <typename Digraph, typename NodeMap>
    372376  int stronglyConnectedComponents(const Digraph& digraph, NodeMap& compMap) {
     
    417421  }
    418422
    419   /// \ingroup connectivity
     423  /// \ingroup graph_properties
    420424  ///
    421425  /// \brief Find the cut arcs of the strongly connected components.
     
    701705  int countBiNodeConnectedComponents(const Graph& graph);
    702706
    703   /// \ingroup connectivity
     707  /// \ingroup graph_properties
    704708  ///
    705709  /// \brief Checks the graph is bi-node-connected.
     
    716720  }
    717721
    718   /// \ingroup connectivity
     722  /// \ingroup graph_properties
    719723  ///
    720724  /// \brief Count the biconnected components.
     
    751755  }
    752756
    753   /// \ingroup connectivity
     757  /// \ingroup graph_properties
    754758  ///
    755759  /// \brief Find the bi-node-connected components.
     
    759763  /// relation on the undirected edges. Two undirected edge are in relationship
    760764  /// when they are on same circle.
     765  ///
     766  /// \image html node_biconnected_components.png
     767  /// \image latex node_biconnected_components.eps "bi-node-connected components" width=\textwidth
    761768  ///
    762769  /// \param graph The graph.
     
    766773  /// will be set continuously.
    767774  /// \return The number of components.
    768   ///
    769775  template <typename Graph, typename EdgeMap>
    770776  int biNodeConnectedComponents(const Graph& graph,
     
    794800  }
    795801
    796   /// \ingroup connectivity
     802  /// \ingroup graph_properties
    797803  ///
    798804  /// \brief Find the bi-node-connected cut nodes.
     
    10241030  int countBiEdgeConnectedComponents(const Graph& graph);
    10251031
    1026   /// \ingroup connectivity
     1032  /// \ingroup graph_properties
    10271033  ///
    10281034  /// \brief Checks that the graph is bi-edge-connected.
     
    10391045  }
    10401046
    1041   /// \ingroup connectivity
     1047  /// \ingroup graph_properties
    10421048  ///
    10431049  /// \brief Count the bi-edge-connected components.
     
    10741080  }
    10751081
    1076   /// \ingroup connectivity
     1082  /// \ingroup graph_properties
    10771083  ///
    10781084  /// \brief Find the bi-edge-connected components.
     
    10821088  /// relation on the nodes. Two nodes are in relationship when they are
    10831089  /// connected at least two edge-disjoint paths.
     1090  ///
     1091  /// \image html edge_biconnected_components.png
     1092  /// \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
    10841093  ///
    10851094  /// \param graph The graph.
     
    10891098  /// will be set continuously.
    10901099  /// \return The number of components.
    1091   ///
    10921100  template <typename Graph, typename NodeMap>
    10931101  int biEdgeConnectedComponents(const Graph& graph, NodeMap& compMap) {
     
    11161124  }
    11171125
    1118   /// \ingroup connectivity
     1126  /// \ingroup graph_properties
    11191127  ///
    11201128  /// \brief Find the bi-edge-connected cut edges.
     
    11801188  }
    11811189
    1182   /// \ingroup connectivity
     1190  /// \ingroup graph_properties
    11831191  ///
    11841192  /// \brief Sort the nodes of a DAG into topolgical order.
     
    12191227  }
    12201228
    1221   /// \ingroup connectivity
     1229  /// \ingroup graph_properties
    12221230  ///
    12231231  /// \brief Sort the nodes of a DAG into topolgical order.
     
    12741282  }
    12751283
    1276   /// \ingroup connectivity
     1284  /// \ingroup graph_properties
    12771285  ///
    12781286  /// \brief Check that the given directed graph is a DAG.
     
    13161324  }
    13171325
    1318   /// \ingroup connectivity
     1326  /// \ingroup graph_properties
    13191327  ///
    13201328  /// \brief Check that the given undirected graph is acyclic.
     
    13501358  }
    13511359
    1352   /// \ingroup connectivity
     1360  /// \ingroup graph_properties
    13531361  ///
    13541362  /// \brief Check that the given undirected graph is tree.
     
    14421450  }
    14431451
    1444   /// \ingroup connectivity
     1452  /// \ingroup graph_properties
    14451453  ///
    14461454  /// \brief Check if the given undirected graph is bipartite or not
     
    14791487  }
    14801488
    1481   /// \ingroup connectivity
     1489  /// \ingroup graph_properties
    14821490  ///
    14831491  /// \brief Check if the given undirected graph is bipartite or not
     
    14871495  /// During the execution, the \c partMap will be set as the two
    14881496  /// partitions of the graph.
     1497  ///
     1498  /// \image html bipartite_partitions.png
     1499  /// \image latex bipartite_partitions.eps "Bipartite partititions" width=\textwidth
     1500  ///
    14891501  /// \param graph The undirected graph.
    14901502  /// \retval partMap A writable bool map of nodes. It will be set as the
  • lemon/euler.h

    r606 r633  
    2525#include <list>
    2626
    27 /// \ingroup graph_prop
     27/// \ingroup graph_properties
    2828/// \file
    2929/// \brief Euler tour
     
    3737  ///Euler iterator for digraphs.
    3838
    39   /// \ingroup graph_prop
     39  /// \ingroup graph_properties
    4040  ///This iterator converts to the \c Arc type of the digraph and using
    4141  ///operator ++, it provides an Euler tour of a \e directed
     
    124124  ///Euler iterator for graphs.
    125125
    126   /// \ingroup graph_prop
     126  /// \ingroup graph_properties
    127127  ///This iterator converts to the \c Arc (or \c Edge)
    128128  ///type of the digraph and using
     
    229229  ///Checks if the graph is Eulerian
    230230
    231   /// \ingroup graph_prop
     231  /// \ingroup graph_properties
    232232  ///Checks if the graph is Eulerian. It works for both directed and undirected
    233233  ///graphs.
Note: See TracChangeset for help on using the changeset viewer.