LEMON/LEMON-official Changeset - r1023:e0cef67fe565

Repositories » LEMON » LEMON-official

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

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 32 insertions and 28 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

@@ -99,8 +99,8 @@
 		\subsection pri-loc-var Private member variables
 		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

@@ -407,8 +407,8 @@
 		   strongly polynomial \ref klein67primal, \ref goldberg89cyclecanceling.
 		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).
 		*/
@@ -472,5 +472,5 @@
 		  \ref dasdan98minmeancycle.
-		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
 		time is exponential.
@@ -540,5 +540,5 @@
 		/**
-		@defgroup planar Planarity Embedding and Drawing
+		@defgroup planar Planar Embedding and Drawing
 		@ingroup algs
 		\brief Algorithms for planarity checking, embedding and drawing

lemon/capacity_scaling.h

Show inline comments

@@ -89,6 +89,6 @@
 		  /// \warning Both number types must be signed and all input data must
 		  /// 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
 		  template <typename GR, typename V, typename C, typename TR>
@@ -423,5 +423,5 @@
 		    ///
 		    /// 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

@@ -448,5 +448,5 @@
+		  }
 		  /// Check whether a graph is undirected.
+		  /// \brief Check whether a graph is undirected.
 		  ///
 		  /// This function returns \c true if the given graph is undirected.

lemon/cost_scaling.h

Show inline comments

@@ -98,4 +98,7 @@
 		  /// "preflow push-relabel" algorithm for the maximum flow problem.
 		  ///
 		  /// 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)
 		  /// can be given using separate functions, and the algorithm can be
@@ -116,6 +119,6 @@
 		  /// \warning Both number types must be signed and all input data must
 		  /// 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.
 		  ///
 		  /// \note %CostScaling provides three different internal methods,
@@ -179,5 +182,5 @@
 		    /// relabel operation.
 		    /// 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.
 		    /// However, the other methods can be selected using the \ref run()
@@ -448,5 +451,5 @@
 		    ///
 		    /// 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

@@ -68,6 +68,6 @@
 		  /// \warning Both number types must be signed and all input data must
 		  /// 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.
 		  ///
 		  /// \note For more information about the three available methods,
@@ -117,6 +117,5 @@
 		    /// \ref CycleCanceling provides three different cycle-canceling
 		    /// 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()
 		    /// function with the proper parameter.
@@ -350,5 +349,5 @@
 		    ///
 		    /// 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

@@ -37,5 +37,5 @@
 		  ///Euler tour iterator for digraphs.
-		  /// \ingroup graph_prop
+		  /// \ingroup graph_properties
 		  ///This iterator provides an Euler tour (Eulerian circuit) of a \e directed
 		  ///graph (if there exists) and it converts to the \c Arc type of the digraph.

lemon/network_simplex.h

Show inline comments

@@ -48,8 +48,8 @@
 		  /// flow problem.
 		  ///
 		  /// 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.
 		  ///
 		  /// Most of the parameters of the problem (except for the digraph)
@@ -126,5 +126,5 @@
 		    /// of the algorithm.
 		    /// 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.
 		    /// However, another pivot rule can be selected using the \ref run()
@@ -168,5 +168,5 @@
 		    typedef std::vector<Cost> CostVector;
 		    typedef std::vector<signed char> CharVector;
-		    // Note: vector<signed char> is used instead of vector<ArcState> and
 		    // Note: vector<signed char> is used instead of vector<ArcState> and
 		    // vector<ArcDirection> for efficiency reasons
@@ -735,4 +735,6 @@
 		    ///
 		    /// \return <tt>(*this)</tt>
 		    ///
 		    /// \sa supplyType()
 		    template<typename SupplyMap>
 		    NetworkSimplex& supplyMap(const SupplyMap& map) {
@@ -751,5 +753,5 @@
 		    ///
 		    /// 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

Login to your account