COIN-OR::LEMON - Graph Library

Ignore:
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/connectivity.h

    r633 r463  
    3333#include <functional>
    3434
    35 /// \ingroup graph_properties
     35/// \ingroup connectivity
    3636/// \file
    3737/// \brief Connectivity algorithms
     
    4141namespace lemon {
    4242
    43   /// \ingroup graph_properties
     43  /// \ingroup connectivity
    4444  ///
    4545  /// \brief Check whether the given undirected graph is connected.
     
    4747  /// Check whether the given undirected graph is connected.
    4848  /// \param graph The undirected graph.
    49   /// \return \c true when there is path between any two nodes in the graph.
     49  /// \return %True when there is path between any two nodes in the graph.
    5050  /// \note By definition, the empty graph is connected.
    5151  template <typename Graph>
     
    6464  }
    6565
    66   /// \ingroup graph_properties
     66  /// \ingroup connectivity
    6767  ///
    6868  /// \brief Count the number of connected components of an undirected graph
     
    106106  }
    107107
    108   /// \ingroup graph_properties
     108  /// \ingroup connectivity
    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
    116113  ///
    117114  /// \param graph The graph. It must be undirected.
     
    121118  /// set continuously.
    122119  /// \return The number of components
     120  ///
    123121  template <class Graph, class NodeMap>
    124122  int connectedComponents(const Graph &graph, NodeMap &compMap) {
     
    230228
    231229
    232   /// \ingroup graph_properties
     230  /// \ingroup connectivity
    233231  ///
    234232  /// \brief Check whether the given directed graph is strongly connected.
     
    237235  /// graph is strongly connected when any two nodes of the graph are
    238236  /// connected with directed paths in both direction.
    239   /// \return \c false when the graph is not strongly connected.
     237  /// \return %False when the graph is not strongly connected.
    240238  /// \see connected
    241239  ///
     
    288286  }
    289287
    290   /// \ingroup graph_properties
     288  /// \ingroup connectivity
    291289  ///
    292290  /// \brief Count the strongly connected components of a directed graph
     
    352350  }
    353351
    354   /// \ingroup graph_properties
     352  /// \ingroup connectivity
    355353  ///
    356354  /// \brief Find the strongly connected components of a directed graph
     
    364362  /// a lower.
    365363  ///
    366   /// \image html strongly_connected_components.png
    367   /// \image latex strongly_connected_components.eps "Strongly connected components" width=\textwidth
    368   ///
    369364  /// \param digraph The digraph.
    370365  /// \retval compMap A writable node map. The values will be set from 0 to
     
    373368  /// will be set continuously.
    374369  /// \return The number of components
     370  ///
    375371  template <typename Digraph, typename NodeMap>
    376372  int stronglyConnectedComponents(const Digraph& digraph, NodeMap& compMap) {
     
    421417  }
    422418
    423   /// \ingroup graph_properties
     419  /// \ingroup connectivity
    424420  ///
    425421  /// \brief Find the cut arcs of the strongly connected components.
     
    705701  int countBiNodeConnectedComponents(const Graph& graph);
    706702
    707   /// \ingroup graph_properties
     703  /// \ingroup connectivity
    708704  ///
    709705  /// \brief Checks the graph is bi-node-connected.
     
    714710  ///
    715711  /// \param graph The graph.
    716   /// \return \c true when the graph bi-node-connected.
     712  /// \return %True when the graph bi-node-connected.
    717713  template <typename Graph>
    718714  bool biNodeConnected(const Graph& graph) {
     
    720716  }
    721717
    722   /// \ingroup graph_properties
     718  /// \ingroup connectivity
    723719  ///
    724720  /// \brief Count the biconnected components.
     
    755751  }
    756752
    757   /// \ingroup graph_properties
     753  /// \ingroup connectivity
    758754  ///
    759755  /// \brief Find the bi-node-connected components.
     
    763759  /// relation on the undirected edges. Two undirected edge are in relationship
    764760  /// 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
    768761  ///
    769762  /// \param graph The graph.
     
    773766  /// will be set continuously.
    774767  /// \return The number of components.
     768  ///
    775769  template <typename Graph, typename EdgeMap>
    776770  int biNodeConnectedComponents(const Graph& graph,
     
    800794  }
    801795
    802   /// \ingroup graph_properties
     796  /// \ingroup connectivity
    803797  ///
    804798  /// \brief Find the bi-node-connected cut nodes.
     
    10301024  int countBiEdgeConnectedComponents(const Graph& graph);
    10311025
    1032   /// \ingroup graph_properties
     1026  /// \ingroup connectivity
    10331027  ///
    10341028  /// \brief Checks that the graph is bi-edge-connected.
     
    10451039  }
    10461040
    1047   /// \ingroup graph_properties
     1041  /// \ingroup connectivity
    10481042  ///
    10491043  /// \brief Count the bi-edge-connected components.
     
    10801074  }
    10811075
    1082   /// \ingroup graph_properties
     1076  /// \ingroup connectivity
    10831077  ///
    10841078  /// \brief Find the bi-edge-connected components.
     
    10881082  /// relation on the nodes. Two nodes are in relationship when they are
    10891083  /// 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
    10931084  ///
    10941085  /// \param graph The graph.
     
    10981089  /// will be set continuously.
    10991090  /// \return The number of components.
     1091  ///
    11001092  template <typename Graph, typename NodeMap>
    11011093  int biEdgeConnectedComponents(const Graph& graph, NodeMap& compMap) {
     
    11241116  }
    11251117
    1126   /// \ingroup graph_properties
     1118  /// \ingroup connectivity
    11271119  ///
    11281120  /// \brief Find the bi-edge-connected cut edges.
     
    11881180  }
    11891181
    1190   /// \ingroup graph_properties
     1182  /// \ingroup connectivity
    11911183  ///
    11921184  /// \brief Sort the nodes of a DAG into topolgical order.
     
    12271219  }
    12281220
    1229   /// \ingroup graph_properties
     1221  /// \ingroup connectivity
    12301222  ///
    12311223  /// \brief Sort the nodes of a DAG into topolgical order.
     
    12391231  /// of the map will be set exactly once, the values will be set descending
    12401232  /// order.
    1241   /// \return \c false when the graph is not DAG.
     1233  /// \return %False when the graph is not DAG.
    12421234  ///
    12431235  /// \see topologicalSort
     
    12821274  }
    12831275
    1284   /// \ingroup graph_properties
     1276  /// \ingroup connectivity
    12851277  ///
    12861278  /// \brief Check that the given directed graph is a DAG.
     
    12881280  /// Check that the given directed graph is a DAG. The DAG is
    12891281  /// an Directed Acyclic Digraph.
    1290   /// \return \c false when the graph is not DAG.
     1282  /// \return %False when the graph is not DAG.
    12911283  /// \see acyclic
    12921284  template <typename Digraph>
     
    13241316  }
    13251317
    1326   /// \ingroup graph_properties
     1318  /// \ingroup connectivity
    13271319  ///
    13281320  /// \brief Check that the given undirected graph is acyclic.
     
    13301322  /// Check that the given undirected graph acyclic.
    13311323  /// \param graph The undirected graph.
    1332   /// \return \c true when there is no circle in the graph.
     1324  /// \return %True when there is no circle in the graph.
    13331325  /// \see dag
    13341326  template <typename Graph>
     
    13581350  }
    13591351
    1360   /// \ingroup graph_properties
     1352  /// \ingroup connectivity
    13611353  ///
    13621354  /// \brief Check that the given undirected graph is tree.
     
    13641356  /// Check that the given undirected graph is tree.
    13651357  /// \param graph The undirected graph.
    1366   /// \return \c true when the graph is acyclic and connected.
     1358  /// \return %True when the graph is acyclic and connected.
    13671359  template <typename Graph>
    13681360  bool tree(const Graph& graph) {
     
    14501442  }
    14511443
    1452   /// \ingroup graph_properties
     1444  /// \ingroup connectivity
    14531445  ///
    14541446  /// \brief Check if the given undirected graph is bipartite or not
     
    14571449  /// or not. The \ref Bfs algorithm is used to calculate the result.
    14581450  /// \param graph The undirected graph.
    1459   /// \return \c true if \c graph is bipartite, \c false otherwise.
     1451  /// \return %True if \c graph is bipartite, %false otherwise.
    14601452  /// \sa bipartitePartitions
    14611453  template<typename Graph>
     
    14871479  }
    14881480
    1489   /// \ingroup graph_properties
     1481  /// \ingroup connectivity
    14901482  ///
    14911483  /// \brief Check if the given undirected graph is bipartite or not
     
    14951487  /// During the execution, the \c partMap will be set as the two
    14961488  /// partitions of the graph.
    1497   ///
    1498   /// \image html bipartite_partitions.png
    1499   /// \image latex bipartite_partitions.eps "Bipartite partititions" width=\textwidth
    1500   ///
    15011489  /// \param graph The undirected graph.
    15021490  /// \retval partMap A writable bool map of nodes. It will be set as the
    15031491  /// two partitions of the graph.
    1504   /// \return \c true if \c graph is bipartite, \c false otherwise.
     1492  /// \return %True if \c graph is bipartite, %false otherwise.
    15051493  template<typename Graph, typename NodeMap>
    15061494  inline bool bipartitePartitions(const Graph &graph, NodeMap &partMap){
Note: See TracChangeset for help on using the changeset viewer.