# HG changeset patch
# User Peter Kovacs <kpeter@inf.elte.hu>
# Date 1227868011 -3600
# Node ID 0a3ec097a76cbf1145826cc6481087773f218fa8
# Parent 24a2c6ee6cb04d24d69e375f14f02d547266f53c
Doc improvements for the DIMACS tools (#167)
The doc group is moved to groups.dox.
diff --git a/doc/groups.dox b/doc/groups.dox
a
|
b
|
|
482 | 482 | */ |
483 | 483 | |
484 | 484 | /** |
| 485 | @defgroup dimacs_group DIMACS format |
| 486 | @ingroup io_group |
| 487 | \brief Read and write files in DIMACS format |
| 488 | |
| 489 | Tools to read a digraph from or write it to a file in DIMACS format data. |
| 490 | */ |
| 491 | |
| 492 | /** |
485 | 493 | @defgroup nauty_group NAUTY Format |
486 | 494 | @ingroup io_group |
487 | 495 | \brief Read \e Nauty format |
| 496 | |
488 | 497 | Tool to read graphs from \e Nauty format data. |
489 | 498 | */ |
490 | 499 | |
diff --git a/lemon/dimacs.h b/lemon/dimacs.h
a
|
b
|
|
31 | 31 | |
32 | 32 | namespace lemon { |
33 | 33 | |
34 | | ///@defgroup dimacs_group DIMACS format |
35 | | ///\brief Read and write files in DIMACS format |
36 | | /// |
37 | | ///Tools to read a digraph from or write it to a file in DIMACS format |
38 | | ///data |
39 | | ///\ingroup io_group |
40 | | |
41 | 34 | /// \addtogroup dimacs_group |
42 | 35 | /// @{ |
43 | | |
44 | 36 | |
45 | 37 | /// DIMACS file type descriptor. |
46 | 38 | struct DimacsDescriptor |
… |
… |
|
52 | 44 | }; |
53 | 45 | ///The file type |
54 | 46 | Type type; |
55 | | ///The number of nodes on the graph |
| 47 | ///The number of nodes in the graph |
56 | 48 | int nodeNum; |
57 | | ///The number of edges on the graph |
| 49 | ///The number of edges in the graph |
58 | 50 | int edgeNum; |
59 | 51 | int lineShift; |
60 | 52 | /// Constructor. Sets the type to NONE. |
… |
… |
|
64 | 56 | ///Discover the type of a DIMACS file |
65 | 57 | |
66 | 58 | ///It starts seeking the begining of the file for the problem type |
67 | | ///and size info. The found date is returned in a special struct |
| 59 | ///and size info. The found data is returned in a special struct |
68 | 60 | ///that can be evaluated and passed to the appropriate reader |
69 | 61 | ///function. |
70 | 62 | DimacsDescriptor dimacsType(std::istream& is) |
… |
… |
|
105 | 97 | |
106 | 98 | |
107 | 99 | |
108 | | /// DIMACS min cost flow reader function. |
| 100 | /// DIMACS minimum cost flow reader function. |
109 | 101 | /// |
110 | | /// This function reads a min cost flow instance from DIMACS format, |
111 | | /// i.e. from DIMACS files having a line starting with |
| 102 | /// This function reads a minimum cost flow instance from DIMACS format, |
| 103 | /// i.e. from a DIMACS file having a line starting with |
112 | 104 | /// \code |
113 | 105 | /// p min |
114 | 106 | /// \endcode |
… |
… |
|
230 | 222 | } |
231 | 223 | } |
232 | 224 | |
233 | | /// DIMACS max flow reader function. |
| 225 | /// DIMACS maximum flow reader function. |
234 | 226 | /// |
235 | | /// This function reads a max flow instance from DIMACS format, |
236 | | /// i.e. from DIMACS files having a line starting with |
| 227 | /// This function reads a maximum flow instance from DIMACS format, |
| 228 | /// i.e. from a DIMACS file having a line starting with |
237 | 229 | /// \code |
238 | 230 | /// p max |
239 | 231 | /// \endcode |
… |
… |
|
259 | 251 | /// DIMACS shortest path reader function. |
260 | 252 | /// |
261 | 253 | /// This function reads a shortest path instance from DIMACS format, |
262 | | /// i.e. from DIMACS files having a line starting with |
| 254 | /// i.e. from a DIMACS file having a line starting with |
263 | 255 | /// \code |
264 | 256 | /// p sp |
265 | 257 | /// \endcode |
266 | 258 | /// At the beginning, \c g is cleared by \c g.clear(). The arc |
267 | | /// lengths are written to \c lenght and \c s is set to the |
| 259 | /// lengths are written to \c length and \c s is set to the |
268 | 260 | /// source node. |
269 | 261 | /// |
270 | 262 | /// If the file type was previously evaluated by dimacsType(), then |