LEMON/LEMON-official Changeset - r834:c2230649a493

Repositories » LEMON » LEMON-official

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r834:c2230649a493

« 831:1a7fe3

835:c92296 »

r834:c2230649a493

Sun, 15 Nov 2009 19:57:02

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

Various doc improvements (#331) - Add notes to the graph classes about the time of item counting. - Clarify the doc for run() in BFS and DFS. - Other improvements.

0 11 0

default

11 files changed with 93 insertions and 43 deletions:

lemon/adaptors.h

lemon/bfs.h

lemon/dfs.h

lemon/dijkstra.h

lemon/edge_set.h

lemon/full_graph.h

lemon/grid_graph.h

lemon/hypercube_graph.h

lemon/list_graph.h

lemon/smart_graph.h

lemon/static_graph.h

↑ Collapse diff ↑

0 comments (0 inline)

@@ -362,2 +362,5 @@
 		  ///
 		  /// This class provides item counting in the same time as the adapted
 		  /// digraph structure.
 		  ///
 		  /// \tparam DGR The type of the adapted digraph.
@@ -721,2 +724,4 @@
 		  ///
 		  /// This class provides only linear time counting for nodes and arcs.
 		  ///
 		  /// \tparam DGR The type of the adapted digraph.
@@ -1316,2 +1321,4 @@
 		  ///
 		  /// This class provides only linear time counting for nodes, edges and arcs.
 		  ///
 		  /// \tparam GR The type of the adapted graph.
@@ -1473,2 +1480,4 @@
 		  ///
 		  /// This class provides only linear time item counting.
 		  ///
 		  /// \tparam GR The type of the adapted digraph or graph.
@@ -1621,2 +1630,4 @@
 		  ///
 		  /// This class provides only linear time counting for nodes and arcs.
 		  ///
 		  /// \tparam DGR The type of the adapted digraph.
@@ -1731,2 +1742,4 @@
 		  ///
 		  /// This class provides only linear time counting for nodes, edges and arcs.
 		  ///
 		  /// \tparam GR The type of the adapted graph.
@@ -2234,2 +2247,5 @@
 		  ///
 		  /// This class provides item counting in the same time as the adapted
 		  /// digraph structure.
 		  ///
 		  /// \tparam DGR The type of the adapted digraph.
@@ -2537,2 +2553,5 @@
 		  ///
 		  /// This class provides item counting in the same time as the adapted
 		  /// graph structure.
 		  ///
 		  /// \tparam GR The type of the adapted graph.
@@ -2680,2 +2699,4 @@
 		  ///
 		  /// This class provides only linear time counting for nodes and arcs.
 		  ///
 		  /// \tparam DGR The type of the adapted digraph.
@@ -3327,2 +3348,5 @@
 		  ///
 		  /// This class provides item counting in the same time as the adapted
 		  /// digraph structure.
 		  ///
 		  /// \tparam DGR The type of the adapted digraph.

@@ -703,8 +703,4 @@
 		    ///This method runs the %BFS algorithm in order to
 		    ///compute the shortest path to each node.
 		    ///
 		    ///The algorithm computes
 		    ///- the shortest path tree (forest),
 		    ///- the distance of each node from the root(s).
 		    ///This method runs the %BFS algorithm in order to visit all nodes
 		    ///in the digraph.
 		    ///
@@ -1048,4 +1044,4 @@
 		    ///This method runs BFS algorithm in order to compute
 		    ///the shortest path to each node.
 		    ///This method runs BFS algorithm in order to visit all nodes
 		    ///in the digraph.
 		    void run()
@@ -1697,8 +1693,4 @@
 		    ///
 		    /// This method runs the %BFS algorithm in order to
 		    /// compute the shortest path to each node.
 		    ///
 		    /// The algorithm computes
 		    /// - the shortest path tree (forest),
 		    /// - the distance of each node from the root(s).
 		    /// This method runs the %BFS algorithm in order to visit all nodes
 		    /// in the digraph.
 		    ///

@@ -635,8 +635,4 @@
 		    ///This method runs the %DFS algorithm in order to compute the
 		    ///%DFS path to each node.
 		    ///
 		    ///The algorithm computes
 		    ///- the %DFS tree (forest),
 		    ///- the distance of each node from the root(s) in the %DFS tree.
 		    ///This method runs the %DFS algorithm in order to visit all nodes
 		    ///in the digraph.
 		    ///
@@ -978,4 +974,4 @@
 		    ///This method runs DFS algorithm in order to compute
 		    ///the DFS path to each node.
 		    ///This method runs DFS algorithm in order to visit all nodes
 		    ///in the digraph.
 		    void run()
@@ -1580,8 +1576,4 @@
 		    /// This method runs the %DFS algorithm in order to
 		    /// compute the %DFS path to each node.
 		    ///
 		    /// The algorithm computes
 		    /// - the %DFS tree (forest),
 		    /// - the distance of each node from the root(s) in the %DFS tree.
 		    /// This method runs the %DFS algorithm in order to visit all nodes
 		    /// in the digraph.
 		    ///

@@ -208,3 +208,3 @@
 		    ///The type of the arc lengths.
-		    typedef typename TR::LengthMap::Value Value;
 		    typedef typename TR::Value Value;
 		    ///The type of the map that stores the arc lengths.

@@ -257,2 +257,6 @@
 		  ///
 		  /// This class fully conforms to the \ref concepts::Digraph
 		  /// "Digraph" concept.
 		  /// It provides only linear time counting for nodes and arcs.
 		  ///
 		  /// \param GR The type of the graph which shares its node set with
@@ -261,5 +265,2 @@
 		  /// concept.
 		  ///
 		  /// This class fully conforms to the \ref concepts::Digraph
 		  /// "Digraph" concept.
 		  template <typename GR>
@@ -687,2 +688,6 @@
 		  ///
 		  /// This class fully conforms to the \ref concepts::Graph "Graph"
 		  /// concept.
 		  /// It provides only linear time counting for nodes, edges and arcs.
 		  ///
 		  /// \param GR The type of the graph which shares its node set
@@ -691,5 +696,2 @@
 		  /// concept.
 		  ///
 		  /// This class fully conforms to the \ref concepts::Graph "Graph"
 		  /// concept.
 		  template <typename GR>
@@ -956,2 +958,6 @@
 		  ///
 		  /// This class fully conforms to the \ref concepts::Digraph "Digraph"
 		  /// concept.
 		  /// It provides only linear time counting for nodes and arcs.
 		  ///
 		  /// \warning If a node is erased from the underlying graph and this
@@ -960,5 +966,2 @@
 		  /// validity can be checked with the \c valid() member function.
 		  ///
 		  /// This class fully conforms to the \ref concepts::Digraph
 		  /// "Digraph" concept.
 		  template <typename GR>
@@ -1306,2 +1309,6 @@
 		  ///
 		  /// This class fully conforms to the \ref concepts::Graph "Graph"
 		  /// concept.
 		  /// It provides only linear time counting for nodes, edges and arcs.
 		  ///
 		  /// \warning If a node is erased from the underlying graph and this
@@ -1310,5 +1317,2 @@
 		  /// be checked with the \c valid() member function.
 		  ///
 		  /// This class fully conforms to the \ref concepts::Graph
 		  /// "Graph" concept.
 		  template <typename GR>

RhodeCode

Login to your account

@@ -164,2 +164,4 @@
 		  ///
 		  /// This class provides constant time counting for nodes and arcs.
 		  ///
 		  /// \note FullDigraph and FullGraph classes are very similar,
@@ -206,2 +208,3 @@
 		    /// the range <tt>[0..nodeNum()-1]</tt>.
 		    /// The index of a node is the same as its ID.
 		    /// \sa index()
@@ -214,2 +217,3 @@
 		    /// the range <tt>[0..nodeNum()-1]</tt>.
 		    /// The index of a node is the same as its ID.
 		    /// \sa operator()()
@@ -537,2 +541,4 @@
 		  ///
 		  /// This class provides constant time counting for nodes, edges and arcs.
 		  ///
 		  /// \note FullDigraph and FullGraph classes are very similar,
@@ -581,2 +587,3 @@
 		    /// the range <tt>[0..nodeNum()-1]</tt>.
 		    /// The index of a node is the same as its ID.
 		    /// \sa index()
@@ -589,2 +596,3 @@
 		    /// the range <tt>[0..nodeNum()-1]</tt>.
 		    /// The index of a node is the same as its ID.
 		    /// \sa operator()()

@@ -505,2 +505,4 @@
 		  /// only in the concept class.
 		  ///
 		  /// This class provides constant time counting for nodes, edges and arcs.
 		  class GridGraph : public ExtendedGridGraphBase {

@@ -296,2 +296,4 @@
 		  ///
 		  /// This class provides constant time counting for nodes, edges and arcs.
 		  ///
 		  /// \note The type of the indices is chosen to \c int for efficiency

@@ -326,2 +326,4 @@
 		  ///
 		  ///This class provides only linear time counting for nodes and arcs.
 		  ///
 		  ///\sa concepts::Digraph
@@ -362,3 +364,7 @@
 		    ///
-		    ///This function erases the given node from the digraph.
+		    ///This function erases the given node along with its outgoing and
 		    ///incoming arcs from the digraph.
 		    ///
 		    ///\note All iterators referencing the removed node or the connected
 		    ///arcs are invalidated, of course.
 		    void erase(Node n) { Parent::erase(n); }
@@ -368,2 +374,5 @@
 		    ///This function erases the given arc from the digraph.
 		    ///
 		    ///\note All iterators referencing the removed arc are invalidated,
 		    ///of course.
 		    void erase(Arc a) { Parent::erase(a); }
@@ -512,2 +521,3 @@
 		    ///
 		    ///\note All iterators of the digraph are invalidated, of course.
 		    void clear() {
@@ -1181,2 +1191,4 @@
 		  ///
 		  ///This class provides only linear time counting for nodes, edges and arcs.
 		  ///
 		  ///\sa concepts::Graph
@@ -1219,3 +1231,7 @@
 		    ///
-		    /// This function erases the given node from the graph.
+		    /// This function erases the given node along with its incident arcs
 		    /// from the graph.
 		    ///
 		    /// \note All iterators referencing the removed node or the incident
 		    /// edges are invalidated, of course.
 		    void erase(Node n) { Parent::erase(n); }
@@ -1225,2 +1241,5 @@
 		    /// This function erases the given edge from the graph.
 		    ///
 		    /// \note All iterators referencing the removed edge are invalidated,
 		    /// of course.
 		    void erase(Edge e) { Parent::erase(e); }
@@ -1314,2 +1333,3 @@
 		    ///
 		    ///\note All iterators of the graph are invalidated, of course.
 		    void clear() {

@@ -196,2 +196,4 @@
 		  ///
 		  ///This class provides constant time counting for nodes and arcs.
 		  ///
 		  ///\sa concepts::Digraph
@@ -622,2 +624,4 @@
 		  ///
 		  /// This class provides constant time counting for nodes, edges and arcs.
 		  ///
 		  /// \sa concepts::Graph

@@ -294,2 +294,4 @@
 		  ///
 		  /// This class provides constant time counting for nodes and arcs.
 		  ///
 		  /// \sa concepts::Digraph