Changeset 192:7bf5f97d574f in lemon-main for lemon/lgf_writer.h
- Timestamp:
- 07/05/08 00:14:27 (16 years ago)
- Branch:
- default
- Phase:
- public
- File:
-
- 1 edited
-
lemon/lgf_writer.h (modified) (27 diffs)
Legend:
- Unmodified
- Added
- Removed
-
lemon/lgf_writer.h
r190 r192 19 19 ///\ingroup lemon_io 20 20 ///\file 21 ///\brief Lemon Graph Formatwriter.21 ///\brief \ref lgf-format "Lemon Graph Format" writer. 22 22 23 23 … … 323 323 /// \ingroup lemon_io 324 324 /// 325 /// \brief LGFwriter for directed graphs325 /// \brief \ref lgf-format "LGF" writer for directed graphs 326 326 /// 327 327 /// This utility writes an \ref lgf-format "LGF" file. … … 333 333 /// with the \c nodeMap() or \c arcMap() members. An optional 334 334 /// converter parameter can also be added as a standard functor 335 /// converting from the value type of the map to std::string. If it336 /// is set, it will determine how the map's value typeis written to335 /// converting from the value type of the map to \c std::string. If it 336 /// is set, it will determine how the value type of the map is written to 337 337 /// the output stream. If the functor is not set, then a default 338 338 /// conversion will be used. The \c attribute(), \c node() and \c … … 340 340 /// 341 341 ///\code 342 /// 343 /// 344 /// 345 /// 346 /// 347 /// 348 /// 349 /// 350 /// 342 /// DigraphWriter<Digraph>(std::cout, digraph). 343 /// nodeMap("coordinates", coord_map). 344 /// nodeMap("size", size). 345 /// nodeMap("title", title). 346 /// arcMap("capacity", cap_map). 347 /// node("source", src). 348 /// node("target", trg). 349 /// attribute("caption", caption). 350 /// run(); 351 351 ///\endcode 352 352 /// … … 487 487 /// @{ 488 488 489 /// \brief Node map reading rule490 /// 491 /// Add a node map reading rule to the writer.489 /// \brief Node map writing rule 490 /// 491 /// Add a node map writing rule to the writer. 492 492 template <typename Map> 493 493 DigraphWriter& nodeMap(const std::string& caption, const Map& map) { … … 587 587 } 588 588 589 /// \name Se lect section by name589 /// \name Section captions 590 590 /// @{ 591 591 592 /// \brief Set \c \@nodes section to be read593 /// 594 /// Set \c \@nodes section to be read592 /// \brief Add an additional caption to the \c \@nodes section 593 /// 594 /// Add an additional caption to the \c \@nodes section. 595 595 DigraphWriter& nodes(const std::string& caption) { 596 596 _nodes_caption = caption; … … 598 598 } 599 599 600 /// \brief Set \c \@arcs section to be read601 /// 602 /// Set \c \@arcs section to be read600 /// \brief Add an additional caption to the \c \@arcs section 601 /// 602 /// Add an additional caption to the \c \@arcs section. 603 603 DigraphWriter& arcs(const std::string& caption) { 604 604 _arcs_caption = caption; … … 606 606 } 607 607 608 /// \brief Set \c \@attributes section to be read609 /// 610 /// Set \c \@attributes section to be read608 /// \brief Add an additional caption to the \c \@attributes section 609 /// 610 /// Add an additional caption to the \c \@attributes section. 611 611 DigraphWriter& attributes(const std::string& caption) { 612 612 _attributes_caption = caption; … … 619 619 /// \brief Skip writing the node set 620 620 /// 621 /// The \c \@nodes section will be notwritten to the stream.621 /// The \c \@nodes section will not be written to the stream. 622 622 DigraphWriter& skipNodes() { 623 623 LEMON_ASSERT(!_skip_nodes, "Multiple usage of skipNodes() member"); … … 628 628 /// \brief Skip writing arc set 629 629 /// 630 /// The \c \@arcs section will be notwritten to the stream.630 /// The \c \@arcs section will not be written to the stream. 631 631 DigraphWriter& skipArcs() { 632 632 LEMON_ASSERT(!_skip_arcs, "Multiple usage of skipArcs() member"); … … 836 836 /// \brief Start the batch processing 837 837 /// 838 /// This function starts the batch processing 838 /// This function starts the batch processing. 839 839 void run() { 840 840 if (!_skip_nodes) { … … 851 851 } 852 852 853 /// \brief Give sback the stream of the writer854 /// 855 /// Give s back the stream of the writer853 /// \brief Give back the stream of the writer 854 /// 855 /// Give back the stream of the writer. 856 856 std::ostream& ostream() { 857 857 return *_os; … … 861 861 }; 862 862 863 /// \brief Return a \ref DigraphWriter class 864 /// 865 /// This function just returns a \ref DigraphWriter class. 863 866 /// \relates DigraphWriter 864 867 template <typename Digraph> … … 869 872 } 870 873 874 /// \brief Return a \ref DigraphWriter class 875 /// 876 /// This function just returns a \ref DigraphWriter class. 871 877 /// \relates DigraphWriter 872 878 template <typename Digraph> … … 877 883 } 878 884 885 /// \brief Return a \ref DigraphWriter class 886 /// 887 /// This function just returns a \ref DigraphWriter class. 879 888 /// \relates DigraphWriter 880 889 template <typename Digraph> … … 899 908 /// \ingroup lemon_io 900 909 /// 901 /// \brief LGFwriter for directed graphs910 /// \brief \ref lgf-format "LGF" writer for directed graphs 902 911 /// 903 912 /// This utility writes an \ref lgf-format "LGF" file. 913 /// 914 /// It can be used almost the same way as \c DigraphWriter. 915 /// The only difference is that this class can handle edges and 916 /// edge maps as well as arcs and arc maps. 904 917 template <typename _Graph> 905 918 class GraphWriter { … … 1024 1037 /// @{ 1025 1038 1026 /// \brief Node map reading rule1027 /// 1028 /// Add a node map reading rule to the writer.1039 /// \brief Node map writing rule 1040 /// 1041 /// Add a node map writing rule to the writer. 1029 1042 template <typename Map> 1030 1043 GraphWriter& nodeMap(const std::string& caption, const Map& map) { … … 1170 1183 } 1171 1184 1172 /// \name Se lect section by name1185 /// \name Section captions 1173 1186 /// @{ 1174 1187 1175 /// \brief Set \c \@nodes section to be read1176 /// 1177 /// Set \c \@nodes section to be read1188 /// \brief Add an additional caption to the \c \@nodes section 1189 /// 1190 /// Add an additional caption to the \c \@nodes section. 1178 1191 GraphWriter& nodes(const std::string& caption) { 1179 1192 _nodes_caption = caption; … … 1181 1194 } 1182 1195 1183 /// \brief Set \c \@edges section to be read1184 /// 1185 /// Set \c \@edges section to be read1196 /// \brief Add an additional caption to the \c \@arcs section 1197 /// 1198 /// Add an additional caption to the \c \@arcs section. 1186 1199 GraphWriter& edges(const std::string& caption) { 1187 1200 _edges_caption = caption; … … 1189 1202 } 1190 1203 1191 /// \brief Set \c \@attributes section to be read1192 /// 1193 /// Set \c \@attributes section to be read1204 /// \brief Add an additional caption to the \c \@attributes section 1205 /// 1206 /// Add an additional caption to the \c \@attributes section. 1194 1207 GraphWriter& attributes(const std::string& caption) { 1195 1208 _attributes_caption = caption; … … 1202 1215 /// \brief Skip writing the node set 1203 1216 /// 1204 /// The \c \@nodes section will be notwritten to the stream.1217 /// The \c \@nodes section will not be written to the stream. 1205 1218 GraphWriter& skipNodes() { 1206 1219 LEMON_ASSERT(!_skip_nodes, "Multiple usage of skipNodes() member"); … … 1211 1224 /// \brief Skip writing edge set 1212 1225 /// 1213 /// The \c \@edges section will be notwritten to the stream.1226 /// The \c \@edges section will not be written to the stream. 1214 1227 GraphWriter& skipEdges() { 1215 1228 LEMON_ASSERT(!_skip_edges, "Multiple usage of skipEdges() member"); … … 1419 1432 /// \brief Start the batch processing 1420 1433 /// 1421 /// This function starts the batch processing 1434 /// This function starts the batch processing. 1422 1435 void run() { 1423 1436 if (!_skip_nodes) { … … 1434 1447 } 1435 1448 1436 /// \brief Give sback the stream of the writer1437 /// 1438 /// Give sback the stream of the writer1449 /// \brief Give back the stream of the writer 1450 /// 1451 /// Give back the stream of the writer 1439 1452 std::ostream& ostream() { 1440 1453 return *_os; … … 1444 1457 }; 1445 1458 1459 /// \brief Return a \ref GraphWriter class 1460 /// 1461 /// This function just returns a \ref GraphWriter class. 1446 1462 /// \relates GraphWriter 1447 1463 template <typename Graph> … … 1451 1467 } 1452 1468 1469 /// \brief Return a \ref GraphWriter class 1470 /// 1471 /// This function just returns a \ref GraphWriter class. 1453 1472 /// \relates GraphWriter 1454 1473 template <typename Graph> … … 1458 1477 } 1459 1478 1479 /// \brief Return a \ref GraphWriter class 1480 /// 1481 /// This function just returns a \ref GraphWriter class. 1460 1482 /// \relates GraphWriter 1461 1483 template <typename Graph>
Note: See TracChangeset
for help on using the changeset viewer.
