COIN-OR::LEMON - Graph Library

Changeset 606:c5fd2d996909 in lemon for lemon/connectivity.h


Ignore:
Timestamp:
03/29/09 23:08:20 (10 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Various doc improvements (#248)

  • Rename all the ugly template parameters (too long and/or starting with an underscore).
  • Rename function parameters starting with an underscore.
  • Extend the doc for many classes.
  • Use LaTeX-style O(...) expressions only for the complicated ones.
  • A lot of small unification changes.
  • Small fixes.
  • Some other improvements.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/connectivity.h

    r463 r606  
    4747  /// Check whether the given undirected graph is connected.
    4848  /// \param graph The undirected graph.
    49   /// \return %True when there is path between any two nodes in the graph.
     49  /// \return \c 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>
     
    235235  /// graph is strongly connected when any two nodes of the graph are
    236236  /// connected with directed paths in both direction.
    237   /// \return %False when the graph is not strongly connected.
     237  /// \return \c false when the graph is not strongly connected.
    238238  /// \see connected
    239239  ///
     
    710710  ///
    711711  /// \param graph The graph.
    712   /// \return %True when the graph bi-node-connected.
     712  /// \return \c true when the graph bi-node-connected.
    713713  template <typename Graph>
    714714  bool biNodeConnected(const Graph& graph) {
     
    12311231  /// of the map will be set exactly once, the values will be set descending
    12321232  /// order.
    1233   /// \return %False when the graph is not DAG.
     1233  /// \return \c false when the graph is not DAG.
    12341234  ///
    12351235  /// \see topologicalSort
     
    12801280  /// Check that the given directed graph is a DAG. The DAG is
    12811281  /// an Directed Acyclic Digraph.
    1282   /// \return %False when the graph is not DAG.
     1282  /// \return \c false when the graph is not DAG.
    12831283  /// \see acyclic
    12841284  template <typename Digraph>
     
    13221322  /// Check that the given undirected graph acyclic.
    13231323  /// \param graph The undirected graph.
    1324   /// \return %True when there is no circle in the graph.
     1324  /// \return \c true when there is no circle in the graph.
    13251325  /// \see dag
    13261326  template <typename Graph>
     
    13561356  /// Check that the given undirected graph is tree.
    13571357  /// \param graph The undirected graph.
    1358   /// \return %True when the graph is acyclic and connected.
     1358  /// \return \c true when the graph is acyclic and connected.
    13591359  template <typename Graph>
    13601360  bool tree(const Graph& graph) {
     
    14491449  /// or not. The \ref Bfs algorithm is used to calculate the result.
    14501450  /// \param graph The undirected graph.
    1451   /// \return %True if \c graph is bipartite, %false otherwise.
     1451  /// \return \c true if \c graph is bipartite, \c false otherwise.
    14521452  /// \sa bipartitePartitions
    14531453  template<typename Graph>
     
    14901490  /// \retval partMap A writable bool map of nodes. It will be set as the
    14911491  /// two partitions of the graph.
    1492   /// \return %True if \c graph is bipartite, %false otherwise.
     1492  /// \return \c true if \c graph is bipartite, \c false otherwise.
    14931493  template<typename Graph, typename NodeMap>
    14941494  inline bool bipartitePartitions(const Graph &graph, NodeMap &partMap){
Note: See TracChangeset for help on using the changeset viewer.