lemon-0.x: comparison lemon/topology.h

equal deleted inserted replaced

-:97c001c082d3
+:d0de1799176a
 ///
 /// \brief Count the number of connected components of an undirected graph
 ///
 /// Count the number of connected components of an undirected graph
 ///
-/// \param g The graph. In must be undirected.
+/// \param graph The graph. It should be undirected.
 /// \return The number of components
 template <typename UndirGraph>
 int countConnectedComponents(const UndirGraph &graph) {
 checkConcept<concept::UndirGraph, UndirGraph>();
 typedef typename UndirGraph::Node Node;
 /// Find the connected components of an undirected graph.
 ///
 /// \image html connected_components.png
 /// \image latex connected_components.eps "Connected components" width=\textwidth
 ///
-/// \param g The graph. In must be undirected.
+/// \param graph The graph. It should be undirected.
-/// \retval comp A writable node map. The values will be set from 0 to
+/// \retval compMap A writable node map. The values will be set from 0 to
 /// the number of the connected components minus one. Each values of the map
 /// will be set exactly once, the values of a certain component will be
 /// set continuously.
 /// \return The number of components
 ///
 /// graph is strongly connected when any two nodes of the graph are
 /// connected with directed pathes in both direction.
 /// \return %False when the graph is not strongly connected.
 /// \see connected
 ///
-/// \waning Empty graph is not strongly connected.
+/// \warning Empty graph is not strongly connected.
 template <typename Graph>
 bool stronglyConnected(const Graph& graph) {
 checkConcept<concept::StaticGraph, Graph>();
 if (NodeIt(graph) == INVALID) return false;
 /// Count the strongly connected components of a directed graph.
 /// The strongly connected components are the classes of an equivalence
 /// relation on the nodes of the graph. Two nodes are connected with
 /// directed paths in both direction.
 ///
-/// \param g The graph.
+/// \param graph The graph.
 /// \return The number of components
 template <typename Graph>
 int countStronglyConnectedComponents(const Graph& graph) {
 checkConcept<concept::StaticGraph, Graph>();
 /// when there are directed paths between them in both direction.
 ///
 /// \image html strongly_connected_components.png
 /// \image latex strongly_connected_components.eps "Strongly connected components" width=\textwidth
 ///
-/// \param g The graph.
+/// \param graph The graph.
-/// \retval comp A writable node map. The values will be set from 0 to
+/// \param compMap A writable node map. The values will be set from 0 to
+/// the number of the connected components minus one. Each values of the map
+/// will be set exactly once, the values of a certain component will be
+/// set continuously.
+/// \retval compMap A writable node map. The values will be set from 0 to
 /// the number of the strongly connected components minus one. Each values
 /// of the map will be set exactly once, the values of a certain component
 /// will be set continuously.
 /// \return The number of components
 ///
 /// The strongly connected components are the classes of an equivalence
 /// relation on the nodes of the graph. Two nodes are in relationship
 /// when there are directed paths between them in both direction.
 /// The strongly connected components are separated by the cut edges.
 ///
-/// \param g The graph.
+/// \param graph The graph.
-/// \retval comp A writable edge map. The values will be set true when
+/// \retval cutMap A writable node map. The values will be set true when the
-/// the edge is cut edge otherwise false.
+/// edge is a cut edge.
 ///
 /// \return The number of cut edges
 template <typename Graph, typename EdgeMap>
 int stronglyConnectedCutEdges(const Graph& graph, EdgeMap& cutMap) {
 checkConcept<concept::StaticGraph, Graph>();
 ///
 /// \image html node_biconnected_components.png
 /// \image latex node_biconnected_components.eps "bi-node-connected components" width=\textwidth
 ///
 /// \param graph The graph.
-/// \retval comp A writable undir edge map. The values will be set from 0 to
+/// \retval compMap A writable undir edge map. The values will be set from 0
-/// the number of the biconnected components minus one. Each values
+/// to the number of the biconnected components minus one. Each values
 /// of the map will be set exactly once, the values of a certain component
 /// will be set continuously.
 /// \return The number of components.
 ///
 template <typename UndirGraph, typename UndirEdgeMap>
 /// relation on the undirected edges. Two undirected edges are in
 /// relationship when they are on same circle. The biconnected components
 /// are separted by nodes which are the cut nodes of the components.
 ///
 /// \param graph The graph.
-/// \retval comp A writable edge map. The values will be set true when
+/// \retval cutMap A writable edge map. The values will be set true when
 /// the node separate two or more components.
 /// \return The number of the cut nodes.
 template <typename UndirGraph, typename NodeMap>
 int biNodeConnectedCutNodes(const UndirGraph& graph, NodeMap& cutMap) {
 checkConcept<concept::UndirGraph, UndirGraph>();
 ///
 /// \image html edge_biconnected_components.png
 /// \image latex edge_biconnected_components.eps "bi-edge-connected components" width=\textwidth
 ///
 /// \param graph The graph.
-/// \retval comp A writable node map. The values will be set from 0 to
+/// \retval compMap A writable node map. The values will be set from 0 to
 /// the number of the biconnected components minus one. Each values
 /// of the map will be set exactly once, the values of a certain component
 /// will be set continuously.
 /// \return The number of components.
 ///
 /// connected with at least two edge-disjoint paths. The bi-edge-connected
 /// components are separted by edges which are the cut edges of the
 /// components.
 ///
 /// \param graph The graph.
-/// \retval comp A writable node map. The values will be set true when the
+/// \retval cutMap A writable node map. The values will be set true when the
 /// edge is a cut edge.
 /// \return The number of cut edges.
 template <typename UndirGraph, typename UndirEdgeMap>
 int biEdgeConnectedCutEdges(const UndirGraph& graph, UndirEdgeMap& cutMap) {
 checkConcept<concept::UndirGraph, UndirGraph>();
 ///
 /// \brief Sort the nodes of a DAG into topolgical order.
 ///
 /// Sort the nodes of a DAG into topolgical order.
 ///
-/// \param g The graph. In must be directed and acyclic.
+/// \param graph The graph. It should be directed and acyclic.
-/// \retval comp A writable node map. The values will be set from 0 to
+/// \retval order A writable node map. The values will be set from 0 to
 /// the number of the nodes in the graph minus one. Each values of the map
 /// will be set exactly once, the values  will be set descending order.
 ///
 /// \see checkedTopologicalSort
 /// \see dag
 /// \brief Sort the nodes of a DAG into topolgical order.
 ///
 /// Sort the nodes of a DAG into topolgical order. It also checks
 /// that the given graph is DAG.
 ///
-/// \param g The graph. In must be directed and acyclic.
+/// \param graph The graph. It should be directed and acyclic.
 /// \retval order A readable - writable node map. The values will be set
 /// from 0 to the number of the nodes in the graph minus one. Each values
 /// of the map will be set exactly once, the values will be set descending
 /// order.
 /// \return %False when the graph is not DAG.

changeset 1797	91b8b9cea2f7
parent 1767	58455e2aa13e
child 1800	d391ea416aa0