1.1 --- a/doc/groups.dox Fri Nov 28 06:38:20 2008 +0000
1.2 +++ b/doc/groups.dox Fri Nov 28 11:26:51 2008 +0100
1.3 @@ -482,9 +482,18 @@
1.4 */
1.5
1.6 /**
1.7 +@defgroup dimacs_group DIMACS format
1.8 +@ingroup io_group
1.9 +\brief Read and write files in DIMACS format
1.10 +
1.11 +Tools to read a digraph from or write it to a file in DIMACS format data.
1.12 +*/
1.13 +
1.14 +/**
1.15 @defgroup nauty_group NAUTY Format
1.16 @ingroup io_group
1.17 \brief Read \e Nauty format
1.18 +
1.19 Tool to read graphs from \e Nauty format data.
1.20 */
1.21
2.1 --- a/lemon/dimacs.h Fri Nov 28 06:38:20 2008 +0000
2.2 +++ b/lemon/dimacs.h Fri Nov 28 11:26:51 2008 +0100
2.3 @@ -31,17 +31,9 @@
2.4
2.5 namespace lemon {
2.6
2.7 - ///@defgroup dimacs_group DIMACS format
2.8 - ///\brief Read and write files in DIMACS format
2.9 - ///
2.10 - ///Tools to read a digraph from or write it to a file in DIMACS format
2.11 - ///data
2.12 - ///\ingroup io_group
2.13 -
2.14 /// \addtogroup dimacs_group
2.15 /// @{
2.16
2.17 -
2.18 /// DIMACS file type descriptor.
2.19 struct DimacsDescriptor
2.20 {
2.21 @@ -52,9 +44,9 @@
2.22 };
2.23 ///The file type
2.24 Type type;
2.25 - ///The number of nodes on the graph
2.26 + ///The number of nodes in the graph
2.27 int nodeNum;
2.28 - ///The number of edges on the graph
2.29 + ///The number of edges in the graph
2.30 int edgeNum;
2.31 int lineShift;
2.32 /// Constructor. Sets the type to NONE.
2.33 @@ -64,7 +56,7 @@
2.34 ///Discover the type of a DIMACS file
2.35
2.36 ///It starts seeking the begining of the file for the problem type
2.37 - ///and size info. The found date is returned in a special struct
2.38 + ///and size info. The found data is returned in a special struct
2.39 ///that can be evaluated and passed to the appropriate reader
2.40 ///function.
2.41 DimacsDescriptor dimacsType(std::istream& is)
2.42 @@ -105,10 +97,10 @@
2.43
2.44
2.45
2.46 - /// DIMACS min cost flow reader function.
2.47 + /// DIMACS minimum cost flow reader function.
2.48 ///
2.49 - /// This function reads a min cost flow instance from DIMACS format,
2.50 - /// i.e. from DIMACS files having a line starting with
2.51 + /// This function reads a minimum cost flow instance from DIMACS format,
2.52 + /// i.e. from a DIMACS file having a line starting with
2.53 /// \code
2.54 /// p min
2.55 /// \endcode
2.56 @@ -230,10 +222,10 @@
2.57 }
2.58 }
2.59
2.60 - /// DIMACS max flow reader function.
2.61 + /// DIMACS maximum flow reader function.
2.62 ///
2.63 - /// This function reads a max flow instance from DIMACS format,
2.64 - /// i.e. from DIMACS files having a line starting with
2.65 + /// This function reads a maximum flow instance from DIMACS format,
2.66 + /// i.e. from a DIMACS file having a line starting with
2.67 /// \code
2.68 /// p max
2.69 /// \endcode
2.70 @@ -259,12 +251,12 @@
2.71 /// DIMACS shortest path reader function.
2.72 ///
2.73 /// This function reads a shortest path instance from DIMACS format,
2.74 - /// i.e. from DIMACS files having a line starting with
2.75 + /// i.e. from a DIMACS file having a line starting with
2.76 /// \code
2.77 /// p sp
2.78 /// \endcode
2.79 /// At the beginning, \c g is cleared by \c g.clear(). The arc
2.80 - /// lengths are written to \c lenght and \c s is set to the
2.81 + /// lengths are written to \c length and \c s is set to the
2.82 /// source node.
2.83 ///
2.84 /// If the file type was previously evaluated by dimacsType(), then