LEMON/LEMON-official Changeset - r1023:e0cef67fe565

Repositories » LEMON » LEMON-official

Changeset - r1023:e0cef67fe565

« 1022:8583fb

1024:745312 »

r1023:e0cef67fe565

Sun, 09 Jan 2011 16:51:14

[Not Reviewed]

0 comments (0 inline)

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

Various doc improvements (#406)

0 8 0

default

8 files changed with 31 insertions and 27 deletions:

doc/coding_style.dox

doc/groups.dox

lemon/capacity_scaling.h

lemon/core.h

lemon/cost_scaling.h

lemon/cycle_canceling.h

lemon/euler.h

lemon/network_simplex.h

↑ Collapse diff ↑

doc/coding_style.dox

Show inline comments

@@ -100,6 +100,6 @@
 		Private member variables should start with underscore
+		Private member variables should start with underscore.
 		\code
-		_start_with_underscores
+		_start_with_underscore
 		\endcode

doc/groups.dox

Show inline comments

@@ -408,6 +408,6 @@
 		In general NetworkSimplex is the most efficient implementation,
 		but in special cases other algorithms could be faster.
 		In general, \ref NetworkSimplex and \ref CostScaling are the most efficient
 		implementations, but the other two algorithms could be faster in special cases.
 		For example, if the total supply and/or capacities are rather small,
 		CapacityScaling is usually the fastest algorithm (without effective scaling).
+		\ref CapacityScaling is usually the fastest algorithm (without effective scaling).
 		*/
@@ -473,3 +473,3 @@
-		In practice, the \ref HowardMmc "Howard" algorithm proved to be by far the
+		In practice, the \ref HowardMmc "Howard" algorithm turned out to be by far the
 		most efficient one, though the best known theoretical bound on its running
@@ -541,3 +541,3 @@
 		/**
-		@defgroup planar Planarity Embedding and Drawing
+		@defgroup planar Planar Embedding and Drawing
 		@ingroup algs

lemon/capacity_scaling.h

Show inline comments

@@ -90,4 +90,4 @@
 		  /// be integer.
 		  /// \warning This algorithm does not support negative costs for such
 		  /// arcs that have infinite upper bound.
 		  /// \warning This algorithm does not support negative costs for
 		  /// arcs having infinite upper bound.
 		#ifdef DOXYGEN
@@ -424,3 +424,3 @@
 		    /// Using this function has the same effect as using \ref supplyMap()
-		    /// with such a map in which \c k is assigned to \c s, \c -k is
 		    /// with a map in which \c k is assigned to \c s, \c -k is
 		    /// assigned to \c t and all other nodes have zero supply value.

lemon/core.h

Show inline comments

@@ -449,3 +449,3 @@
 		  /// Check whether a graph is undirected.
+		  /// \brief Check whether a graph is undirected.
 		  ///

lemon/cost_scaling.h

Show inline comments

@@ -99,2 +99,5 @@
 		  ///
 		  /// In general, \ref NetworkSimplex and \ref CostScaling are the fastest
 		  /// implementations available in LEMON for this problem.
 		  ///
 		  /// Most of the parameters of the problem (except for the digraph)
@@ -117,4 +120,4 @@
 		  /// be integer.
 		  /// \warning This algorithm does not support negative costs for such
 		  /// arcs that have infinite upper bound.
 		  /// \warning This algorithm does not support negative costs for
 		  /// arcs having infinite upper bound.
 		  ///
@@ -180,3 +183,3 @@
 		    /// By default, the so called \ref PARTIAL_AUGMENT
-		    /// "Partial Augment-Relabel" method is used, which proved to be
+		    /// "Partial Augment-Relabel" method is used, which turned out to be
 		    /// the most efficient and the most robust on various test inputs.
@@ -449,3 +452,3 @@
 		    /// Using this function has the same effect as using \ref supplyMap()
-		    /// with such a map in which \c k is assigned to \c s, \c -k is
 		    /// with a map in which \c k is assigned to \c s, \c -k is
 		    /// assigned to \c t and all other nodes have zero supply value.

lemon/cycle_canceling.h

Show inline comments

@@ -69,4 +69,4 @@
 		  /// be integer.
 		  /// \warning This algorithm does not support negative costs for such
 		  /// arcs that have infinite upper bound.
 		  /// \warning This algorithm does not support negative costs for
 		  /// arcs having infinite upper bound.
 		  ///
@@ -118,4 +118,3 @@
 		    /// methods. By default, \ref CANCEL_AND_TIGHTEN "Cancel and Tighten"
 		    /// is used, which proved to be the most efficient and the most robust
 		    /// on various test inputs.
 		    /// is used, which is by far the most efficient and the most robust.
 		    /// However, the other methods can be selected using the \ref run()
@@ -351,3 +350,3 @@
 		    /// Using this function has the same effect as using \ref supplyMap()
-		    /// with such a map in which \c k is assigned to \c s, \c -k is
 		    /// with a map in which \c k is assigned to \c s, \c -k is
 		    /// assigned to \c t and all other nodes have zero supply value.

lemon/euler.h

Show inline comments

@@ -38,3 +38,3 @@
-		  /// \ingroup graph_prop
+		  /// \ingroup graph_properties
 		  ///This iterator provides an Euler tour (Eulerian circuit) of a \e directed

lemon/network_simplex.h

Show inline comments

@@ -49,6 +49,6 @@
 		  ///
 		  /// In general, %NetworkSimplex is the fastest implementation available
 		  /// in LEMON for this problem.
 		  /// Moreover, it supports both directions of the supply/demand inequality
 		  /// constraints. For more information, see \ref SupplyType.
 		  /// In general, \ref NetworkSimplex and \ref CostScaling are the fastest
 		  /// implementations available in LEMON for this problem.
 		  /// Furthermore, this class supports both directions of the supply/demand
 		  /// inequality constraints. For more information, see \ref SupplyType.
 		  ///
@@ -127,3 +127,3 @@
 		    /// By default, \ref BLOCK_SEARCH "Block Search" is used, which
-		    /// proved to be the most efficient and the most robust on various
+		    /// turend out to be the most efficient and the most robust on various
 		    /// test inputs.
@@ -736,2 +736,4 @@
 		    /// \return <tt>(*this)</tt>
 		    ///
 		    /// \sa supplyType()
 		    template<typename SupplyMap>
@@ -752,3 +754,3 @@
 		    /// Using this function has the same effect as using \ref supplyMap()
-		    /// with such a map in which \c k is assigned to \c s, \c -k is
 		    /// with a map in which \c k is assigned to \c s, \c -k is
 		    /// assigned to \c t and all other nodes have zero supply value.

0 comments (0 inline)

RhodeCode