COIN-OR::LEMON - Graph Library

Changeset 1793:d8130458dd86 in lemon-0.x for lemon/topology.h


Ignore:
Timestamp:
11/14/05 19:40:15 (14 years ago)
Author:
Balazs Dezso
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2334
Message:

Documentation fixes

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/topology.h

    r1767 r1793  
    7171  /// Count the number of connected components of an undirected graph
    7272  ///
    73   /// \param g The graph. In must be undirected.
     73  /// \param graph The graph. It should be undirected.
    7474  /// \return The number of components
    7575  template <typename UndirGraph>
     
    114114  /// \image latex connected_components.eps "Connected components" width=\textwidth
    115115  ///
    116   /// \param g The graph. In must be undirected.
    117   /// \retval comp A writable node map. The values will be set from 0 to
     116  /// \param graph The graph. It should be undirected.
     117  /// \retval compMap A writable node map. The values will be set from 0 to
    118118  /// the number of the connected components minus one. Each values of the map
    119119  /// will be set exactly once, the values of a certain component will be
     
    238238  /// \see connected
    239239  ///
    240   /// \waning Empty graph is not strongly connected.
     240  /// \warning Empty graph is not strongly connected.
    241241  template <typename Graph>
    242242  bool stronglyConnected(const Graph& graph) {
     
    292292  /// directed paths in both direction.
    293293  ///
    294   /// \param g The graph.
     294  /// \param graph The graph.
    295295  /// \return The number of components
    296296  template <typename Graph>
     
    356356  /// \image latex strongly_connected_components.eps "Strongly connected components" width=\textwidth
    357357  ///
    358   /// \param g The graph.
    359   /// \retval comp A writable node map. The values will be set from 0 to
     358  /// \param graph The graph.
     359  /// \param compMap A writable node map. The values will be set from 0 to
     360  /// the number of the connected components minus one. Each values of the map
     361  /// will be set exactly once, the values of a certain component will be
     362  /// set continuously.
     363  /// \retval compMap A writable node map. The values will be set from 0 to
    360364  /// the number of the strongly connected components minus one. Each values
    361365  /// of the map will be set exactly once, the values of a certain component
     
    421425  /// The strongly connected components are separated by the cut edges.
    422426  ///
    423   /// \param g The graph.
    424   /// \retval comp A writable edge map. The values will be set true when
    425   /// the edge is cut edge otherwise false.
     427  /// \param graph The graph.
     428  /// \retval cutMap A writable node map. The values will be set true when the
     429  /// edge is a cut edge.
    426430  ///
    427431  /// \return The number of cut edges
     
    759763  ///
    760764  /// \param graph The graph.
    761   /// \retval comp A writable undir edge map. The values will be set from 0 to
    762   /// the number of the biconnected components minus one. Each values
     765  /// \retval compMap A writable undir edge map. The values will be set from 0
     766  /// to the number of the biconnected components minus one. Each values
    763767  /// of the map will be set exactly once, the values of a certain component
    764768  /// will be set continuously.
     
    803807  ///
    804808  /// \param graph The graph.
    805   /// \retval comp A writable edge map. The values will be set true when
     809  /// \retval cutMap A writable edge map. The values will be set true when
    806810  /// the node separate two or more components.
    807811  /// \return The number of the cut nodes.
     
    10861090  ///
    10871091  /// \param graph The graph.
    1088   /// \retval comp A writable node map. The values will be set from 0 to
     1092  /// \retval compMap A writable node map. The values will be set from 0 to
    10891093  /// the number of the biconnected components minus one. Each values
    10901094  /// of the map will be set exactly once, the values of a certain component
     
    11301134  ///
    11311135  /// \param graph The graph.
    1132   /// \retval comp A writable node map. The values will be set true when the
     1136  /// \retval cutMap A writable node map. The values will be set true when the
    11331137  /// edge is a cut edge.
    11341138  /// \return The number of cut edges.
     
    11881192  /// Sort the nodes of a DAG into topolgical order.
    11891193  ///
    1190   /// \param g The graph. In must be directed and acyclic.
    1191   /// \retval comp A writable node map. The values will be set from 0 to
     1194  /// \param graph The graph. It should be directed and acyclic.
     1195  /// \retval order A writable node map. The values will be set from 0 to
    11921196  /// the number of the nodes in the graph minus one. Each values of the map
    11931197  /// will be set exactly once, the values  will be set descending order.
     
    12281232  /// that the given graph is DAG.
    12291233  ///
    1230   /// \param g The graph. In must be directed and acyclic.
     1234  /// \param graph The graph. It should be directed and acyclic.
    12311235  /// \retval order A readable - writable node map. The values will be set
    12321236  /// from 0 to the number of the nodes in the graph minus one. Each values
Note: See TracChangeset for help on using the changeset viewer.