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

Ignore:
Timestamp:
03/29/09 23:08:20 (10 years ago)
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

Unmodified
Added
Removed
• ## lemon/connectivity.h

 r463 /// Check whether the given undirected graph is connected. /// \param graph The undirected graph. /// \return %True when there is path between any two nodes in the graph. /// \return \c true when there is path between any two nodes in the graph. /// \note By definition, the empty graph is connected. template /// graph is strongly connected when any two nodes of the graph are /// connected with directed paths in both direction. /// \return %False when the graph is not strongly connected. /// \return \c false when the graph is not strongly connected. /// \see connected /// /// /// \param graph The graph. /// \return %True when the graph bi-node-connected. /// \return \c true when the graph bi-node-connected. template bool biNodeConnected(const Graph& graph) { /// of the map will be set exactly once, the values will be set descending /// order. /// \return %False when the graph is not DAG. /// \return \c false when the graph is not DAG. /// /// \see topologicalSort /// Check that the given directed graph is a DAG. The DAG is /// an Directed Acyclic Digraph. /// \return %False when the graph is not DAG. /// \return \c false when the graph is not DAG. /// \see acyclic template /// Check that the given undirected graph acyclic. /// \param graph The undirected graph. /// \return %True when there is no circle in the graph. /// \return \c true when there is no circle in the graph. /// \see dag template /// Check that the given undirected graph is tree. /// \param graph The undirected graph. /// \return %True when the graph is acyclic and connected. /// \return \c true when the graph is acyclic and connected. template bool tree(const Graph& graph) { /// or not. The \ref Bfs algorithm is used to calculate the result. /// \param graph The undirected graph. /// \return %True if \c graph is bipartite, %false otherwise. /// \return \c true if \c graph is bipartite, \c false otherwise. /// \sa bipartitePartitions template /// \retval partMap A writable bool map of nodes. It will be set as the /// two partitions of the graph. /// \return %True if \c graph is bipartite, %false otherwise. /// \return \c true if \c graph is bipartite, \c false otherwise. template inline bool bipartitePartitions(const Graph &graph, NodeMap &partMap){
Note: See TracChangeset for help on using the changeset viewer.