1 /* -*- mode: C++; indent-tabs-mode: nil; -*-
3 * This file is a part of LEMON, a generic C++ optimization library.
5 * Copyright (C) 2003-2009
6 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 * (Egervary Research Group on Combinatorial Optimization, EGRES).
9 * Permission to use, modify and distribute this software is granted
10 * provided that this copyright notice appears in all copies. For
11 * precise terms see the accompanying LICENSE file.
13 * This software is provided "AS IS" with no warranty of any kind,
14 * express or implied, and with no claim as to its suitability for any
21 ///\brief \ref lgf-format "LEMON Graph Format" reader.
24 #ifndef LEMON_LGF_READER_H
25 #define LEMON_LGF_READER_H
34 #include <lemon/core.h>
36 #include <lemon/lgf_writer.h>
38 #include <lemon/concept_check.h>
39 #include <lemon/concepts/maps.h>
43 namespace _reader_bits {
45 template <typename Value>
46 struct DefaultConverter {
47 Value operator()(const std::string& str) {
48 std::istringstream is(str);
51 throw FormatError("Cannot read token");
55 if (is >> std::ws >> c) {
56 throw FormatError("Remaining characters in token");
63 struct DefaultConverter<std::string> {
64 std::string operator()(const std::string& str) {
69 template <typename _Item>
70 class MapStorageBase {
76 virtual ~MapStorageBase() {}
78 virtual void set(const Item& item, const std::string& value) = 0;
82 template <typename _Item, typename _Map,
83 typename _Converter = DefaultConverter<typename _Map::Value> >
84 class MapStorage : public MapStorageBase<_Item> {
87 typedef _Converter Converter;
95 MapStorage(Map& map, const Converter& converter = Converter())
96 : _map(map), _converter(converter) {}
97 virtual ~MapStorage() {}
99 virtual void set(const Item& item ,const std::string& value) {
100 _map.set(item, _converter(value));
104 template <typename _GR, bool _dir, typename _Map,
105 typename _Converter = DefaultConverter<typename _Map::Value> >
106 class GraphArcMapStorage : public MapStorageBase<typename _GR::Edge> {
109 typedef _Converter Converter;
111 typedef typename GR::Edge Item;
112 static const bool dir = _dir;
117 Converter _converter;
120 GraphArcMapStorage(const GR& graph, Map& map,
121 const Converter& converter = Converter())
122 : _graph(graph), _map(map), _converter(converter) {}
123 virtual ~GraphArcMapStorage() {}
125 virtual void set(const Item& item ,const std::string& value) {
126 _map.set(_graph.direct(item, dir), _converter(value));
130 class ValueStorageBase {
132 ValueStorageBase() {}
133 virtual ~ValueStorageBase() {}
135 virtual void set(const std::string&) = 0;
138 template <typename _Value, typename _Converter = DefaultConverter<_Value> >
139 class ValueStorage : public ValueStorageBase {
141 typedef _Value Value;
142 typedef _Converter Converter;
146 Converter _converter;
149 ValueStorage(Value& value, const Converter& converter = Converter())
150 : _value(value), _converter(converter) {}
152 virtual void set(const std::string& value) {
153 _value = _converter(value);
157 template <typename Value>
158 struct MapLookUpConverter {
159 const std::map<std::string, Value>& _map;
161 MapLookUpConverter(const std::map<std::string, Value>& map)
164 Value operator()(const std::string& str) {
165 typename std::map<std::string, Value>::const_iterator it =
167 if (it == _map.end()) {
168 std::ostringstream msg;
169 msg << "Item not found: " << str;
170 throw FormatError(msg.str());
176 template <typename GR>
177 struct GraphArcLookUpConverter {
179 const std::map<std::string, typename GR::Edge>& _map;
181 GraphArcLookUpConverter(const GR& graph,
182 const std::map<std::string,
183 typename GR::Edge>& map)
184 : _graph(graph), _map(map) {}
186 typename GR::Arc operator()(const std::string& str) {
187 if (str.empty() || (str[0] != '+' && str[0] != '-')) {
188 throw FormatError("Item must start with '+' or '-'");
190 typename std::map<std::string, typename GR::Edge>
191 ::const_iterator it = _map.find(str.substr(1));
192 if (it == _map.end()) {
193 throw FormatError("Item not found");
195 return _graph.direct(it->second, str[0] == '+');
199 inline bool isWhiteSpace(char c) {
200 return c == ' ' || c == '\t' || c == '\v' ||
201 c == '\n' || c == '\r' || c == '\f';
204 inline bool isOct(char c) {
205 return '0' <= c && c <='7';
208 inline int valueOct(char c) {
209 LEMON_ASSERT(isOct(c), "The character is not octal.");
213 inline bool isHex(char c) {
214 return ('0' <= c && c <= '9') ||
215 ('a' <= c && c <= 'z') ||
216 ('A' <= c && c <= 'Z');
219 inline int valueHex(char c) {
220 LEMON_ASSERT(isHex(c), "The character is not hexadecimal.");
221 if ('0' <= c && c <= '9') return c - '0';
222 if ('a' <= c && c <= 'z') return c - 'a' + 10;
226 inline bool isIdentifierFirstChar(char c) {
227 return ('a' <= c && c <= 'z') ||
228 ('A' <= c && c <= 'Z') || c == '_';
231 inline bool isIdentifierChar(char c) {
232 return isIdentifierFirstChar(c) ||
233 ('0' <= c && c <= '9');
236 inline char readEscape(std::istream& is) {
239 throw FormatError("Escape format error");
267 if (!is.get(c) || !isHex(c))
268 throw FormatError("Escape format error");
269 else if (code = valueHex(c), !is.get(c) || !isHex(c)) is.putback(c);
270 else code = code * 16 + valueHex(c);
277 throw FormatError("Escape format error");
278 else if (code = valueOct(c), !is.get(c) || !isOct(c))
280 else if (code = code * 8 + valueOct(c), !is.get(c) || !isOct(c))
282 else code = code * 8 + valueOct(c);
288 inline std::istream& readToken(std::istream& is, std::string& str) {
289 std::ostringstream os;
298 while (is.get(c) && c != '\"') {
304 throw FormatError("Quoted format error");
307 while (is.get(c) && !isWhiteSpace(c)) {
324 virtual ~Section() {}
325 virtual void process(std::istream& is, int& line_num) = 0;
328 template <typename Functor>
329 class LineSection : public Section {
336 LineSection(const Functor& functor) : _functor(functor) {}
337 virtual ~LineSection() {}
339 virtual void process(std::istream& is, int& line_num) {
342 while (is.get(c) && c != '@') {
345 } else if (c == '#') {
348 } else if (!isWhiteSpace(c)) {
355 if (is) is.putback(c);
356 else if (is.eof()) is.clear();
360 template <typename Functor>
361 class StreamSection : public Section {
368 StreamSection(const Functor& functor) : _functor(functor) {}
369 virtual ~StreamSection() {}
371 virtual void process(std::istream& is, int& line_num) {
372 _functor(is, line_num);
375 while (is.get(c) && c != '@') {
378 } else if (!isWhiteSpace(c)) {
383 if (is) is.putback(c);
384 else if (is.eof()) is.clear();
390 template <typename DGR>
393 template <typename TDGR>
394 DigraphReader<TDGR> digraphReader(TDGR& digraph, std::istream& is = std::cin);
395 template <typename TDGR>
396 DigraphReader<TDGR> digraphReader(TDGR& digraph, const std::string& fn);
397 template <typename TDGR>
398 DigraphReader<TDGR> digraphReader(TDGR& digraph, const char *fn);
400 /// \ingroup lemon_io
402 /// \brief \ref lgf-format "LGF" reader for directed graphs
404 /// This utility reads an \ref lgf-format "LGF" file.
406 /// The reading method does a batch processing. The user creates a
407 /// reader object, then various reading rules can be added to the
408 /// reader, and eventually the reading is executed with the \c run()
409 /// member function. A map reading rule can be added to the reader
410 /// with the \c nodeMap() or \c arcMap() members. An optional
411 /// converter parameter can also be added as a standard functor
412 /// converting from \c std::string to the value type of the map. If it
413 /// is set, it will determine how the tokens in the file should be
414 /// converted to the value type of the map. If the functor is not set,
415 /// then a default conversion will be used. One map can be read into
416 /// multiple map objects at the same time. The \c attribute(), \c
417 /// node() and \c arc() functions are used to add attribute reading
421 /// DigraphReader<DGR>(digraph, std::cin).
422 /// nodeMap("coordinates", coord_map).
423 /// arcMap("capacity", cap_map).
424 /// node("source", src).
425 /// node("target", trg).
426 /// attribute("caption", caption).
430 /// By default, the reader uses the first section in the file of the
431 /// proper type. If a section has an optional name, then it can be
432 /// selected for reading by giving an optional name parameter to the
433 /// \c nodes(), \c arcs() or \c attributes() functions.
435 /// The \c useNodes() and \c useArcs() functions are used to tell the reader
436 /// that the nodes or arcs should not be constructed (added to the
437 /// graph) during the reading, but instead the label map of the items
438 /// are given as a parameter of these functions. An
439 /// application of these functions is multipass reading, which is
440 /// important if two \c \@arcs sections must be read from the
441 /// file. In this case the first phase would read the node set and one
442 /// of the arc sets, while the second phase would read the second arc
443 /// set into an \e ArcSet class (\c SmartArcSet or \c ListArcSet).
444 /// The previously read label node map should be passed to the \c
445 /// useNodes() functions. Another application of multipass reading when
446 /// paths are given as a node map or an arc map.
447 /// It is impossible to read this in
448 /// a single pass, because the arcs are not constructed when the node
450 template <typename DGR>
451 class DigraphReader {
458 TEMPLATE_DIGRAPH_TYPEDEFS(DGR);
462 std::string _filename;
466 std::string _nodes_caption;
467 std::string _arcs_caption;
468 std::string _attributes_caption;
470 typedef std::map<std::string, Node> NodeIndex;
471 NodeIndex _node_index;
472 typedef std::map<std::string, Arc> ArcIndex;
475 typedef std::vector<std::pair<std::string,
476 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
479 typedef std::vector<std::pair<std::string,
480 _reader_bits::MapStorageBase<Arc>*> >ArcMaps;
483 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
485 Attributes _attributes;
494 std::istringstream line;
498 /// \brief Constructor
500 /// Construct a directed graph reader, which reads from the given
502 DigraphReader(DGR& digraph, std::istream& is = std::cin)
503 : _is(&is), local_is(false), _digraph(digraph),
504 _use_nodes(false), _use_arcs(false),
505 _skip_nodes(false), _skip_arcs(false) {}
507 /// \brief Constructor
509 /// Construct a directed graph reader, which reads from the given
511 DigraphReader(DGR& digraph, const std::string& fn)
512 : _is(new std::ifstream(fn.c_str())), local_is(true),
513 _filename(fn), _digraph(digraph),
514 _use_nodes(false), _use_arcs(false),
515 _skip_nodes(false), _skip_arcs(false) {
518 throw IoError("Cannot open file", fn);
522 /// \brief Constructor
524 /// Construct a directed graph reader, which reads from the given
526 DigraphReader(DGR& digraph, const char* fn)
527 : _is(new std::ifstream(fn)), local_is(true),
528 _filename(fn), _digraph(digraph),
529 _use_nodes(false), _use_arcs(false),
530 _skip_nodes(false), _skip_arcs(false) {
533 throw IoError("Cannot open file", fn);
537 /// \brief Destructor
539 for (typename NodeMaps::iterator it = _node_maps.begin();
540 it != _node_maps.end(); ++it) {
544 for (typename ArcMaps::iterator it = _arc_maps.begin();
545 it != _arc_maps.end(); ++it) {
549 for (typename Attributes::iterator it = _attributes.begin();
550 it != _attributes.end(); ++it) {
562 template <typename TDGR>
563 friend DigraphReader<TDGR> digraphReader(TDGR& digraph, std::istream& is);
564 template <typename TDGR>
565 friend DigraphReader<TDGR> digraphReader(TDGR& digraph,
566 const std::string& fn);
567 template <typename TDGR>
568 friend DigraphReader<TDGR> digraphReader(TDGR& digraph, const char *fn);
570 DigraphReader(DigraphReader& other)
571 : _is(other._is), local_is(other.local_is), _digraph(other._digraph),
572 _use_nodes(other._use_nodes), _use_arcs(other._use_arcs),
573 _skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {
576 other.local_is = false;
578 _node_index.swap(other._node_index);
579 _arc_index.swap(other._arc_index);
581 _node_maps.swap(other._node_maps);
582 _arc_maps.swap(other._arc_maps);
583 _attributes.swap(other._attributes);
585 _nodes_caption = other._nodes_caption;
586 _arcs_caption = other._arcs_caption;
587 _attributes_caption = other._attributes_caption;
591 DigraphReader& operator=(const DigraphReader&);
595 /// \name Reading Rules
598 /// \brief Node map reading rule
600 /// Add a node map reading rule to the reader.
601 template <typename Map>
602 DigraphReader& nodeMap(const std::string& caption, Map& map) {
603 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
604 _reader_bits::MapStorageBase<Node>* storage =
605 new _reader_bits::MapStorage<Node, Map>(map);
606 _node_maps.push_back(std::make_pair(caption, storage));
610 /// \brief Node map reading rule
612 /// Add a node map reading rule with specialized converter to the
614 template <typename Map, typename Converter>
615 DigraphReader& nodeMap(const std::string& caption, Map& map,
616 const Converter& converter = Converter()) {
617 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
618 _reader_bits::MapStorageBase<Node>* storage =
619 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
620 _node_maps.push_back(std::make_pair(caption, storage));
624 /// \brief Arc map reading rule
626 /// Add an arc map reading rule to the reader.
627 template <typename Map>
628 DigraphReader& arcMap(const std::string& caption, Map& map) {
629 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
630 _reader_bits::MapStorageBase<Arc>* storage =
631 new _reader_bits::MapStorage<Arc, Map>(map);
632 _arc_maps.push_back(std::make_pair(caption, storage));
636 /// \brief Arc map reading rule
638 /// Add an arc map reading rule with specialized converter to the
640 template <typename Map, typename Converter>
641 DigraphReader& arcMap(const std::string& caption, Map& map,
642 const Converter& converter = Converter()) {
643 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
644 _reader_bits::MapStorageBase<Arc>* storage =
645 new _reader_bits::MapStorage<Arc, Map, Converter>(map, converter);
646 _arc_maps.push_back(std::make_pair(caption, storage));
650 /// \brief Attribute reading rule
652 /// Add an attribute reading rule to the reader.
653 template <typename Value>
654 DigraphReader& attribute(const std::string& caption, Value& value) {
655 _reader_bits::ValueStorageBase* storage =
656 new _reader_bits::ValueStorage<Value>(value);
657 _attributes.insert(std::make_pair(caption, storage));
661 /// \brief Attribute reading rule
663 /// Add an attribute reading rule with specialized converter to the
665 template <typename Value, typename Converter>
666 DigraphReader& attribute(const std::string& caption, Value& value,
667 const Converter& converter = Converter()) {
668 _reader_bits::ValueStorageBase* storage =
669 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
670 _attributes.insert(std::make_pair(caption, storage));
674 /// \brief Node reading rule
676 /// Add a node reading rule to reader.
677 DigraphReader& node(const std::string& caption, Node& node) {
678 typedef _reader_bits::MapLookUpConverter<Node> Converter;
679 Converter converter(_node_index);
680 _reader_bits::ValueStorageBase* storage =
681 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
682 _attributes.insert(std::make_pair(caption, storage));
686 /// \brief Arc reading rule
688 /// Add an arc reading rule to reader.
689 DigraphReader& arc(const std::string& caption, Arc& arc) {
690 typedef _reader_bits::MapLookUpConverter<Arc> Converter;
691 Converter converter(_arc_index);
692 _reader_bits::ValueStorageBase* storage =
693 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
694 _attributes.insert(std::make_pair(caption, storage));
700 /// \name Select Section by Name
703 /// \brief Set \c \@nodes section to be read
705 /// Set \c \@nodes section to be read
706 DigraphReader& nodes(const std::string& caption) {
707 _nodes_caption = caption;
711 /// \brief Set \c \@arcs section to be read
713 /// Set \c \@arcs section to be read
714 DigraphReader& arcs(const std::string& caption) {
715 _arcs_caption = caption;
719 /// \brief Set \c \@attributes section to be read
721 /// Set \c \@attributes section to be read
722 DigraphReader& attributes(const std::string& caption) {
723 _attributes_caption = caption;
729 /// \name Using Previously Constructed Node or Arc Set
732 /// \brief Use previously constructed node set
734 /// Use previously constructed node set, and specify the node
736 template <typename Map>
737 DigraphReader& useNodes(const Map& map) {
738 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
739 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
741 _writer_bits::DefaultConverter<typename Map::Value> converter;
742 for (NodeIt n(_digraph); n != INVALID; ++n) {
743 _node_index.insert(std::make_pair(converter(map[n]), n));
748 /// \brief Use previously constructed node set
750 /// Use previously constructed node set, and specify the node
751 /// label map and a functor which converts the label map values to
753 template <typename Map, typename Converter>
754 DigraphReader& useNodes(const Map& map,
755 const Converter& converter = Converter()) {
756 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
757 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
759 for (NodeIt n(_digraph); n != INVALID; ++n) {
760 _node_index.insert(std::make_pair(converter(map[n]), n));
765 /// \brief Use previously constructed arc set
767 /// Use previously constructed arc set, and specify the arc
769 template <typename Map>
770 DigraphReader& useArcs(const Map& map) {
771 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
772 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
774 _writer_bits::DefaultConverter<typename Map::Value> converter;
775 for (ArcIt a(_digraph); a != INVALID; ++a) {
776 _arc_index.insert(std::make_pair(converter(map[a]), a));
781 /// \brief Use previously constructed arc set
783 /// Use previously constructed arc set, and specify the arc
784 /// label map and a functor which converts the label map values to
786 template <typename Map, typename Converter>
787 DigraphReader& useArcs(const Map& map,
788 const Converter& converter = Converter()) {
789 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
790 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
792 for (ArcIt a(_digraph); a != INVALID; ++a) {
793 _arc_index.insert(std::make_pair(converter(map[a]), a));
798 /// \brief Skips the reading of node section
800 /// Omit the reading of the node section. This implies that each node
801 /// map reading rule will be abandoned, and the nodes of the graph
802 /// will not be constructed, which usually cause that the arc set
803 /// could not be read due to lack of node name resolving.
804 /// Therefore \c skipArcs() function should also be used, or
805 /// \c useNodes() should be used to specify the label of the nodes.
806 DigraphReader& skipNodes() {
807 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
812 /// \brief Skips the reading of arc section
814 /// Omit the reading of the arc section. This implies that each arc
815 /// map reading rule will be abandoned, and the arcs of the graph
816 /// will not be constructed.
817 DigraphReader& skipArcs() {
818 LEMON_ASSERT(!_skip_arcs, "Skip arcs already set");
829 while(++line_num, std::getline(*_is, str)) {
830 line.clear(); line.str(str);
832 if (line >> std::ws >> c && c != '#') {
841 return static_cast<bool>(*_is);
846 while (readSuccess() && line >> c && c != '@') {
856 std::vector<int> map_index(_node_maps.size());
857 int map_num, label_index;
860 if (!readLine() || !(line >> c) || c == '@') {
861 if (readSuccess() && line) line.putback(c);
862 if (!_node_maps.empty())
863 throw FormatError("Cannot find map names");
869 std::map<std::string, int> maps;
873 while (_reader_bits::readToken(line, map)) {
874 if (maps.find(map) != maps.end()) {
875 std::ostringstream msg;
876 msg << "Multiple occurence of node map: " << map;
877 throw FormatError(msg.str());
879 maps.insert(std::make_pair(map, index));
883 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
884 std::map<std::string, int>::iterator jt =
885 maps.find(_node_maps[i].first);
886 if (jt == maps.end()) {
887 std::ostringstream msg;
888 msg << "Map not found: " << _node_maps[i].first;
889 throw FormatError(msg.str());
891 map_index[i] = jt->second;
895 std::map<std::string, int>::iterator jt = maps.find("label");
896 if (jt != maps.end()) {
897 label_index = jt->second;
902 map_num = maps.size();
905 while (readLine() && line >> c && c != '@') {
908 std::vector<std::string> tokens(map_num);
909 for (int i = 0; i < map_num; ++i) {
910 if (!_reader_bits::readToken(line, tokens[i])) {
911 std::ostringstream msg;
912 msg << "Column not found (" << i + 1 << ")";
913 throw FormatError(msg.str());
916 if (line >> std::ws >> c)
917 throw FormatError("Extra character at the end of line");
921 n = _digraph.addNode();
922 if (label_index != -1)
923 _node_index.insert(std::make_pair(tokens[label_index], n));
925 if (label_index == -1)
926 throw FormatError("Label map not found");
927 typename std::map<std::string, Node>::iterator it =
928 _node_index.find(tokens[label_index]);
929 if (it == _node_index.end()) {
930 std::ostringstream msg;
931 msg << "Node with label not found: " << tokens[label_index];
932 throw FormatError(msg.str());
937 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
938 _node_maps[i].second->set(n, tokens[map_index[i]]);
949 std::vector<int> map_index(_arc_maps.size());
950 int map_num, label_index;
953 if (!readLine() || !(line >> c) || c == '@') {
954 if (readSuccess() && line) line.putback(c);
955 if (!_arc_maps.empty())
956 throw FormatError("Cannot find map names");
962 std::map<std::string, int> maps;
966 while (_reader_bits::readToken(line, map)) {
967 if (maps.find(map) != maps.end()) {
968 std::ostringstream msg;
969 msg << "Multiple occurence of arc map: " << map;
970 throw FormatError(msg.str());
972 maps.insert(std::make_pair(map, index));
976 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
977 std::map<std::string, int>::iterator jt =
978 maps.find(_arc_maps[i].first);
979 if (jt == maps.end()) {
980 std::ostringstream msg;
981 msg << "Map not found: " << _arc_maps[i].first;
982 throw FormatError(msg.str());
984 map_index[i] = jt->second;
988 std::map<std::string, int>::iterator jt = maps.find("label");
989 if (jt != maps.end()) {
990 label_index = jt->second;
995 map_num = maps.size();
998 while (readLine() && line >> c && c != '@') {
1001 std::string source_token;
1002 std::string target_token;
1004 if (!_reader_bits::readToken(line, source_token))
1005 throw FormatError("Source not found");
1007 if (!_reader_bits::readToken(line, target_token))
1008 throw FormatError("Target not found");
1010 std::vector<std::string> tokens(map_num);
1011 for (int i = 0; i < map_num; ++i) {
1012 if (!_reader_bits::readToken(line, tokens[i])) {
1013 std::ostringstream msg;
1014 msg << "Column not found (" << i + 1 << ")";
1015 throw FormatError(msg.str());
1018 if (line >> std::ws >> c)
1019 throw FormatError("Extra character at the end of line");
1024 typename NodeIndex::iterator it;
1026 it = _node_index.find(source_token);
1027 if (it == _node_index.end()) {
1028 std::ostringstream msg;
1029 msg << "Item not found: " << source_token;
1030 throw FormatError(msg.str());
1032 Node source = it->second;
1034 it = _node_index.find(target_token);
1035 if (it == _node_index.end()) {
1036 std::ostringstream msg;
1037 msg << "Item not found: " << target_token;
1038 throw FormatError(msg.str());
1040 Node target = it->second;
1042 a = _digraph.addArc(source, target);
1043 if (label_index != -1)
1044 _arc_index.insert(std::make_pair(tokens[label_index], a));
1046 if (label_index == -1)
1047 throw FormatError("Label map not found");
1048 typename std::map<std::string, Arc>::iterator it =
1049 _arc_index.find(tokens[label_index]);
1050 if (it == _arc_index.end()) {
1051 std::ostringstream msg;
1052 msg << "Arc with label not found: " << tokens[label_index];
1053 throw FormatError(msg.str());
1058 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
1059 _arc_maps[i].second->set(a, tokens[map_index[i]]);
1063 if (readSuccess()) {
1068 void readAttributes() {
1070 std::set<std::string> read_attr;
1073 while (readLine() && line >> c && c != '@') {
1076 std::string attr, token;
1077 if (!_reader_bits::readToken(line, attr))
1078 throw FormatError("Attribute name not found");
1079 if (!_reader_bits::readToken(line, token))
1080 throw FormatError("Attribute value not found");
1082 throw FormatError("Extra character at the end of line");
1085 std::set<std::string>::iterator it = read_attr.find(attr);
1086 if (it != read_attr.end()) {
1087 std::ostringstream msg;
1088 msg << "Multiple occurence of attribute: " << attr;
1089 throw FormatError(msg.str());
1091 read_attr.insert(attr);
1095 typename Attributes::iterator it = _attributes.lower_bound(attr);
1096 while (it != _attributes.end() && it->first == attr) {
1097 it->second->set(token);
1103 if (readSuccess()) {
1106 for (typename Attributes::iterator it = _attributes.begin();
1107 it != _attributes.end(); ++it) {
1108 if (read_attr.find(it->first) == read_attr.end()) {
1109 std::ostringstream msg;
1110 msg << "Attribute not found: " << it->first;
1111 throw FormatError(msg.str());
1118 /// \name Execution of the Reader
1121 /// \brief Start the batch processing
1123 /// This function starts the batch processing
1125 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1127 bool nodes_done = _skip_nodes;
1128 bool arcs_done = _skip_arcs;
1129 bool attributes_done = false;
1135 while (readSuccess()) {
1138 std::string section, caption;
1140 _reader_bits::readToken(line, section);
1141 _reader_bits::readToken(line, caption);
1144 throw FormatError("Extra character at the end of line");
1146 if (section == "nodes" && !nodes_done) {
1147 if (_nodes_caption.empty() || _nodes_caption == caption) {
1151 } else if ((section == "arcs" || section == "edges") &&
1153 if (_arcs_caption.empty() || _arcs_caption == caption) {
1157 } else if (section == "attributes" && !attributes_done) {
1158 if (_attributes_caption.empty() || _attributes_caption == caption) {
1160 attributes_done = true;
1166 } catch (FormatError& error) {
1167 error.line(line_num);
1168 error.file(_filename);
1174 throw FormatError("Section @nodes not found");
1178 throw FormatError("Section @arcs not found");
1181 if (!attributes_done && !_attributes.empty()) {
1182 throw FormatError("Section @attributes not found");
1191 /// \ingroup lemon_io
1193 /// \brief Return a \ref DigraphReader class
1195 /// This function just returns a \ref DigraphReader class.
1197 /// With this function a digraph can be read from an
1198 /// \ref lgf-format "LGF" file or input stream with several maps and
1199 /// attributes. For example, there is network flow problem on a
1200 /// digraph, i.e. a digraph with a \e capacity map on the arcs and
1201 /// \e source and \e target nodes. This digraph can be read with the
1205 ///ListDigraph digraph;
1206 ///ListDigraph::ArcMap<int> cm(digraph);
1207 ///ListDigraph::Node src, trg;
1208 ///digraphReader(digraph, std::cin).
1209 /// arcMap("capacity", cap).
1210 /// node("source", src).
1211 /// node("target", trg).
1215 /// For a complete documentation, please see the \ref DigraphReader
1216 /// class documentation.
1217 /// \warning Don't forget to put the \ref DigraphReader::run() "run()"
1218 /// to the end of the parameter list.
1219 /// \relates DigraphReader
1220 /// \sa digraphReader(TDGR& digraph, const std::string& fn)
1221 /// \sa digraphReader(TDGR& digraph, const char* fn)
1222 template <typename TDGR>
1223 DigraphReader<TDGR> digraphReader(TDGR& digraph, std::istream& is) {
1224 DigraphReader<TDGR> tmp(digraph, is);
1228 /// \brief Return a \ref DigraphReader class
1230 /// This function just returns a \ref DigraphReader class.
1231 /// \relates DigraphReader
1232 /// \sa digraphReader(TDGR& digraph, std::istream& is)
1233 template <typename TDGR>
1234 DigraphReader<TDGR> digraphReader(TDGR& digraph, const std::string& fn) {
1235 DigraphReader<TDGR> tmp(digraph, fn);
1239 /// \brief Return a \ref DigraphReader class
1241 /// This function just returns a \ref DigraphReader class.
1242 /// \relates DigraphReader
1243 /// \sa digraphReader(TDGR& digraph, std::istream& is)
1244 template <typename TDGR>
1245 DigraphReader<TDGR> digraphReader(TDGR& digraph, const char* fn) {
1246 DigraphReader<TDGR> tmp(digraph, fn);
1250 template <typename GR>
1253 template <typename TGR>
1254 GraphReader<TGR> graphReader(TGR& graph, std::istream& is = std::cin);
1255 template <typename TGR>
1256 GraphReader<TGR> graphReader(TGR& graph, const std::string& fn);
1257 template <typename TGR>
1258 GraphReader<TGR> graphReader(TGR& graph, const char *fn);
1260 /// \ingroup lemon_io
1262 /// \brief \ref lgf-format "LGF" reader for undirected graphs
1264 /// This utility reads an \ref lgf-format "LGF" file.
1266 /// It can be used almost the same way as \c DigraphReader.
1267 /// The only difference is that this class can handle edges and
1268 /// edge maps as well as arcs and arc maps.
1270 /// The columns in the \c \@edges (or \c \@arcs) section are the
1271 /// edge maps. However, if there are two maps with the same name
1272 /// prefixed with \c '+' and \c '-', then these can be read into an
1273 /// arc map. Similarly, an attribute can be read into an arc, if
1274 /// it's value is an edge label prefixed with \c '+' or \c '-'.
1275 template <typename GR>
1283 TEMPLATE_GRAPH_TYPEDEFS(GR);
1287 std::string _filename;
1291 std::string _nodes_caption;
1292 std::string _edges_caption;
1293 std::string _attributes_caption;
1295 typedef std::map<std::string, Node> NodeIndex;
1296 NodeIndex _node_index;
1297 typedef std::map<std::string, Edge> EdgeIndex;
1298 EdgeIndex _edge_index;
1300 typedef std::vector<std::pair<std::string,
1301 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
1302 NodeMaps _node_maps;
1304 typedef std::vector<std::pair<std::string,
1305 _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;
1306 EdgeMaps _edge_maps;
1308 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
1310 Attributes _attributes;
1319 std::istringstream line;
1323 /// \brief Constructor
1325 /// Construct an undirected graph reader, which reads from the given
1327 GraphReader(GR& graph, std::istream& is = std::cin)
1328 : _is(&is), local_is(false), _graph(graph),
1329 _use_nodes(false), _use_edges(false),
1330 _skip_nodes(false), _skip_edges(false) {}
1332 /// \brief Constructor
1334 /// Construct an undirected graph reader, which reads from the given
1336 GraphReader(GR& graph, const std::string& fn)
1337 : _is(new std::ifstream(fn.c_str())), local_is(true),
1338 _filename(fn), _graph(graph),
1339 _use_nodes(false), _use_edges(false),
1340 _skip_nodes(false), _skip_edges(false) {
1343 throw IoError("Cannot open file", fn);
1347 /// \brief Constructor
1349 /// Construct an undirected graph reader, which reads from the given
1351 GraphReader(GR& graph, const char* fn)
1352 : _is(new std::ifstream(fn)), local_is(true),
1353 _filename(fn), _graph(graph),
1354 _use_nodes(false), _use_edges(false),
1355 _skip_nodes(false), _skip_edges(false) {
1358 throw IoError("Cannot open file", fn);
1362 /// \brief Destructor
1364 for (typename NodeMaps::iterator it = _node_maps.begin();
1365 it != _node_maps.end(); ++it) {
1369 for (typename EdgeMaps::iterator it = _edge_maps.begin();
1370 it != _edge_maps.end(); ++it) {
1374 for (typename Attributes::iterator it = _attributes.begin();
1375 it != _attributes.end(); ++it) {
1386 template <typename TGR>
1387 friend GraphReader<TGR> graphReader(TGR& graph, std::istream& is);
1388 template <typename TGR>
1389 friend GraphReader<TGR> graphReader(TGR& graph, const std::string& fn);
1390 template <typename TGR>
1391 friend GraphReader<TGR> graphReader(TGR& graph, const char *fn);
1393 GraphReader(GraphReader& other)
1394 : _is(other._is), local_is(other.local_is), _graph(other._graph),
1395 _use_nodes(other._use_nodes), _use_edges(other._use_edges),
1396 _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
1399 other.local_is = false;
1401 _node_index.swap(other._node_index);
1402 _edge_index.swap(other._edge_index);
1404 _node_maps.swap(other._node_maps);
1405 _edge_maps.swap(other._edge_maps);
1406 _attributes.swap(other._attributes);
1408 _nodes_caption = other._nodes_caption;
1409 _edges_caption = other._edges_caption;
1410 _attributes_caption = other._attributes_caption;
1414 GraphReader& operator=(const GraphReader&);
1418 /// \name Reading Rules
1421 /// \brief Node map reading rule
1423 /// Add a node map reading rule to the reader.
1424 template <typename Map>
1425 GraphReader& nodeMap(const std::string& caption, Map& map) {
1426 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1427 _reader_bits::MapStorageBase<Node>* storage =
1428 new _reader_bits::MapStorage<Node, Map>(map);
1429 _node_maps.push_back(std::make_pair(caption, storage));
1433 /// \brief Node map reading rule
1435 /// Add a node map reading rule with specialized converter to the
1437 template <typename Map, typename Converter>
1438 GraphReader& nodeMap(const std::string& caption, Map& map,
1439 const Converter& converter = Converter()) {
1440 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1441 _reader_bits::MapStorageBase<Node>* storage =
1442 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
1443 _node_maps.push_back(std::make_pair(caption, storage));
1447 /// \brief Edge map reading rule
1449 /// Add an edge map reading rule to the reader.
1450 template <typename Map>
1451 GraphReader& edgeMap(const std::string& caption, Map& map) {
1452 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1453 _reader_bits::MapStorageBase<Edge>* storage =
1454 new _reader_bits::MapStorage<Edge, Map>(map);
1455 _edge_maps.push_back(std::make_pair(caption, storage));
1459 /// \brief Edge map reading rule
1461 /// Add an edge map reading rule with specialized converter to the
1463 template <typename Map, typename Converter>
1464 GraphReader& edgeMap(const std::string& caption, Map& map,
1465 const Converter& converter = Converter()) {
1466 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1467 _reader_bits::MapStorageBase<Edge>* storage =
1468 new _reader_bits::MapStorage<Edge, Map, Converter>(map, converter);
1469 _edge_maps.push_back(std::make_pair(caption, storage));
1473 /// \brief Arc map reading rule
1475 /// Add an arc map reading rule to the reader.
1476 template <typename Map>
1477 GraphReader& arcMap(const std::string& caption, Map& map) {
1478 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1479 _reader_bits::MapStorageBase<Edge>* forward_storage =
1480 new _reader_bits::GraphArcMapStorage<Graph, true, Map>(_graph, map);
1481 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1482 _reader_bits::MapStorageBase<Edge>* backward_storage =
1483 new _reader_bits::GraphArcMapStorage<GR, false, Map>(_graph, map);
1484 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1488 /// \brief Arc map reading rule
1490 /// Add an arc map reading rule with specialized converter to the
1492 template <typename Map, typename Converter>
1493 GraphReader& arcMap(const std::string& caption, Map& map,
1494 const Converter& converter = Converter()) {
1495 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1496 _reader_bits::MapStorageBase<Edge>* forward_storage =
1497 new _reader_bits::GraphArcMapStorage<GR, true, Map, Converter>
1498 (_graph, map, converter);
1499 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1500 _reader_bits::MapStorageBase<Edge>* backward_storage =
1501 new _reader_bits::GraphArcMapStorage<GR, false, Map, Converter>
1502 (_graph, map, converter);
1503 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1507 /// \brief Attribute reading rule
1509 /// Add an attribute reading rule to the reader.
1510 template <typename Value>
1511 GraphReader& attribute(const std::string& caption, Value& value) {
1512 _reader_bits::ValueStorageBase* storage =
1513 new _reader_bits::ValueStorage<Value>(value);
1514 _attributes.insert(std::make_pair(caption, storage));
1518 /// \brief Attribute reading rule
1520 /// Add an attribute reading rule with specialized converter to the
1522 template <typename Value, typename Converter>
1523 GraphReader& attribute(const std::string& caption, Value& value,
1524 const Converter& converter = Converter()) {
1525 _reader_bits::ValueStorageBase* storage =
1526 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
1527 _attributes.insert(std::make_pair(caption, storage));
1531 /// \brief Node reading rule
1533 /// Add a node reading rule to reader.
1534 GraphReader& node(const std::string& caption, Node& node) {
1535 typedef _reader_bits::MapLookUpConverter<Node> Converter;
1536 Converter converter(_node_index);
1537 _reader_bits::ValueStorageBase* storage =
1538 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
1539 _attributes.insert(std::make_pair(caption, storage));
1543 /// \brief Edge reading rule
1545 /// Add an edge reading rule to reader.
1546 GraphReader& edge(const std::string& caption, Edge& edge) {
1547 typedef _reader_bits::MapLookUpConverter<Edge> Converter;
1548 Converter converter(_edge_index);
1549 _reader_bits::ValueStorageBase* storage =
1550 new _reader_bits::ValueStorage<Edge, Converter>(edge, converter);
1551 _attributes.insert(std::make_pair(caption, storage));
1555 /// \brief Arc reading rule
1557 /// Add an arc reading rule to reader.
1558 GraphReader& arc(const std::string& caption, Arc& arc) {
1559 typedef _reader_bits::GraphArcLookUpConverter<GR> Converter;
1560 Converter converter(_graph, _edge_index);
1561 _reader_bits::ValueStorageBase* storage =
1562 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
1563 _attributes.insert(std::make_pair(caption, storage));
1569 /// \name Select Section by Name
1572 /// \brief Set \c \@nodes section to be read
1574 /// Set \c \@nodes section to be read.
1575 GraphReader& nodes(const std::string& caption) {
1576 _nodes_caption = caption;
1580 /// \brief Set \c \@edges section to be read
1582 /// Set \c \@edges section to be read.
1583 GraphReader& edges(const std::string& caption) {
1584 _edges_caption = caption;
1588 /// \brief Set \c \@attributes section to be read
1590 /// Set \c \@attributes section to be read.
1591 GraphReader& attributes(const std::string& caption) {
1592 _attributes_caption = caption;
1598 /// \name Using Previously Constructed Node or Edge Set
1601 /// \brief Use previously constructed node set
1603 /// Use previously constructed node set, and specify the node
1605 template <typename Map>
1606 GraphReader& useNodes(const Map& map) {
1607 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1608 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1610 _writer_bits::DefaultConverter<typename Map::Value> converter;
1611 for (NodeIt n(_graph); n != INVALID; ++n) {
1612 _node_index.insert(std::make_pair(converter(map[n]), n));
1617 /// \brief Use previously constructed node set
1619 /// Use previously constructed node set, and specify the node
1620 /// label map and a functor which converts the label map values to
1622 template <typename Map, typename Converter>
1623 GraphReader& useNodes(const Map& map,
1624 const Converter& converter = Converter()) {
1625 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1626 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1628 for (NodeIt n(_graph); n != INVALID; ++n) {
1629 _node_index.insert(std::make_pair(converter(map[n]), n));
1634 /// \brief Use previously constructed edge set
1636 /// Use previously constructed edge set, and specify the edge
1638 template <typename Map>
1639 GraphReader& useEdges(const Map& map) {
1640 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1641 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1643 _writer_bits::DefaultConverter<typename Map::Value> converter;
1644 for (EdgeIt a(_graph); a != INVALID; ++a) {
1645 _edge_index.insert(std::make_pair(converter(map[a]), a));
1650 /// \brief Use previously constructed edge set
1652 /// Use previously constructed edge set, and specify the edge
1653 /// label map and a functor which converts the label map values to
1655 template <typename Map, typename Converter>
1656 GraphReader& useEdges(const Map& map,
1657 const Converter& converter = Converter()) {
1658 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1659 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1661 for (EdgeIt a(_graph); a != INVALID; ++a) {
1662 _edge_index.insert(std::make_pair(converter(map[a]), a));
1667 /// \brief Skip the reading of node section
1669 /// Omit the reading of the node section. This implies that each node
1670 /// map reading rule will be abandoned, and the nodes of the graph
1671 /// will not be constructed, which usually cause that the edge set
1672 /// could not be read due to lack of node name
1673 /// could not be read due to lack of node name resolving.
1674 /// Therefore \c skipEdges() function should also be used, or
1675 /// \c useNodes() should be used to specify the label of the nodes.
1676 GraphReader& skipNodes() {
1677 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
1682 /// \brief Skip the reading of edge section
1684 /// Omit the reading of the edge section. This implies that each edge
1685 /// map reading rule will be abandoned, and the edges of the graph
1686 /// will not be constructed.
1687 GraphReader& skipEdges() {
1688 LEMON_ASSERT(!_skip_edges, "Skip edges already set");
1699 while(++line_num, std::getline(*_is, str)) {
1700 line.clear(); line.str(str);
1702 if (line >> std::ws >> c && c != '#') {
1710 bool readSuccess() {
1711 return static_cast<bool>(*_is);
1714 void skipSection() {
1716 while (readSuccess() && line >> c && c != '@') {
1719 if (readSuccess()) {
1726 std::vector<int> map_index(_node_maps.size());
1727 int map_num, label_index;
1730 if (!readLine() || !(line >> c) || c == '@') {
1731 if (readSuccess() && line) line.putback(c);
1732 if (!_node_maps.empty())
1733 throw FormatError("Cannot find map names");
1739 std::map<std::string, int> maps;
1743 while (_reader_bits::readToken(line, map)) {
1744 if (maps.find(map) != maps.end()) {
1745 std::ostringstream msg;
1746 msg << "Multiple occurence of node map: " << map;
1747 throw FormatError(msg.str());
1749 maps.insert(std::make_pair(map, index));
1753 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1754 std::map<std::string, int>::iterator jt =
1755 maps.find(_node_maps[i].first);
1756 if (jt == maps.end()) {
1757 std::ostringstream msg;
1758 msg << "Map not found: " << _node_maps[i].first;
1759 throw FormatError(msg.str());
1761 map_index[i] = jt->second;
1765 std::map<std::string, int>::iterator jt = maps.find("label");
1766 if (jt != maps.end()) {
1767 label_index = jt->second;
1772 map_num = maps.size();
1775 while (readLine() && line >> c && c != '@') {
1778 std::vector<std::string> tokens(map_num);
1779 for (int i = 0; i < map_num; ++i) {
1780 if (!_reader_bits::readToken(line, tokens[i])) {
1781 std::ostringstream msg;
1782 msg << "Column not found (" << i + 1 << ")";
1783 throw FormatError(msg.str());
1786 if (line >> std::ws >> c)
1787 throw FormatError("Extra character at the end of line");
1791 n = _graph.addNode();
1792 if (label_index != -1)
1793 _node_index.insert(std::make_pair(tokens[label_index], n));
1795 if (label_index == -1)
1796 throw FormatError("Label map not found");
1797 typename std::map<std::string, Node>::iterator it =
1798 _node_index.find(tokens[label_index]);
1799 if (it == _node_index.end()) {
1800 std::ostringstream msg;
1801 msg << "Node with label not found: " << tokens[label_index];
1802 throw FormatError(msg.str());
1807 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1808 _node_maps[i].second->set(n, tokens[map_index[i]]);
1812 if (readSuccess()) {
1819 std::vector<int> map_index(_edge_maps.size());
1820 int map_num, label_index;
1823 if (!readLine() || !(line >> c) || c == '@') {
1824 if (readSuccess() && line) line.putback(c);
1825 if (!_edge_maps.empty())
1826 throw FormatError("Cannot find map names");
1832 std::map<std::string, int> maps;
1836 while (_reader_bits::readToken(line, map)) {
1837 if (maps.find(map) != maps.end()) {
1838 std::ostringstream msg;
1839 msg << "Multiple occurence of edge map: " << map;
1840 throw FormatError(msg.str());
1842 maps.insert(std::make_pair(map, index));
1846 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1847 std::map<std::string, int>::iterator jt =
1848 maps.find(_edge_maps[i].first);
1849 if (jt == maps.end()) {
1850 std::ostringstream msg;
1851 msg << "Map not found: " << _edge_maps[i].first;
1852 throw FormatError(msg.str());
1854 map_index[i] = jt->second;
1858 std::map<std::string, int>::iterator jt = maps.find("label");
1859 if (jt != maps.end()) {
1860 label_index = jt->second;
1865 map_num = maps.size();
1868 while (readLine() && line >> c && c != '@') {
1871 std::string source_token;
1872 std::string target_token;
1874 if (!_reader_bits::readToken(line, source_token))
1875 throw FormatError("Node u not found");
1877 if (!_reader_bits::readToken(line, target_token))
1878 throw FormatError("Node v not found");
1880 std::vector<std::string> tokens(map_num);
1881 for (int i = 0; i < map_num; ++i) {
1882 if (!_reader_bits::readToken(line, tokens[i])) {
1883 std::ostringstream msg;
1884 msg << "Column not found (" << i + 1 << ")";
1885 throw FormatError(msg.str());
1888 if (line >> std::ws >> c)
1889 throw FormatError("Extra character at the end of line");
1894 typename NodeIndex::iterator it;
1896 it = _node_index.find(source_token);
1897 if (it == _node_index.end()) {
1898 std::ostringstream msg;
1899 msg << "Item not found: " << source_token;
1900 throw FormatError(msg.str());
1902 Node source = it->second;
1904 it = _node_index.find(target_token);
1905 if (it == _node_index.end()) {
1906 std::ostringstream msg;
1907 msg << "Item not found: " << target_token;
1908 throw FormatError(msg.str());
1910 Node target = it->second;
1912 e = _graph.addEdge(source, target);
1913 if (label_index != -1)
1914 _edge_index.insert(std::make_pair(tokens[label_index], e));
1916 if (label_index == -1)
1917 throw FormatError("Label map not found");
1918 typename std::map<std::string, Edge>::iterator it =
1919 _edge_index.find(tokens[label_index]);
1920 if (it == _edge_index.end()) {
1921 std::ostringstream msg;
1922 msg << "Edge with label not found: " << tokens[label_index];
1923 throw FormatError(msg.str());
1928 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1929 _edge_maps[i].second->set(e, tokens[map_index[i]]);
1933 if (readSuccess()) {
1938 void readAttributes() {
1940 std::set<std::string> read_attr;
1943 while (readLine() && line >> c && c != '@') {
1946 std::string attr, token;
1947 if (!_reader_bits::readToken(line, attr))
1948 throw FormatError("Attribute name not found");
1949 if (!_reader_bits::readToken(line, token))
1950 throw FormatError("Attribute value not found");
1952 throw FormatError("Extra character at the end of line");
1955 std::set<std::string>::iterator it = read_attr.find(attr);
1956 if (it != read_attr.end()) {
1957 std::ostringstream msg;
1958 msg << "Multiple occurence of attribute: " << attr;
1959 throw FormatError(msg.str());
1961 read_attr.insert(attr);
1965 typename Attributes::iterator it = _attributes.lower_bound(attr);
1966 while (it != _attributes.end() && it->first == attr) {
1967 it->second->set(token);
1973 if (readSuccess()) {
1976 for (typename Attributes::iterator it = _attributes.begin();
1977 it != _attributes.end(); ++it) {
1978 if (read_attr.find(it->first) == read_attr.end()) {
1979 std::ostringstream msg;
1980 msg << "Attribute not found: " << it->first;
1981 throw FormatError(msg.str());
1988 /// \name Execution of the Reader
1991 /// \brief Start the batch processing
1993 /// This function starts the batch processing
1996 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1998 bool nodes_done = _skip_nodes;
1999 bool edges_done = _skip_edges;
2000 bool attributes_done = false;
2006 while (readSuccess()) {
2009 std::string section, caption;
2011 _reader_bits::readToken(line, section);
2012 _reader_bits::readToken(line, caption);
2015 throw FormatError("Extra character at the end of line");
2017 if (section == "nodes" && !nodes_done) {
2018 if (_nodes_caption.empty() || _nodes_caption == caption) {
2022 } else if ((section == "edges" || section == "arcs") &&
2024 if (_edges_caption.empty() || _edges_caption == caption) {
2028 } else if (section == "attributes" && !attributes_done) {
2029 if (_attributes_caption.empty() || _attributes_caption == caption) {
2031 attributes_done = true;
2037 } catch (FormatError& error) {
2038 error.line(line_num);
2039 error.file(_filename);
2045 throw FormatError("Section @nodes not found");
2049 throw FormatError("Section @edges not found");
2052 if (!attributes_done && !_attributes.empty()) {
2053 throw FormatError("Section @attributes not found");
2062 /// \ingroup lemon_io
2064 /// \brief Return a \ref GraphReader class
2066 /// This function just returns a \ref GraphReader class.
2068 /// With this function a graph can be read from an
2069 /// \ref lgf-format "LGF" file or input stream with several maps and
2070 /// attributes. For example, there is weighted matching problem on a
2071 /// graph, i.e. a graph with a \e weight map on the edges. This
2072 /// graph can be read with the following code:
2076 ///ListGraph::EdgeMap<int> weight(graph);
2077 ///graphReader(graph, std::cin).
2078 /// edgeMap("weight", weight).
2082 /// For a complete documentation, please see the \ref GraphReader
2083 /// class documentation.
2084 /// \warning Don't forget to put the \ref GraphReader::run() "run()"
2085 /// to the end of the parameter list.
2086 /// \relates GraphReader
2087 /// \sa graphReader(TGR& graph, const std::string& fn)
2088 /// \sa graphReader(TGR& graph, const char* fn)
2089 template <typename TGR>
2090 GraphReader<TGR> graphReader(TGR& graph, std::istream& is) {
2091 GraphReader<TGR> tmp(graph, is);
2095 /// \brief Return a \ref GraphReader class
2097 /// This function just returns a \ref GraphReader class.
2098 /// \relates GraphReader
2099 /// \sa graphReader(TGR& graph, std::istream& is)
2100 template <typename TGR>
2101 GraphReader<TGR> graphReader(TGR& graph, const std::string& fn) {
2102 GraphReader<TGR> tmp(graph, fn);
2106 /// \brief Return a \ref GraphReader class
2108 /// This function just returns a \ref GraphReader class.
2109 /// \relates GraphReader
2110 /// \sa graphReader(TGR& graph, std::istream& is)
2111 template <typename TGR>
2112 GraphReader<TGR> graphReader(TGR& graph, const char* fn) {
2113 GraphReader<TGR> tmp(graph, fn);
2117 class SectionReader;
2119 SectionReader sectionReader(std::istream& is);
2120 SectionReader sectionReader(const std::string& fn);
2121 SectionReader sectionReader(const char* fn);
2123 /// \ingroup lemon_io
2125 /// \brief Section reader class
2127 /// In the \ref lgf-format "LGF" file extra sections can be placed,
2128 /// which contain any data in arbitrary format. Such sections can be
2129 /// read with this class. A reading rule can be added to the class
2130 /// with two different functions. With the \c sectionLines() function a
2131 /// functor can process the section line-by-line, while with the \c
2132 /// sectionStream() member the section can be read from an input
2134 class SectionReader {
2139 std::string _filename;
2141 typedef std::map<std::string, _reader_bits::Section*> Sections;
2145 std::istringstream line;
2149 /// \brief Constructor
2151 /// Construct a section reader, which reads from the given input
2153 SectionReader(std::istream& is)
2154 : _is(&is), local_is(false) {}
2156 /// \brief Constructor
2158 /// Construct a section reader, which reads from the given file.
2159 SectionReader(const std::string& fn)
2160 : _is(new std::ifstream(fn.c_str())), local_is(true),
2164 throw IoError("Cannot open file", fn);
2168 /// \brief Constructor
2170 /// Construct a section reader, which reads from the given file.
2171 SectionReader(const char* fn)
2172 : _is(new std::ifstream(fn)), local_is(true),
2176 throw IoError("Cannot open file", fn);
2180 /// \brief Destructor
2182 for (Sections::iterator it = _sections.begin();
2183 it != _sections.end(); ++it) {
2195 friend SectionReader sectionReader(std::istream& is);
2196 friend SectionReader sectionReader(const std::string& fn);
2197 friend SectionReader sectionReader(const char* fn);
2199 SectionReader(SectionReader& other)
2200 : _is(other._is), local_is(other.local_is) {
2203 other.local_is = false;
2205 _sections.swap(other._sections);
2208 SectionReader& operator=(const SectionReader&);
2212 /// \name Section Readers
2215 /// \brief Add a section processor with line oriented reading
2217 /// The first parameter is the type descriptor of the section, the
2218 /// second is a functor, which takes just one \c std::string
2219 /// parameter. At the reading process, each line of the section
2220 /// will be given to the functor object. However, the empty lines
2221 /// and the comment lines are filtered out, and the leading
2222 /// whitespaces are trimmed from each processed string.
2224 /// For example, let's see a section, which contain several
2225 /// integers, which should be inserted into a vector.
2233 /// The functor is implemented as a struct:
2235 /// struct NumberSection {
2236 /// std::vector<int>& _data;
2237 /// NumberSection(std::vector<int>& data) : _data(data) {}
2238 /// void operator()(const std::string& line) {
2239 /// std::istringstream ls(line);
2241 /// while (ls >> value) _data.push_back(value);
2247 /// reader.sectionLines("numbers", NumberSection(vec));
2249 template <typename Functor>
2250 SectionReader& sectionLines(const std::string& type, Functor functor) {
2251 LEMON_ASSERT(!type.empty(), "Type is empty.");
2252 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2253 "Multiple reading of section.");
2254 _sections.insert(std::make_pair(type,
2255 new _reader_bits::LineSection<Functor>(functor)));
2260 /// \brief Add a section processor with stream oriented reading
2262 /// The first parameter is the type of the section, the second is
2263 /// a functor, which takes an \c std::istream& and an \c int&
2264 /// parameter, the latter regard to the line number of stream. The
2265 /// functor can read the input while the section go on, and the
2266 /// line number should be modified accordingly.
2267 template <typename Functor>
2268 SectionReader& sectionStream(const std::string& type, Functor functor) {
2269 LEMON_ASSERT(!type.empty(), "Type is empty.");
2270 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2271 "Multiple reading of section.");
2272 _sections.insert(std::make_pair(type,
2273 new _reader_bits::StreamSection<Functor>(functor)));
2283 while(++line_num, std::getline(*_is, str)) {
2284 line.clear(); line.str(str);
2286 if (line >> std::ws >> c && c != '#') {
2294 bool readSuccess() {
2295 return static_cast<bool>(*_is);
2298 void skipSection() {
2300 while (readSuccess() && line >> c && c != '@') {
2303 if (readSuccess()) {
2311 /// \name Execution of the Reader
2314 /// \brief Start the batch processing
2316 /// This function starts the batch processing.
2319 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
2321 std::set<std::string> extra_sections;
2327 while (readSuccess()) {
2330 std::string section, caption;
2332 _reader_bits::readToken(line, section);
2333 _reader_bits::readToken(line, caption);
2336 throw FormatError("Extra character at the end of line");
2338 if (extra_sections.find(section) != extra_sections.end()) {
2339 std::ostringstream msg;
2340 msg << "Multiple occurence of section: " << section;
2341 throw FormatError(msg.str());
2343 Sections::iterator it = _sections.find(section);
2344 if (it != _sections.end()) {
2345 extra_sections.insert(section);
2346 it->second->process(*_is, line_num);
2350 } catch (FormatError& error) {
2351 error.line(line_num);
2352 error.file(_filename);
2356 for (Sections::iterator it = _sections.begin();
2357 it != _sections.end(); ++it) {
2358 if (extra_sections.find(it->first) == extra_sections.end()) {
2359 std::ostringstream os;
2360 os << "Cannot find section: " << it->first;
2361 throw FormatError(os.str());
2370 /// \ingroup lemon_io
2372 /// \brief Return a \ref SectionReader class
2374 /// This function just returns a \ref SectionReader class.
2376 /// Please see SectionReader documentation about the custom section
2379 /// \relates SectionReader
2380 /// \sa sectionReader(const std::string& fn)
2381 /// \sa sectionReader(const char *fn)
2382 inline SectionReader sectionReader(std::istream& is) {
2383 SectionReader tmp(is);
2387 /// \brief Return a \ref SectionReader class
2389 /// This function just returns a \ref SectionReader class.
2390 /// \relates SectionReader
2391 /// \sa sectionReader(std::istream& is)
2392 inline SectionReader sectionReader(const std::string& fn) {
2393 SectionReader tmp(fn);
2397 /// \brief Return a \ref SectionReader class
2399 /// This function just returns a \ref SectionReader class.
2400 /// \relates SectionReader
2401 /// \sa sectionReader(std::istream& is)
2402 inline SectionReader sectionReader(const char* fn) {
2403 SectionReader tmp(fn);
2407 /// \ingroup lemon_io
2409 /// \brief Reader for the contents of the \ref lgf-format "LGF" file
2411 /// This class can be used to read the sections, the map names and
2412 /// the attributes from a file. Usually, the LEMON programs know
2413 /// that, which type of graph, which maps and which attributes
2414 /// should be read from a file, but in general tools (like glemon)
2415 /// the contents of an LGF file should be guessed somehow. This class
2416 /// reads the graph and stores the appropriate information for
2417 /// reading the graph.
2420 /// LgfContents contents("graph.lgf");
2423 /// // Does it contain any node section and arc section?
2424 /// if (contents.nodeSectionNum() == 0 || contents.arcSectionNum()) {
2425 /// std::cerr << "Failure, cannot find graph." << std::endl;
2428 /// std::cout << "The name of the default node section: "
2429 /// << contents.nodeSection(0) << std::endl;
2430 /// std::cout << "The number of the arc maps: "
2431 /// << contents.arcMaps(0).size() << std::endl;
2432 /// std::cout << "The name of second arc map: "
2433 /// << contents.arcMaps(0)[1] << std::endl;
2441 std::vector<std::string> _node_sections;
2442 std::vector<std::string> _edge_sections;
2443 std::vector<std::string> _attribute_sections;
2444 std::vector<std::string> _extra_sections;
2446 std::vector<bool> _arc_sections;
2448 std::vector<std::vector<std::string> > _node_maps;
2449 std::vector<std::vector<std::string> > _edge_maps;
2451 std::vector<std::vector<std::string> > _attributes;
2455 std::istringstream line;
2459 /// \brief Constructor
2461 /// Construct an \e LGF contents reader, which reads from the given
2463 LgfContents(std::istream& is)
2464 : _is(&is), local_is(false) {}
2466 /// \brief Constructor
2468 /// Construct an \e LGF contents reader, which reads from the given
2470 LgfContents(const std::string& fn)
2471 : _is(new std::ifstream(fn.c_str())), local_is(true) {
2474 throw IoError("Cannot open file", fn);
2478 /// \brief Constructor
2480 /// Construct an \e LGF contents reader, which reads from the given
2482 LgfContents(const char* fn)
2483 : _is(new std::ifstream(fn)), local_is(true) {
2486 throw IoError("Cannot open file", fn);
2490 /// \brief Destructor
2492 if (local_is) delete _is;
2497 LgfContents(const LgfContents&);
2498 LgfContents& operator=(const LgfContents&);
2503 /// \name Node Sections
2506 /// \brief Gives back the number of node sections in the file.
2508 /// Gives back the number of node sections in the file.
2509 int nodeSectionNum() const {
2510 return _node_sections.size();
2513 /// \brief Returns the node section name at the given position.
2515 /// Returns the node section name at the given position.
2516 const std::string& nodeSection(int i) const {
2517 return _node_sections[i];
2520 /// \brief Gives back the node maps for the given section.
2522 /// Gives back the node maps for the given section.
2523 const std::vector<std::string>& nodeMapNames(int i) const {
2524 return _node_maps[i];
2529 /// \name Arc/Edge Sections
2532 /// \brief Gives back the number of arc/edge sections in the file.
2534 /// Gives back the number of arc/edge sections in the file.
2535 /// \note It is synonym of \c edgeSectionNum().
2536 int arcSectionNum() const {
2537 return _edge_sections.size();
2540 /// \brief Returns the arc/edge section name at the given position.
2542 /// Returns the arc/edge section name at the given position.
2543 /// \note It is synonym of \c edgeSection().
2544 const std::string& arcSection(int i) const {
2545 return _edge_sections[i];
2548 /// \brief Gives back the arc/edge maps for the given section.
2550 /// Gives back the arc/edge maps for the given section.
2551 /// \note It is synonym of \c edgeMapNames().
2552 const std::vector<std::string>& arcMapNames(int i) const {
2553 return _edge_maps[i];
2561 /// \brief Gives back the number of arc/edge sections in the file.
2563 /// Gives back the number of arc/edge sections in the file.
2564 /// \note It is synonym of \c arcSectionNum().
2565 int edgeSectionNum() const {
2566 return _edge_sections.size();
2569 /// \brief Returns the section name at the given position.
2571 /// Returns the section name at the given position.
2572 /// \note It is synonym of \c arcSection().
2573 const std::string& edgeSection(int i) const {
2574 return _edge_sections[i];
2577 /// \brief Gives back the edge maps for the given section.
2579 /// Gives back the edge maps for the given section.
2580 /// \note It is synonym of \c arcMapNames().
2581 const std::vector<std::string>& edgeMapNames(int i) const {
2582 return _edge_maps[i];
2587 /// \name Attribute Sections
2590 /// \brief Gives back the number of attribute sections in the file.
2592 /// Gives back the number of attribute sections in the file.
2593 int attributeSectionNum() const {
2594 return _attribute_sections.size();
2597 /// \brief Returns the attribute section name at the given position.
2599 /// Returns the attribute section name at the given position.
2600 const std::string& attributeSectionNames(int i) const {
2601 return _attribute_sections[i];
2604 /// \brief Gives back the attributes for the given section.
2606 /// Gives back the attributes for the given section.
2607 const std::vector<std::string>& attributes(int i) const {
2608 return _attributes[i];
2613 /// \name Extra Sections
2616 /// \brief Gives back the number of extra sections in the file.
2618 /// Gives back the number of extra sections in the file.
2619 int extraSectionNum() const {
2620 return _extra_sections.size();
2623 /// \brief Returns the extra section type at the given position.
2625 /// Returns the section type at the given position.
2626 const std::string& extraSection(int i) const {
2627 return _extra_sections[i];
2636 while(++line_num, std::getline(*_is, str)) {
2637 line.clear(); line.str(str);
2639 if (line >> std::ws >> c && c != '#') {
2647 bool readSuccess() {
2648 return static_cast<bool>(*_is);
2651 void skipSection() {
2653 while (readSuccess() && line >> c && c != '@') {
2656 if (readSuccess()) {
2661 void readMaps(std::vector<std::string>& maps) {
2663 if (!readLine() || !(line >> c) || c == '@') {
2664 if (readSuccess() && line) line.putback(c);
2669 while (_reader_bits::readToken(line, map)) {
2670 maps.push_back(map);
2674 void readAttributes(std::vector<std::string>& attrs) {
2677 while (readSuccess() && line >> c && c != '@') {
2680 _reader_bits::readToken(line, attr);
2681 attrs.push_back(attr);
2689 /// \name Execution of the Contents Reader
2692 /// \brief Starts the reading
2694 /// This function starts the reading.
2700 while (readSuccess()) {
2705 std::string section, caption;
2706 _reader_bits::readToken(line, section);
2707 _reader_bits::readToken(line, caption);
2709 if (section == "nodes") {
2710 _node_sections.push_back(caption);
2711 _node_maps.push_back(std::vector<std::string>());
2712 readMaps(_node_maps.back());
2713 readLine(); skipSection();
2714 } else if (section == "arcs" || section == "edges") {
2715 _edge_sections.push_back(caption);
2716 _arc_sections.push_back(section == "arcs");
2717 _edge_maps.push_back(std::vector<std::string>());
2718 readMaps(_edge_maps.back());
2719 readLine(); skipSection();
2720 } else if (section == "attributes") {
2721 _attribute_sections.push_back(caption);
2722 _attributes.push_back(std::vector<std::string>());
2723 readAttributes(_attributes.back());
2725 _extra_sections.push_back(section);
2726 readLine(); skipSection();