1.1 --- a/lemon/dimacs.h Fri Nov 28 06:38:20 2008 +0000
1.2 +++ b/lemon/dimacs.h Fri Nov 28 11:26:51 2008 +0100
1.3 @@ -31,17 +31,9 @@
1.4
1.5 namespace lemon {
1.6
1.7 - ///@defgroup dimacs_group DIMACS format
1.8 - ///\brief Read and write files in DIMACS format
1.9 - ///
1.10 - ///Tools to read a digraph from or write it to a file in DIMACS format
1.11 - ///data
1.12 - ///\ingroup io_group
1.13 -
1.14 /// \addtogroup dimacs_group
1.15 /// @{
1.16
1.17 -
1.18 /// DIMACS file type descriptor.
1.19 struct DimacsDescriptor
1.20 {
1.21 @@ -52,9 +44,9 @@
1.22 };
1.23 ///The file type
1.24 Type type;
1.25 - ///The number of nodes on the graph
1.26 + ///The number of nodes in the graph
1.27 int nodeNum;
1.28 - ///The number of edges on the graph
1.29 + ///The number of edges in the graph
1.30 int edgeNum;
1.31 int lineShift;
1.32 /// Constructor. Sets the type to NONE.
1.33 @@ -64,7 +56,7 @@
1.34 ///Discover the type of a DIMACS file
1.35
1.36 ///It starts seeking the begining of the file for the problem type
1.37 - ///and size info. The found date is returned in a special struct
1.38 + ///and size info. The found data is returned in a special struct
1.39 ///that can be evaluated and passed to the appropriate reader
1.40 ///function.
1.41 DimacsDescriptor dimacsType(std::istream& is)
1.42 @@ -105,10 +97,10 @@
1.43
1.44
1.45
1.46 - /// DIMACS min cost flow reader function.
1.47 + /// DIMACS minimum cost flow reader function.
1.48 ///
1.49 - /// This function reads a min cost flow instance from DIMACS format,
1.50 - /// i.e. from DIMACS files having a line starting with
1.51 + /// This function reads a minimum cost flow instance from DIMACS format,
1.52 + /// i.e. from a DIMACS file having a line starting with
1.53 /// \code
1.54 /// p min
1.55 /// \endcode
1.56 @@ -230,10 +222,10 @@
1.57 }
1.58 }
1.59
1.60 - /// DIMACS max flow reader function.
1.61 + /// DIMACS maximum flow reader function.
1.62 ///
1.63 - /// This function reads a max flow instance from DIMACS format,
1.64 - /// i.e. from DIMACS files having a line starting with
1.65 + /// This function reads a maximum flow instance from DIMACS format,
1.66 + /// i.e. from a DIMACS file having a line starting with
1.67 /// \code
1.68 /// p max
1.69 /// \endcode
1.70 @@ -259,12 +251,12 @@
1.71 /// DIMACS shortest path reader function.
1.72 ///
1.73 /// This function reads a shortest path instance from DIMACS format,
1.74 - /// i.e. from DIMACS files having a line starting with
1.75 + /// i.e. from a DIMACS file having a line starting with
1.76 /// \code
1.77 /// p sp
1.78 /// \endcode
1.79 /// At the beginning, \c g is cleared by \c g.clear(). The arc
1.80 - /// lengths are written to \c lenght and \c s is set to the
1.81 + /// lengths are written to \c length and \c s is set to the
1.82 /// source node.
1.83 ///
1.84 /// If the file type was previously evaluated by dimacsType(), then