3 * This file is a part of LEMON, a generic C++ optimization library
5 * Copyright (C) 2003-2008
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/assert.h>
35 #include <lemon/graph_utils.h>
37 #include <lemon/lgf_writer.h>
39 #include <lemon/concept_check.h>
40 #include <lemon/concepts/maps.h>
44 namespace _reader_bits {
46 template <typename Value>
47 struct DefaultConverter {
48 Value operator()(const std::string& str) {
49 std::istringstream is(str);
54 if (is >> std::ws >> c) {
55 throw DataFormatError("Remaining characters in token");
62 struct DefaultConverter<std::string> {
63 std::string operator()(const std::string& str) {
68 template <typename _Item>
69 class MapStorageBase {
75 virtual ~MapStorageBase() {}
77 virtual void set(const Item& item, const std::string& value) = 0;
81 template <typename _Item, typename _Map,
82 typename _Converter = DefaultConverter<typename _Map::Value> >
83 class MapStorage : public MapStorageBase<_Item> {
86 typedef _Converter Converter;
94 MapStorage(Map& map, const Converter& converter = Converter())
95 : _map(map), _converter(converter) {}
96 virtual ~MapStorage() {}
98 virtual void set(const Item& item ,const std::string& value) {
99 _map.set(item, _converter(value));
103 template <typename _Graph, bool _dir, typename _Map,
104 typename _Converter = DefaultConverter<typename _Map::Value> >
105 class GraphArcMapStorage : public MapStorageBase<typename _Graph::Edge> {
108 typedef _Converter Converter;
109 typedef _Graph Graph;
110 typedef typename Graph::Edge Item;
111 static const bool dir = _dir;
116 Converter _converter;
119 GraphArcMapStorage(const Graph& graph, Map& map,
120 const Converter& converter = Converter())
121 : _graph(graph), _map(map), _converter(converter) {}
122 virtual ~GraphArcMapStorage() {}
124 virtual void set(const Item& item ,const std::string& value) {
125 _map.set(_graph.direct(item, dir), _converter(value));
129 class ValueStorageBase {
131 ValueStorageBase() {}
132 virtual ~ValueStorageBase() {}
134 virtual void set(const std::string&) = 0;
137 template <typename _Value, typename _Converter = DefaultConverter<_Value> >
138 class ValueStorage : public ValueStorageBase {
140 typedef _Value Value;
141 typedef _Converter Converter;
145 Converter _converter;
148 ValueStorage(Value& value, const Converter& converter = Converter())
149 : _value(value), _converter(converter) {}
151 virtual void set(const std::string& value) {
152 _value = _converter(value);
156 template <typename Value>
157 struct MapLookUpConverter {
158 const std::map<std::string, Value>& _map;
160 MapLookUpConverter(const std::map<std::string, Value>& map)
163 Value operator()(const std::string& str) {
164 typename std::map<std::string, Value>::const_iterator it =
166 if (it == _map.end()) {
167 std::ostringstream msg;
168 msg << "Item not found: " << str;
169 throw DataFormatError(msg.str().c_str());
175 template <typename Graph>
176 struct GraphArcLookUpConverter {
178 const std::map<std::string, typename Graph::Edge>& _map;
180 GraphArcLookUpConverter(const Graph& graph,
181 const std::map<std::string,
182 typename Graph::Edge>& map)
183 : _graph(graph), _map(map) {}
185 typename Graph::Arc operator()(const std::string& str) {
186 if (str.empty() || (str[0] != '+' && str[0] != '-')) {
187 throw DataFormatError("Item must start with '+' or '-'");
189 typename std::map<std::string, typename Graph::Edge>
190 ::const_iterator it = _map.find(str.substr(1));
191 if (it == _map.end()) {
192 throw DataFormatError("Item not found");
194 return _graph.direct(it->second, str[0] == '+');
198 inline bool isWhiteSpace(char c) {
199 return c == ' ' || c == '\t' || c == '\v' ||
200 c == '\n' || c == '\r' || c == '\f';
203 inline bool isOct(char c) {
204 return '0' <= c && c <='7';
207 inline int valueOct(char c) {
208 LEMON_ASSERT(isOct(c), "The character is not octal.");
212 inline bool isHex(char c) {
213 return ('0' <= c && c <= '9') ||
214 ('a' <= c && c <= 'z') ||
215 ('A' <= c && c <= 'Z');
218 inline int valueHex(char c) {
219 LEMON_ASSERT(isHex(c), "The character is not hexadecimal.");
220 if ('0' <= c && c <= '9') return c - '0';
221 if ('a' <= c && c <= 'z') return c - 'a' + 10;
225 inline bool isIdentifierFirstChar(char c) {
226 return ('a' <= c && c <= 'z') ||
227 ('A' <= c && c <= 'Z') || c == '_';
230 inline bool isIdentifierChar(char c) {
231 return isIdentifierFirstChar(c) ||
232 ('0' <= c && c <= '9');
235 inline char readEscape(std::istream& is) {
238 throw DataFormatError("Escape format error");
266 if (!is.get(c) || !isHex(c))
267 throw DataFormatError("Escape format error");
268 else if (code = valueHex(c), !is.get(c) || !isHex(c)) is.putback(c);
269 else code = code * 16 + valueHex(c);
276 throw DataFormatError("Escape format error");
277 else if (code = valueOct(c), !is.get(c) || !isOct(c))
279 else if (code = code * 8 + valueOct(c), !is.get(c) || !isOct(c))
281 else code = code * 8 + valueOct(c);
287 inline std::istream& readToken(std::istream& is, std::string& str) {
288 std::ostringstream os;
297 while (is.get(c) && c != '\"') {
303 throw DataFormatError("Quoted format error");
306 while (is.get(c) && !isWhiteSpace(c)) {
323 virtual ~Section() {}
324 virtual void process(std::istream& is, int& line_num) = 0;
327 template <typename Functor>
328 class LineSection : public Section {
335 LineSection(const Functor& functor) : _functor(functor) {}
336 virtual ~LineSection() {}
338 virtual void process(std::istream& is, int& line_num) {
341 while (is.get(c) && c != '@') {
344 } else if (c == '#') {
347 } else if (!isWhiteSpace(c)) {
354 if (is) is.putback(c);
355 else if (is.eof()) is.clear();
359 template <typename Functor>
360 class StreamSection : public Section {
367 StreamSection(const Functor& functor) : _functor(functor) {}
368 virtual ~StreamSection() {}
370 virtual void process(std::istream& is, int& line_num) {
371 _functor(is, line_num);
374 while (is.get(c) && c != '@') {
377 } else if (!isWhiteSpace(c)) {
382 if (is) is.putback(c);
383 else if (is.eof()) is.clear();
389 template <typename Digraph>
392 template <typename Digraph>
393 DigraphReader<Digraph> digraphReader(std::istream& is, Digraph& digraph);
395 template <typename Digraph>
396 DigraphReader<Digraph> digraphReader(const std::string& fn, Digraph& digraph);
398 template <typename Digraph>
399 DigraphReader<Digraph> digraphReader(const char *fn, Digraph& digraph);
401 /// \ingroup lemon_io
403 /// \brief \ref lgf-format "LGF" reader for directed graphs
405 /// This utility reads an \ref lgf-format "LGF" file.
407 /// The reading method does a batch processing. The user creates a
408 /// reader object, then various reading rules can be added to the
409 /// reader, and eventually the reading is executed with the \c run()
410 /// member function. A map reading rule can be added to the reader
411 /// with the \c nodeMap() or \c arcMap() members. An optional
412 /// converter parameter can also be added as a standard functor
413 /// converting from \c std::string to the value type of the map. If it
414 /// is set, it will determine how the tokens in the file should be
415 /// converted to the value type of the map. If the functor is not set,
416 /// then a default conversion will be used. One map can be read into
417 /// multiple map objects at the same time. The \c attribute(), \c
418 /// node() and \c arc() functions are used to add attribute reading
422 /// DigraphReader<Digraph>(std::cin, digraph).
423 /// nodeMap("coordinates", coord_map).
424 /// arcMap("capacity", cap_map).
425 /// node("source", src).
426 /// node("target", trg).
427 /// attribute("caption", caption).
431 /// By default the reader uses the first section in the file of the
432 /// proper type. If a section has an optional name, then it can be
433 /// selected for reading by giving an optional name parameter to the
434 /// \c nodes(), \c arcs() or \c attributes() functions.
436 /// The \c useNodes() and \c useArcs() functions are used to tell the reader
437 /// that the nodes or arcs should not be constructed (added to the
438 /// graph) during the reading, but instead the label map of the items
439 /// are given as a parameter of these functions. An
440 /// application of these functions is multipass reading, which is
441 /// important if two \c \@arcs sections must be read from the
442 /// file. In this case the first phase would read the node set and one
443 /// of the arc sets, while the second phase would read the second arc
444 /// set into an \e ArcSet class (\c SmartArcSet or \c ListArcSet).
445 /// The previously read label node map should be passed to the \c
446 /// useNodes() functions. Another application of multipass reading when
447 /// paths are given as a node map or an arc map. It is impossible to read this in
448 /// a single pass, because the arcs are not constructed when the node
450 template <typename _Digraph>
451 class DigraphReader {
454 typedef _Digraph Digraph;
455 TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
465 std::string _nodes_caption;
466 std::string _arcs_caption;
467 std::string _attributes_caption;
469 typedef std::map<std::string, Node> NodeIndex;
470 NodeIndex _node_index;
471 typedef std::map<std::string, Arc> ArcIndex;
474 typedef std::vector<std::pair<std::string,
475 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
478 typedef std::vector<std::pair<std::string,
479 _reader_bits::MapStorageBase<Arc>*> >ArcMaps;
482 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
484 Attributes _attributes;
493 std::istringstream line;
497 /// \brief Constructor
499 /// Construct a directed graph reader, which reads from the given
501 DigraphReader(std::istream& is, Digraph& digraph)
502 : _is(&is), local_is(false), _digraph(digraph),
503 _use_nodes(false), _use_arcs(false),
504 _skip_nodes(false), _skip_arcs(false) {}
506 /// \brief Constructor
508 /// Construct a directed graph reader, which reads from the given
510 DigraphReader(const std::string& fn, Digraph& digraph)
511 : _is(new std::ifstream(fn.c_str())), local_is(true), _digraph(digraph),
512 _use_nodes(false), _use_arcs(false),
513 _skip_nodes(false), _skip_arcs(false) {}
515 /// \brief Constructor
517 /// Construct a directed graph reader, which reads from the given
519 DigraphReader(const char* fn, Digraph& digraph)
520 : _is(new std::ifstream(fn)), local_is(true), _digraph(digraph),
521 _use_nodes(false), _use_arcs(false),
522 _skip_nodes(false), _skip_arcs(false) {}
524 /// \brief Destructor
526 for (typename NodeMaps::iterator it = _node_maps.begin();
527 it != _node_maps.end(); ++it) {
531 for (typename ArcMaps::iterator it = _arc_maps.begin();
532 it != _arc_maps.end(); ++it) {
536 for (typename Attributes::iterator it = _attributes.begin();
537 it != _attributes.end(); ++it) {
549 friend DigraphReader<Digraph> digraphReader<>(std::istream& is,
551 friend DigraphReader<Digraph> digraphReader<>(const std::string& fn,
553 friend DigraphReader<Digraph> digraphReader<>(const char *fn,
556 DigraphReader(DigraphReader& other)
557 : _is(other._is), local_is(other.local_is), _digraph(other._digraph),
558 _use_nodes(other._use_nodes), _use_arcs(other._use_arcs),
559 _skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {
562 other.local_is = false;
564 _node_index.swap(other._node_index);
565 _arc_index.swap(other._arc_index);
567 _node_maps.swap(other._node_maps);
568 _arc_maps.swap(other._arc_maps);
569 _attributes.swap(other._attributes);
571 _nodes_caption = other._nodes_caption;
572 _arcs_caption = other._arcs_caption;
573 _attributes_caption = other._attributes_caption;
577 DigraphReader& operator=(const DigraphReader&);
581 /// \name Reading rules
584 /// \brief Node map reading rule
586 /// Add a node map reading rule to the reader.
587 template <typename Map>
588 DigraphReader& nodeMap(const std::string& caption, Map& map) {
589 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
590 _reader_bits::MapStorageBase<Node>* storage =
591 new _reader_bits::MapStorage<Node, Map>(map);
592 _node_maps.push_back(std::make_pair(caption, storage));
596 /// \brief Node map reading rule
598 /// Add a node map reading rule with specialized converter to the
600 template <typename Map, typename Converter>
601 DigraphReader& nodeMap(const std::string& caption, Map& map,
602 const Converter& converter = Converter()) {
603 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
604 _reader_bits::MapStorageBase<Node>* storage =
605 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
606 _node_maps.push_back(std::make_pair(caption, storage));
610 /// \brief Arc map reading rule
612 /// Add an arc map reading rule to the reader.
613 template <typename Map>
614 DigraphReader& arcMap(const std::string& caption, Map& map) {
615 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
616 _reader_bits::MapStorageBase<Arc>* storage =
617 new _reader_bits::MapStorage<Arc, Map>(map);
618 _arc_maps.push_back(std::make_pair(caption, storage));
622 /// \brief Arc map reading rule
624 /// Add an arc map reading rule with specialized converter to the
626 template <typename Map, typename Converter>
627 DigraphReader& arcMap(const std::string& caption, Map& map,
628 const Converter& converter = Converter()) {
629 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
630 _reader_bits::MapStorageBase<Arc>* storage =
631 new _reader_bits::MapStorage<Arc, Map, Converter>(map, converter);
632 _arc_maps.push_back(std::make_pair(caption, storage));
636 /// \brief Attribute reading rule
638 /// Add an attribute reading rule to the reader.
639 template <typename Value>
640 DigraphReader& attribute(const std::string& caption, Value& value) {
641 _reader_bits::ValueStorageBase* storage =
642 new _reader_bits::ValueStorage<Value>(value);
643 _attributes.insert(std::make_pair(caption, storage));
647 /// \brief Attribute reading rule
649 /// Add an attribute reading rule with specialized converter to the
651 template <typename Value, typename Converter>
652 DigraphReader& attribute(const std::string& caption, Value& value,
653 const Converter& converter = Converter()) {
654 _reader_bits::ValueStorageBase* storage =
655 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
656 _attributes.insert(std::make_pair(caption, storage));
660 /// \brief Node reading rule
662 /// Add a node reading rule to reader.
663 DigraphReader& node(const std::string& caption, Node& node) {
664 typedef _reader_bits::MapLookUpConverter<Node> Converter;
665 Converter converter(_node_index);
666 _reader_bits::ValueStorageBase* storage =
667 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
668 _attributes.insert(std::make_pair(caption, storage));
672 /// \brief Arc reading rule
674 /// Add an arc reading rule to reader.
675 DigraphReader& arc(const std::string& caption, Arc& arc) {
676 typedef _reader_bits::MapLookUpConverter<Arc> Converter;
677 Converter converter(_arc_index);
678 _reader_bits::ValueStorageBase* storage =
679 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
680 _attributes.insert(std::make_pair(caption, storage));
686 /// \name Select section by name
689 /// \brief Set \c \@nodes section to be read
691 /// Set \c \@nodes section to be read
692 DigraphReader& nodes(const std::string& caption) {
693 _nodes_caption = caption;
697 /// \brief Set \c \@arcs section to be read
699 /// Set \c \@arcs section to be read
700 DigraphReader& arcs(const std::string& caption) {
701 _arcs_caption = caption;
705 /// \brief Set \c \@attributes section to be read
707 /// Set \c \@attributes section to be read
708 DigraphReader& attributes(const std::string& caption) {
709 _attributes_caption = caption;
715 /// \name Using previously constructed node or arc set
718 /// \brief Use previously constructed node set
720 /// Use previously constructed node set, and specify the node
722 template <typename Map>
723 DigraphReader& useNodes(const Map& map) {
724 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
725 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
727 _writer_bits::DefaultConverter<typename Map::Value> converter;
728 for (NodeIt n(_digraph); n != INVALID; ++n) {
729 _node_index.insert(std::make_pair(converter(map[n]), n));
734 /// \brief Use previously constructed node set
736 /// Use previously constructed node set, and specify the node
737 /// label map and a functor which converts the label map values to
739 template <typename Map, typename Converter>
740 DigraphReader& useNodes(const Map& map,
741 const Converter& converter = Converter()) {
742 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
743 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
745 for (NodeIt n(_digraph); n != INVALID; ++n) {
746 _node_index.insert(std::make_pair(converter(map[n]), n));
751 /// \brief Use previously constructed arc set
753 /// Use previously constructed arc set, and specify the arc
755 template <typename Map>
756 DigraphReader& useArcs(const Map& map) {
757 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
758 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
760 _writer_bits::DefaultConverter<typename Map::Value> converter;
761 for (ArcIt a(_digraph); a != INVALID; ++a) {
762 _arc_index.insert(std::make_pair(converter(map[a]), a));
767 /// \brief Use previously constructed arc set
769 /// Use previously constructed arc set, and specify the arc
770 /// label map and a functor which converts the label map values to
772 template <typename Map, typename Converter>
773 DigraphReader& useArcs(const Map& map,
774 const Converter& converter = Converter()) {
775 checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
776 LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
778 for (ArcIt a(_digraph); a != INVALID; ++a) {
779 _arc_index.insert(std::make_pair(converter(map[a]), a));
784 /// \brief Skips the reading of node section
786 /// Omit the reading of the node section. This implies that each node
787 /// map reading rule will be abandoned, and the nodes of the graph
788 /// will not be constructed, which usually cause that the arc set
789 /// could not be read due to lack of node name resolving.
790 /// Therefore \c skipArcs() function should also be used, or
791 /// \c useNodes() should be used to specify the label of the nodes.
792 DigraphReader& skipNodes() {
793 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
798 /// \brief Skips the reading of arc section
800 /// Omit the reading of the arc section. This implies that each arc
801 /// map reading rule will be abandoned, and the arcs of the graph
802 /// will not be constructed.
803 DigraphReader& skipArcs() {
804 LEMON_ASSERT(!_skip_arcs, "Skip arcs already set");
815 while(++line_num, std::getline(*_is, str)) {
816 line.clear(); line.str(str);
818 if (line >> std::ws >> c && c != '#') {
827 return static_cast<bool>(*_is);
832 while (readSuccess() && line >> c && c != '@') {
840 std::vector<int> map_index(_node_maps.size());
841 int map_num, label_index;
844 if (!readLine() || !(line >> c) || c == '@') {
845 if (readSuccess() && line) line.putback(c);
846 if (!_node_maps.empty())
847 throw DataFormatError("Cannot find map names");
853 std::map<std::string, int> maps;
857 while (_reader_bits::readToken(line, map)) {
858 if (maps.find(map) != maps.end()) {
859 std::ostringstream msg;
860 msg << "Multiple occurence of node map: " << map;
861 throw DataFormatError(msg.str().c_str());
863 maps.insert(std::make_pair(map, index));
867 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
868 std::map<std::string, int>::iterator jt =
869 maps.find(_node_maps[i].first);
870 if (jt == maps.end()) {
871 std::ostringstream msg;
872 msg << "Map not found in file: " << _node_maps[i].first;
873 throw DataFormatError(msg.str().c_str());
875 map_index[i] = jt->second;
879 std::map<std::string, int>::iterator jt = maps.find("label");
880 if (jt != maps.end()) {
881 label_index = jt->second;
886 map_num = maps.size();
889 while (readLine() && line >> c && c != '@') {
892 std::vector<std::string> tokens(map_num);
893 for (int i = 0; i < map_num; ++i) {
894 if (!_reader_bits::readToken(line, tokens[i])) {
895 std::ostringstream msg;
896 msg << "Column not found (" << i + 1 << ")";
897 throw DataFormatError(msg.str().c_str());
900 if (line >> std::ws >> c)
901 throw DataFormatError("Extra character on the end of line");
905 n = _digraph.addNode();
906 if (label_index != -1)
907 _node_index.insert(std::make_pair(tokens[label_index], n));
909 if (label_index == -1)
910 throw DataFormatError("Label map not found in file");
911 typename std::map<std::string, Node>::iterator it =
912 _node_index.find(tokens[label_index]);
913 if (it == _node_index.end()) {
914 std::ostringstream msg;
915 msg << "Node with label not found: " << tokens[label_index];
916 throw DataFormatError(msg.str().c_str());
921 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
922 _node_maps[i].second->set(n, tokens[map_index[i]]);
933 std::vector<int> map_index(_arc_maps.size());
934 int map_num, label_index;
937 if (!readLine() || !(line >> c) || c == '@') {
938 if (readSuccess() && line) line.putback(c);
939 if (!_arc_maps.empty())
940 throw DataFormatError("Cannot find map names");
946 std::map<std::string, int> maps;
950 while (_reader_bits::readToken(line, map)) {
951 if (maps.find(map) != maps.end()) {
952 std::ostringstream msg;
953 msg << "Multiple occurence of arc map: " << map;
954 throw DataFormatError(msg.str().c_str());
956 maps.insert(std::make_pair(map, index));
960 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
961 std::map<std::string, int>::iterator jt =
962 maps.find(_arc_maps[i].first);
963 if (jt == maps.end()) {
964 std::ostringstream msg;
965 msg << "Map not found in file: " << _arc_maps[i].first;
966 throw DataFormatError(msg.str().c_str());
968 map_index[i] = jt->second;
972 std::map<std::string, int>::iterator jt = maps.find("label");
973 if (jt != maps.end()) {
974 label_index = jt->second;
979 map_num = maps.size();
982 while (readLine() && line >> c && c != '@') {
985 std::string source_token;
986 std::string target_token;
988 if (!_reader_bits::readToken(line, source_token))
989 throw DataFormatError("Source not found");
991 if (!_reader_bits::readToken(line, target_token))
992 throw DataFormatError("Target not found");
994 std::vector<std::string> tokens(map_num);
995 for (int i = 0; i < map_num; ++i) {
996 if (!_reader_bits::readToken(line, tokens[i])) {
997 std::ostringstream msg;
998 msg << "Column not found (" << i + 1 << ")";
999 throw DataFormatError(msg.str().c_str());
1002 if (line >> std::ws >> c)
1003 throw DataFormatError("Extra character on the end of line");
1008 typename NodeIndex::iterator it;
1010 it = _node_index.find(source_token);
1011 if (it == _node_index.end()) {
1012 std::ostringstream msg;
1013 msg << "Item not found: " << source_token;
1014 throw DataFormatError(msg.str().c_str());
1016 Node source = it->second;
1018 it = _node_index.find(target_token);
1019 if (it == _node_index.end()) {
1020 std::ostringstream msg;
1021 msg << "Item not found: " << target_token;
1022 throw DataFormatError(msg.str().c_str());
1024 Node target = it->second;
1026 a = _digraph.addArc(source, target);
1027 if (label_index != -1)
1028 _arc_index.insert(std::make_pair(tokens[label_index], a));
1030 if (label_index == -1)
1031 throw DataFormatError("Label map not found in file");
1032 typename std::map<std::string, Arc>::iterator it =
1033 _arc_index.find(tokens[label_index]);
1034 if (it == _arc_index.end()) {
1035 std::ostringstream msg;
1036 msg << "Arc with label not found: " << tokens[label_index];
1037 throw DataFormatError(msg.str().c_str());
1042 for (int i = 0; i < static_cast<int>(_arc_maps.size()); ++i) {
1043 _arc_maps[i].second->set(a, tokens[map_index[i]]);
1047 if (readSuccess()) {
1052 void readAttributes() {
1054 std::set<std::string> read_attr;
1057 while (readLine() && line >> c && c != '@') {
1060 std::string attr, token;
1061 if (!_reader_bits::readToken(line, attr))
1062 throw DataFormatError("Attribute name not found");
1063 if (!_reader_bits::readToken(line, token))
1064 throw DataFormatError("Attribute value not found");
1066 throw DataFormatError("Extra character on the end of line");
1069 std::set<std::string>::iterator it = read_attr.find(attr);
1070 if (it != read_attr.end()) {
1071 std::ostringstream msg;
1072 msg << "Multiple occurence of attribute " << attr;
1073 throw DataFormatError(msg.str().c_str());
1075 read_attr.insert(attr);
1079 typename Attributes::iterator it = _attributes.lower_bound(attr);
1080 while (it != _attributes.end() && it->first == attr) {
1081 it->second->set(token);
1087 if (readSuccess()) {
1090 for (typename Attributes::iterator it = _attributes.begin();
1091 it != _attributes.end(); ++it) {
1092 if (read_attr.find(it->first) == read_attr.end()) {
1093 std::ostringstream msg;
1094 msg << "Attribute not found in file: " << it->first;
1095 throw DataFormatError(msg.str().c_str());
1102 /// \name Execution of the reader
1105 /// \brief Start the batch processing
1107 /// This function starts the batch processing
1109 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1111 throw DataFormatError("Cannot find file");
1114 bool nodes_done = _skip_nodes;
1115 bool arcs_done = _skip_arcs;
1116 bool attributes_done = false;
1122 while (readSuccess()) {
1125 std::string section, caption;
1127 _reader_bits::readToken(line, section);
1128 _reader_bits::readToken(line, caption);
1131 throw DataFormatError("Extra character on the end of line");
1133 if (section == "nodes" && !nodes_done) {
1134 if (_nodes_caption.empty() || _nodes_caption == caption) {
1138 } else if ((section == "arcs" || section == "edges") &&
1140 if (_arcs_caption.empty() || _arcs_caption == caption) {
1144 } else if (section == "attributes" && !attributes_done) {
1145 if (_attributes_caption.empty() || _attributes_caption == caption) {
1147 attributes_done = true;
1153 } catch (DataFormatError& error) {
1154 error.line(line_num);
1160 throw DataFormatError("Section @nodes not found");
1164 throw DataFormatError("Section @arcs not found");
1167 if (!attributes_done && !_attributes.empty()) {
1168 throw DataFormatError("Section @attributes not found");
1177 /// \brief Return a \ref DigraphReader class
1179 /// This function just returns a \ref DigraphReader class.
1180 /// \relates DigraphReader
1181 template <typename Digraph>
1182 DigraphReader<Digraph> digraphReader(std::istream& is, Digraph& digraph) {
1183 DigraphReader<Digraph> tmp(is, digraph);
1187 /// \brief Return a \ref DigraphReader class
1189 /// This function just returns a \ref DigraphReader class.
1190 /// \relates DigraphReader
1191 template <typename Digraph>
1192 DigraphReader<Digraph> digraphReader(const std::string& fn,
1194 DigraphReader<Digraph> tmp(fn, digraph);
1198 /// \brief Return a \ref DigraphReader class
1200 /// This function just returns a \ref DigraphReader class.
1201 /// \relates DigraphReader
1202 template <typename Digraph>
1203 DigraphReader<Digraph> digraphReader(const char* fn, Digraph& digraph) {
1204 DigraphReader<Digraph> tmp(fn, digraph);
1208 template <typename Graph>
1211 template <typename Graph>
1212 GraphReader<Graph> graphReader(std::istream& is, Graph& graph);
1214 template <typename Graph>
1215 GraphReader<Graph> graphReader(const std::string& fn, Graph& graph);
1217 template <typename Graph>
1218 GraphReader<Graph> graphReader(const char *fn, Graph& graph);
1220 /// \ingroup lemon_io
1222 /// \brief \ref lgf-format "LGF" reader for undirected graphs
1224 /// This utility reads an \ref lgf-format "LGF" file.
1226 /// It can be used almost the same way as \c DigraphReader.
1227 /// The only difference is that this class can handle edges and
1228 /// edge maps as well as arcs and arc maps.
1230 /// The columns in the \c \@edges (or \c \@arcs) section are the
1231 /// edge maps. However, if there are two maps with the same name
1232 /// prefixed with \c '+' and \c '-', then these can be read into an
1233 /// arc map. Similarly, an attribute can be read into an arc, if
1234 /// it's value is an edge label prefixed with \c '+' or \c '-'.
1235 template <typename _Graph>
1239 typedef _Graph Graph;
1240 TEMPLATE_GRAPH_TYPEDEFS(Graph);
1249 std::string _nodes_caption;
1250 std::string _edges_caption;
1251 std::string _attributes_caption;
1253 typedef std::map<std::string, Node> NodeIndex;
1254 NodeIndex _node_index;
1255 typedef std::map<std::string, Edge> EdgeIndex;
1256 EdgeIndex _edge_index;
1258 typedef std::vector<std::pair<std::string,
1259 _reader_bits::MapStorageBase<Node>*> > NodeMaps;
1260 NodeMaps _node_maps;
1262 typedef std::vector<std::pair<std::string,
1263 _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;
1264 EdgeMaps _edge_maps;
1266 typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
1268 Attributes _attributes;
1277 std::istringstream line;
1281 /// \brief Constructor
1283 /// Construct an undirected graph reader, which reads from the given
1285 GraphReader(std::istream& is, Graph& graph)
1286 : _is(&is), local_is(false), _graph(graph),
1287 _use_nodes(false), _use_edges(false),
1288 _skip_nodes(false), _skip_edges(false) {}
1290 /// \brief Constructor
1292 /// Construct an undirected graph reader, which reads from the given
1294 GraphReader(const std::string& fn, Graph& graph)
1295 : _is(new std::ifstream(fn.c_str())), local_is(true), _graph(graph),
1296 _use_nodes(false), _use_edges(false),
1297 _skip_nodes(false), _skip_edges(false) {}
1299 /// \brief Constructor
1301 /// Construct an undirected graph reader, which reads from the given
1303 GraphReader(const char* fn, Graph& graph)
1304 : _is(new std::ifstream(fn)), local_is(true), _graph(graph),
1305 _use_nodes(false), _use_edges(false),
1306 _skip_nodes(false), _skip_edges(false) {}
1308 /// \brief Destructor
1310 for (typename NodeMaps::iterator it = _node_maps.begin();
1311 it != _node_maps.end(); ++it) {
1315 for (typename EdgeMaps::iterator it = _edge_maps.begin();
1316 it != _edge_maps.end(); ++it) {
1320 for (typename Attributes::iterator it = _attributes.begin();
1321 it != _attributes.end(); ++it) {
1332 friend GraphReader<Graph> graphReader<>(std::istream& is, Graph& graph);
1333 friend GraphReader<Graph> graphReader<>(const std::string& fn,
1335 friend GraphReader<Graph> graphReader<>(const char *fn, Graph& graph);
1337 GraphReader(GraphReader& other)
1338 : _is(other._is), local_is(other.local_is), _graph(other._graph),
1339 _use_nodes(other._use_nodes), _use_edges(other._use_edges),
1340 _skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
1343 other.local_is = false;
1345 _node_index.swap(other._node_index);
1346 _edge_index.swap(other._edge_index);
1348 _node_maps.swap(other._node_maps);
1349 _edge_maps.swap(other._edge_maps);
1350 _attributes.swap(other._attributes);
1352 _nodes_caption = other._nodes_caption;
1353 _edges_caption = other._edges_caption;
1354 _attributes_caption = other._attributes_caption;
1358 GraphReader& operator=(const GraphReader&);
1362 /// \name Reading rules
1365 /// \brief Node map reading rule
1367 /// Add a node map reading rule to the reader.
1368 template <typename Map>
1369 GraphReader& nodeMap(const std::string& caption, Map& map) {
1370 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1371 _reader_bits::MapStorageBase<Node>* storage =
1372 new _reader_bits::MapStorage<Node, Map>(map);
1373 _node_maps.push_back(std::make_pair(caption, storage));
1377 /// \brief Node map reading rule
1379 /// Add a node map reading rule with specialized converter to the
1381 template <typename Map, typename Converter>
1382 GraphReader& nodeMap(const std::string& caption, Map& map,
1383 const Converter& converter = Converter()) {
1384 checkConcept<concepts::WriteMap<Node, typename Map::Value>, Map>();
1385 _reader_bits::MapStorageBase<Node>* storage =
1386 new _reader_bits::MapStorage<Node, Map, Converter>(map, converter);
1387 _node_maps.push_back(std::make_pair(caption, storage));
1391 /// \brief Edge map reading rule
1393 /// Add an edge map reading rule to the reader.
1394 template <typename Map>
1395 GraphReader& edgeMap(const std::string& caption, Map& map) {
1396 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1397 _reader_bits::MapStorageBase<Edge>* storage =
1398 new _reader_bits::MapStorage<Edge, Map>(map);
1399 _edge_maps.push_back(std::make_pair(caption, storage));
1403 /// \brief Edge map reading rule
1405 /// Add an edge map reading rule with specialized converter to the
1407 template <typename Map, typename Converter>
1408 GraphReader& edgeMap(const std::string& caption, Map& map,
1409 const Converter& converter = Converter()) {
1410 checkConcept<concepts::WriteMap<Edge, typename Map::Value>, Map>();
1411 _reader_bits::MapStorageBase<Edge>* storage =
1412 new _reader_bits::MapStorage<Edge, Map, Converter>(map, converter);
1413 _edge_maps.push_back(std::make_pair(caption, storage));
1417 /// \brief Arc map reading rule
1419 /// Add an arc map reading rule to the reader.
1420 template <typename Map>
1421 GraphReader& arcMap(const std::string& caption, Map& map) {
1422 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1423 _reader_bits::MapStorageBase<Edge>* forward_storage =
1424 new _reader_bits::GraphArcMapStorage<Graph, true, Map>(_graph, map);
1425 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1426 _reader_bits::MapStorageBase<Edge>* backward_storage =
1427 new _reader_bits::GraphArcMapStorage<Graph, false, Map>(_graph, map);
1428 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1432 /// \brief Arc map reading rule
1434 /// Add an arc map reading rule with specialized converter to the
1436 template <typename Map, typename Converter>
1437 GraphReader& arcMap(const std::string& caption, Map& map,
1438 const Converter& converter = Converter()) {
1439 checkConcept<concepts::WriteMap<Arc, typename Map::Value>, Map>();
1440 _reader_bits::MapStorageBase<Edge>* forward_storage =
1441 new _reader_bits::GraphArcMapStorage<Graph, true, Map, Converter>
1442 (_graph, map, converter);
1443 _edge_maps.push_back(std::make_pair('+' + caption, forward_storage));
1444 _reader_bits::MapStorageBase<Edge>* backward_storage =
1445 new _reader_bits::GraphArcMapStorage<Graph, false, Map, Converter>
1446 (_graph, map, converter);
1447 _edge_maps.push_back(std::make_pair('-' + caption, backward_storage));
1451 /// \brief Attribute reading rule
1453 /// Add an attribute reading rule to the reader.
1454 template <typename Value>
1455 GraphReader& attribute(const std::string& caption, Value& value) {
1456 _reader_bits::ValueStorageBase* storage =
1457 new _reader_bits::ValueStorage<Value>(value);
1458 _attributes.insert(std::make_pair(caption, storage));
1462 /// \brief Attribute reading rule
1464 /// Add an attribute reading rule with specialized converter to the
1466 template <typename Value, typename Converter>
1467 GraphReader& attribute(const std::string& caption, Value& value,
1468 const Converter& converter = Converter()) {
1469 _reader_bits::ValueStorageBase* storage =
1470 new _reader_bits::ValueStorage<Value, Converter>(value, converter);
1471 _attributes.insert(std::make_pair(caption, storage));
1475 /// \brief Node reading rule
1477 /// Add a node reading rule to reader.
1478 GraphReader& node(const std::string& caption, Node& node) {
1479 typedef _reader_bits::MapLookUpConverter<Node> Converter;
1480 Converter converter(_node_index);
1481 _reader_bits::ValueStorageBase* storage =
1482 new _reader_bits::ValueStorage<Node, Converter>(node, converter);
1483 _attributes.insert(std::make_pair(caption, storage));
1487 /// \brief Edge reading rule
1489 /// Add an edge reading rule to reader.
1490 GraphReader& edge(const std::string& caption, Edge& edge) {
1491 typedef _reader_bits::MapLookUpConverter<Edge> Converter;
1492 Converter converter(_edge_index);
1493 _reader_bits::ValueStorageBase* storage =
1494 new _reader_bits::ValueStorage<Edge, Converter>(edge, converter);
1495 _attributes.insert(std::make_pair(caption, storage));
1499 /// \brief Arc reading rule
1501 /// Add an arc reading rule to reader.
1502 GraphReader& arc(const std::string& caption, Arc& arc) {
1503 typedef _reader_bits::GraphArcLookUpConverter<Graph> Converter;
1504 Converter converter(_graph, _edge_index);
1505 _reader_bits::ValueStorageBase* storage =
1506 new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
1507 _attributes.insert(std::make_pair(caption, storage));
1513 /// \name Select section by name
1516 /// \brief Set \c \@nodes section to be read
1518 /// Set \c \@nodes section to be read.
1519 GraphReader& nodes(const std::string& caption) {
1520 _nodes_caption = caption;
1524 /// \brief Set \c \@edges section to be read
1526 /// Set \c \@edges section to be read.
1527 GraphReader& edges(const std::string& caption) {
1528 _edges_caption = caption;
1532 /// \brief Set \c \@attributes section to be read
1534 /// Set \c \@attributes section to be read.
1535 GraphReader& attributes(const std::string& caption) {
1536 _attributes_caption = caption;
1542 /// \name Using previously constructed node or edge set
1545 /// \brief Use previously constructed node set
1547 /// Use previously constructed node set, and specify the node
1549 template <typename Map>
1550 GraphReader& useNodes(const Map& map) {
1551 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1552 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1554 _writer_bits::DefaultConverter<typename Map::Value> converter;
1555 for (NodeIt n(_graph); n != INVALID; ++n) {
1556 _node_index.insert(std::make_pair(converter(map[n]), n));
1561 /// \brief Use previously constructed node set
1563 /// Use previously constructed node set, and specify the node
1564 /// label map and a functor which converts the label map values to
1566 template <typename Map, typename Converter>
1567 GraphReader& useNodes(const Map& map,
1568 const Converter& converter = Converter()) {
1569 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
1570 LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
1572 for (NodeIt n(_graph); n != INVALID; ++n) {
1573 _node_index.insert(std::make_pair(converter(map[n]), n));
1578 /// \brief Use previously constructed edge set
1580 /// Use previously constructed edge set, and specify the edge
1582 template <typename Map>
1583 GraphReader& useEdges(const Map& map) {
1584 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1585 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1587 _writer_bits::DefaultConverter<typename Map::Value> converter;
1588 for (EdgeIt a(_graph); a != INVALID; ++a) {
1589 _edge_index.insert(std::make_pair(converter(map[a]), a));
1594 /// \brief Use previously constructed edge set
1596 /// Use previously constructed edge set, and specify the edge
1597 /// label map and a functor which converts the label map values to
1599 template <typename Map, typename Converter>
1600 GraphReader& useEdges(const Map& map,
1601 const Converter& converter = Converter()) {
1602 checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
1603 LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
1605 for (EdgeIt a(_graph); a != INVALID; ++a) {
1606 _edge_index.insert(std::make_pair(converter(map[a]), a));
1611 /// \brief Skip the reading of node section
1613 /// Omit the reading of the node section. This implies that each node
1614 /// map reading rule will be abandoned, and the nodes of the graph
1615 /// will not be constructed, which usually cause that the edge set
1616 /// could not be read due to lack of node name
1617 /// could not be read due to lack of node name resolving.
1618 /// Therefore \c skipEdges() function should also be used, or
1619 /// \c useNodes() should be used to specify the label of the nodes.
1620 GraphReader& skipNodes() {
1621 LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
1626 /// \brief Skip the reading of edge section
1628 /// Omit the reading of the edge section. This implies that each edge
1629 /// map reading rule will be abandoned, and the edges of the graph
1630 /// will not be constructed.
1631 GraphReader& skipEdges() {
1632 LEMON_ASSERT(!_skip_edges, "Skip edges already set");
1643 while(++line_num, std::getline(*_is, str)) {
1644 line.clear(); line.str(str);
1646 if (line >> std::ws >> c && c != '#') {
1654 bool readSuccess() {
1655 return static_cast<bool>(*_is);
1658 void skipSection() {
1660 while (readSuccess() && line >> c && c != '@') {
1668 std::vector<int> map_index(_node_maps.size());
1669 int map_num, label_index;
1672 if (!readLine() || !(line >> c) || c == '@') {
1673 if (readSuccess() && line) line.putback(c);
1674 if (!_node_maps.empty())
1675 throw DataFormatError("Cannot find map names");
1681 std::map<std::string, int> maps;
1685 while (_reader_bits::readToken(line, map)) {
1686 if (maps.find(map) != maps.end()) {
1687 std::ostringstream msg;
1688 msg << "Multiple occurence of node map: " << map;
1689 throw DataFormatError(msg.str().c_str());
1691 maps.insert(std::make_pair(map, index));
1695 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1696 std::map<std::string, int>::iterator jt =
1697 maps.find(_node_maps[i].first);
1698 if (jt == maps.end()) {
1699 std::ostringstream msg;
1700 msg << "Map not found in file: " << _node_maps[i].first;
1701 throw DataFormatError(msg.str().c_str());
1703 map_index[i] = jt->second;
1707 std::map<std::string, int>::iterator jt = maps.find("label");
1708 if (jt != maps.end()) {
1709 label_index = jt->second;
1714 map_num = maps.size();
1717 while (readLine() && line >> c && c != '@') {
1720 std::vector<std::string> tokens(map_num);
1721 for (int i = 0; i < map_num; ++i) {
1722 if (!_reader_bits::readToken(line, tokens[i])) {
1723 std::ostringstream msg;
1724 msg << "Column not found (" << i + 1 << ")";
1725 throw DataFormatError(msg.str().c_str());
1728 if (line >> std::ws >> c)
1729 throw DataFormatError("Extra character on the end of line");
1733 n = _graph.addNode();
1734 if (label_index != -1)
1735 _node_index.insert(std::make_pair(tokens[label_index], n));
1737 if (label_index == -1)
1738 throw DataFormatError("Label map not found in file");
1739 typename std::map<std::string, Node>::iterator it =
1740 _node_index.find(tokens[label_index]);
1741 if (it == _node_index.end()) {
1742 std::ostringstream msg;
1743 msg << "Node with label not found: " << tokens[label_index];
1744 throw DataFormatError(msg.str().c_str());
1749 for (int i = 0; i < static_cast<int>(_node_maps.size()); ++i) {
1750 _node_maps[i].second->set(n, tokens[map_index[i]]);
1754 if (readSuccess()) {
1761 std::vector<int> map_index(_edge_maps.size());
1762 int map_num, label_index;
1765 if (!readLine() || !(line >> c) || c == '@') {
1766 if (readSuccess() && line) line.putback(c);
1767 if (!_edge_maps.empty())
1768 throw DataFormatError("Cannot find map names");
1774 std::map<std::string, int> maps;
1778 while (_reader_bits::readToken(line, map)) {
1779 if (maps.find(map) != maps.end()) {
1780 std::ostringstream msg;
1781 msg << "Multiple occurence of edge map: " << map;
1782 throw DataFormatError(msg.str().c_str());
1784 maps.insert(std::make_pair(map, index));
1788 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1789 std::map<std::string, int>::iterator jt =
1790 maps.find(_edge_maps[i].first);
1791 if (jt == maps.end()) {
1792 std::ostringstream msg;
1793 msg << "Map not found in file: " << _edge_maps[i].first;
1794 throw DataFormatError(msg.str().c_str());
1796 map_index[i] = jt->second;
1800 std::map<std::string, int>::iterator jt = maps.find("label");
1801 if (jt != maps.end()) {
1802 label_index = jt->second;
1807 map_num = maps.size();
1810 while (readLine() && line >> c && c != '@') {
1813 std::string source_token;
1814 std::string target_token;
1816 if (!_reader_bits::readToken(line, source_token))
1817 throw DataFormatError("Node u not found");
1819 if (!_reader_bits::readToken(line, target_token))
1820 throw DataFormatError("Node v not found");
1822 std::vector<std::string> tokens(map_num);
1823 for (int i = 0; i < map_num; ++i) {
1824 if (!_reader_bits::readToken(line, tokens[i])) {
1825 std::ostringstream msg;
1826 msg << "Column not found (" << i + 1 << ")";
1827 throw DataFormatError(msg.str().c_str());
1830 if (line >> std::ws >> c)
1831 throw DataFormatError("Extra character on the end of line");
1836 typename NodeIndex::iterator it;
1838 it = _node_index.find(source_token);
1839 if (it == _node_index.end()) {
1840 std::ostringstream msg;
1841 msg << "Item not found: " << source_token;
1842 throw DataFormatError(msg.str().c_str());
1844 Node source = it->second;
1846 it = _node_index.find(target_token);
1847 if (it == _node_index.end()) {
1848 std::ostringstream msg;
1849 msg << "Item not found: " << target_token;
1850 throw DataFormatError(msg.str().c_str());
1852 Node target = it->second;
1854 e = _graph.addEdge(source, target);
1855 if (label_index != -1)
1856 _edge_index.insert(std::make_pair(tokens[label_index], e));
1858 if (label_index == -1)
1859 throw DataFormatError("Label map not found in file");
1860 typename std::map<std::string, Edge>::iterator it =
1861 _edge_index.find(tokens[label_index]);
1862 if (it == _edge_index.end()) {
1863 std::ostringstream msg;
1864 msg << "Edge with label not found: " << tokens[label_index];
1865 throw DataFormatError(msg.str().c_str());
1870 for (int i = 0; i < static_cast<int>(_edge_maps.size()); ++i) {
1871 _edge_maps[i].second->set(e, tokens[map_index[i]]);
1875 if (readSuccess()) {
1880 void readAttributes() {
1882 std::set<std::string> read_attr;
1885 while (readLine() && line >> c && c != '@') {
1888 std::string attr, token;
1889 if (!_reader_bits::readToken(line, attr))
1890 throw DataFormatError("Attribute name not found");
1891 if (!_reader_bits::readToken(line, token))
1892 throw DataFormatError("Attribute value not found");
1894 throw DataFormatError("Extra character on the end of line");
1897 std::set<std::string>::iterator it = read_attr.find(attr);
1898 if (it != read_attr.end()) {
1899 std::ostringstream msg;
1900 msg << "Multiple occurence of attribute " << attr;
1901 throw DataFormatError(msg.str().c_str());
1903 read_attr.insert(attr);
1907 typename Attributes::iterator it = _attributes.lower_bound(attr);
1908 while (it != _attributes.end() && it->first == attr) {
1909 it->second->set(token);
1915 if (readSuccess()) {
1918 for (typename Attributes::iterator it = _attributes.begin();
1919 it != _attributes.end(); ++it) {
1920 if (read_attr.find(it->first) == read_attr.end()) {
1921 std::ostringstream msg;
1922 msg << "Attribute not found in file: " << it->first;
1923 throw DataFormatError(msg.str().c_str());
1930 /// \name Execution of the reader
1933 /// \brief Start the batch processing
1935 /// This function starts the batch processing
1938 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
1940 bool nodes_done = _skip_nodes;
1941 bool edges_done = _skip_edges;
1942 bool attributes_done = false;
1948 while (readSuccess()) {
1951 std::string section, caption;
1953 _reader_bits::readToken(line, section);
1954 _reader_bits::readToken(line, caption);
1957 throw DataFormatError("Extra character on the end of line");
1959 if (section == "nodes" && !nodes_done) {
1960 if (_nodes_caption.empty() || _nodes_caption == caption) {
1964 } else if ((section == "edges" || section == "arcs") &&
1966 if (_edges_caption.empty() || _edges_caption == caption) {
1970 } else if (section == "attributes" && !attributes_done) {
1971 if (_attributes_caption.empty() || _attributes_caption == caption) {
1973 attributes_done = true;
1979 } catch (DataFormatError& error) {
1980 error.line(line_num);
1986 throw DataFormatError("Section @nodes not found");
1990 throw DataFormatError("Section @edges not found");
1993 if (!attributes_done && !_attributes.empty()) {
1994 throw DataFormatError("Section @attributes not found");
2003 /// \brief Return a \ref GraphReader class
2005 /// This function just returns a \ref GraphReader class.
2006 /// \relates GraphReader
2007 template <typename Graph>
2008 GraphReader<Graph> graphReader(std::istream& is, Graph& graph) {
2009 GraphReader<Graph> tmp(is, graph);
2013 /// \brief Return a \ref GraphReader class
2015 /// This function just returns a \ref GraphReader class.
2016 /// \relates GraphReader
2017 template <typename Graph>
2018 GraphReader<Graph> graphReader(const std::string& fn,
2020 GraphReader<Graph> tmp(fn, graph);
2024 /// \brief Return a \ref GraphReader class
2026 /// This function just returns a \ref GraphReader class.
2027 /// \relates GraphReader
2028 template <typename Graph>
2029 GraphReader<Graph> graphReader(const char* fn, Graph& graph) {
2030 GraphReader<Graph> tmp(fn, graph);
2034 class SectionReader;
2036 SectionReader sectionReader(std::istream& is);
2037 SectionReader sectionReader(const std::string& fn);
2038 SectionReader sectionReader(const char* fn);
2040 /// \ingroup lemon_io
2042 /// \brief Section reader class
2044 /// In the \ref lgf-format "LGF" file extra sections can be placed,
2045 /// which contain any data in arbitrary format. Such sections can be
2046 /// read with this class. A reading rule can be added to the class
2047 /// with two different functions. With the \c sectionLines() function a
2048 /// functor can process the section line-by-line, while with the \c
2049 /// sectionStream() member the section can be read from an input
2051 class SectionReader {
2057 typedef std::map<std::string, _reader_bits::Section*> Sections;
2061 std::istringstream line;
2065 /// \brief Constructor
2067 /// Construct a section reader, which reads from the given input
2069 SectionReader(std::istream& is)
2070 : _is(&is), local_is(false) {}
2072 /// \brief Constructor
2074 /// Construct a section reader, which reads from the given file.
2075 SectionReader(const std::string& fn)
2076 : _is(new std::ifstream(fn.c_str())), local_is(true) {}
2078 /// \brief Constructor
2080 /// Construct a section reader, which reads from the given file.
2081 SectionReader(const char* fn)
2082 : _is(new std::ifstream(fn)), local_is(true) {}
2084 /// \brief Destructor
2086 for (Sections::iterator it = _sections.begin();
2087 it != _sections.end(); ++it) {
2099 friend SectionReader sectionReader(std::istream& is);
2100 friend SectionReader sectionReader(const std::string& fn);
2101 friend SectionReader sectionReader(const char* fn);
2103 SectionReader(SectionReader& other)
2104 : _is(other._is), local_is(other.local_is) {
2107 other.local_is = false;
2109 _sections.swap(other._sections);
2112 SectionReader& operator=(const SectionReader&);
2116 /// \name Section readers
2119 /// \brief Add a section processor with line oriented reading
2121 /// The first parameter is the type descriptor of the section, the
2122 /// second is a functor, which takes just one \c std::string
2123 /// parameter. At the reading process, each line of the section
2124 /// will be given to the functor object. However, the empty lines
2125 /// and the comment lines are filtered out, and the leading
2126 /// whitespaces are trimmed from each processed string.
2128 /// For example let's see a section, which contain several
2129 /// integers, which should be inserted into a vector.
2137 /// The functor is implemented as a struct:
2139 /// struct NumberSection {
2140 /// std::vector<int>& _data;
2141 /// NumberSection(std::vector<int>& data) : _data(data) {}
2142 /// void operator()(const std::string& line) {
2143 /// std::istringstream ls(line);
2145 /// while (ls >> value) _data.push_back(value);
2151 /// reader.sectionLines("numbers", NumberSection(vec));
2153 template <typename Functor>
2154 SectionReader& sectionLines(const std::string& type, Functor functor) {
2155 LEMON_ASSERT(!type.empty(), "Type is empty.");
2156 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2157 "Multiple reading of section.");
2158 _sections.insert(std::make_pair(type,
2159 new _reader_bits::LineSection<Functor>(functor)));
2164 /// \brief Add a section processor with stream oriented reading
2166 /// The first parameter is the type of the section, the second is
2167 /// a functor, which takes an \c std::istream& and an \c int&
2168 /// parameter, the latter regard to the line number of stream. The
2169 /// functor can read the input while the section go on, and the
2170 /// line number should be modified accordingly.
2171 template <typename Functor>
2172 SectionReader& sectionStream(const std::string& type, Functor functor) {
2173 LEMON_ASSERT(!type.empty(), "Type is empty.");
2174 LEMON_ASSERT(_sections.find(type) == _sections.end(),
2175 "Multiple reading of section.");
2176 _sections.insert(std::make_pair(type,
2177 new _reader_bits::StreamSection<Functor>(functor)));
2187 while(++line_num, std::getline(*_is, str)) {
2188 line.clear(); line.str(str);
2190 if (line >> std::ws >> c && c != '#') {
2198 bool readSuccess() {
2199 return static_cast<bool>(*_is);
2202 void skipSection() {
2204 while (readSuccess() && line >> c && c != '@') {
2213 /// \name Execution of the reader
2216 /// \brief Start the batch processing
2218 /// This function starts the batch processing.
2221 LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
2223 std::set<std::string> extra_sections;
2229 while (readSuccess()) {
2232 std::string section, caption;
2234 _reader_bits::readToken(line, section);
2235 _reader_bits::readToken(line, caption);
2238 throw DataFormatError("Extra character on the end of line");
2240 if (extra_sections.find(section) != extra_sections.end()) {
2241 std::ostringstream msg;
2242 msg << "Multiple occurence of section " << section;
2243 throw DataFormatError(msg.str().c_str());
2245 Sections::iterator it = _sections.find(section);
2246 if (it != _sections.end()) {
2247 extra_sections.insert(section);
2248 it->second->process(*_is, line_num);
2252 } catch (DataFormatError& error) {
2253 error.line(line_num);
2257 for (Sections::iterator it = _sections.begin();
2258 it != _sections.end(); ++it) {
2259 if (extra_sections.find(it->first) == extra_sections.end()) {
2260 std::ostringstream os;
2261 os << "Cannot find section: " << it->first;
2262 throw DataFormatError(os.str().c_str());
2271 /// \brief Return a \ref SectionReader class
2273 /// This function just returns a \ref SectionReader class.
2274 /// \relates SectionReader
2275 inline SectionReader sectionReader(std::istream& is) {
2276 SectionReader tmp(is);
2280 /// \brief Return a \ref SectionReader class
2282 /// This function just returns a \ref SectionReader class.
2283 /// \relates SectionReader
2284 inline SectionReader sectionReader(const std::string& fn) {
2285 SectionReader tmp(fn);
2289 /// \brief Return a \ref SectionReader class
2291 /// This function just returns a \ref SectionReader class.
2292 /// \relates SectionReader
2293 inline SectionReader sectionReader(const char* fn) {
2294 SectionReader tmp(fn);
2298 /// \ingroup lemon_io
2300 /// \brief Reader for the contents of the \ref lgf-format "LGF" file
2302 /// This class can be used to read the sections, the map names and
2303 /// the attributes from a file. Usually, the Lemon programs know
2304 /// that, which type of graph, which maps and which attributes
2305 /// should be read from a file, but in general tools (like glemon)
2306 /// the contents of an LGF file should be guessed somehow. This class
2307 /// reads the graph and stores the appropriate information for
2308 /// reading the graph.
2311 /// LgfContents contents("graph.lgf");
2314 /// // Does it contain any node section and arc section?
2315 /// if (contents.nodeSectionNum() == 0 || contents.arcSectionNum()) {
2316 /// std::cerr << "Failure, cannot find graph." << std::endl;
2319 /// std::cout << "The name of the default node section: "
2320 /// << contents.nodeSection(0) << std::endl;
2321 /// std::cout << "The number of the arc maps: "
2322 /// << contents.arcMaps(0).size() << std::endl;
2323 /// std::cout << "The name of second arc map: "
2324 /// << contents.arcMaps(0)[1] << std::endl;
2332 std::vector<std::string> _node_sections;
2333 std::vector<std::string> _edge_sections;
2334 std::vector<std::string> _attribute_sections;
2335 std::vector<std::string> _extra_sections;
2337 std::vector<bool> _arc_sections;
2339 std::vector<std::vector<std::string> > _node_maps;
2340 std::vector<std::vector<std::string> > _edge_maps;
2342 std::vector<std::vector<std::string> > _attributes;
2346 std::istringstream line;
2350 /// \brief Constructor
2352 /// Construct an \e LGF contents reader, which reads from the given
2354 LgfContents(std::istream& is)
2355 : _is(&is), local_is(false) {}
2357 /// \brief Constructor
2359 /// Construct an \e LGF contents reader, which reads from the given
2361 LgfContents(const std::string& fn)
2362 : _is(new std::ifstream(fn.c_str())), local_is(true) {}
2364 /// \brief Constructor
2366 /// Construct an \e LGF contents reader, which reads from the given
2368 LgfContents(const char* fn)
2369 : _is(new std::ifstream(fn)), local_is(true) {}
2371 /// \brief Destructor
2373 if (local_is) delete _is;
2378 LgfContents(const LgfContents&);
2379 LgfContents& operator=(const LgfContents&);
2384 /// \name Node sections
2387 /// \brief Gives back the number of node sections in the file.
2389 /// Gives back the number of node sections in the file.
2390 int nodeSectionNum() const {
2391 return _node_sections.size();
2394 /// \brief Returns the node section name at the given position.
2396 /// Returns the node section name at the given position.
2397 const std::string& nodeSection(int i) const {
2398 return _node_sections[i];
2401 /// \brief Gives back the node maps for the given section.
2403 /// Gives back the node maps for the given section.
2404 const std::vector<std::string>& nodeMapNames(int i) const {
2405 return _node_maps[i];
2410 /// \name Arc/Edge sections
2413 /// \brief Gives back the number of arc/edge sections in the file.
2415 /// Gives back the number of arc/edge sections in the file.
2416 /// \note It is synonym of \c edgeSectionNum().
2417 int arcSectionNum() const {
2418 return _edge_sections.size();
2421 /// \brief Returns the arc/edge section name at the given position.
2423 /// Returns the arc/edge section name at the given position.
2424 /// \note It is synonym of \c edgeSection().
2425 const std::string& arcSection(int i) const {
2426 return _edge_sections[i];
2429 /// \brief Gives back the arc/edge maps for the given section.
2431 /// Gives back the arc/edge maps for the given section.
2432 /// \note It is synonym of \c edgeMapNames().
2433 const std::vector<std::string>& arcMapNames(int i) const {
2434 return _edge_maps[i];
2442 /// \brief Gives back the number of arc/edge sections in the file.
2444 /// Gives back the number of arc/edge sections in the file.
2445 /// \note It is synonym of \c arcSectionNum().
2446 int edgeSectionNum() const {
2447 return _edge_sections.size();
2450 /// \brief Returns the section name at the given position.
2452 /// Returns the section name at the given position.
2453 /// \note It is synonym of \c arcSection().
2454 const std::string& edgeSection(int i) const {
2455 return _edge_sections[i];
2458 /// \brief Gives back the edge maps for the given section.
2460 /// Gives back the edge maps for the given section.
2461 /// \note It is synonym of \c arcMapNames().
2462 const std::vector<std::string>& edgeMapNames(int i) const {
2463 return _edge_maps[i];
2468 /// \name Attribute sections
2471 /// \brief Gives back the number of attribute sections in the file.
2473 /// Gives back the number of attribute sections in the file.
2474 int attributeSectionNum() const {
2475 return _attribute_sections.size();
2478 /// \brief Returns the attribute section name at the given position.
2480 /// Returns the attribute section name at the given position.
2481 const std::string& attributeSectionNames(int i) const {
2482 return _attribute_sections[i];
2485 /// \brief Gives back the attributes for the given section.
2487 /// Gives back the attributes for the given section.
2488 const std::vector<std::string>& attributes(int i) const {
2489 return _attributes[i];
2494 /// \name Extra sections
2497 /// \brief Gives back the number of extra sections in the file.
2499 /// Gives back the number of extra sections in the file.
2500 int extraSectionNum() const {
2501 return _extra_sections.size();
2504 /// \brief Returns the extra section type at the given position.
2506 /// Returns the section type at the given position.
2507 const std::string& extraSection(int i) const {
2508 return _extra_sections[i];
2517 while(++line_num, std::getline(*_is, str)) {
2518 line.clear(); line.str(str);
2520 if (line >> std::ws >> c && c != '#') {
2528 bool readSuccess() {
2529 return static_cast<bool>(*_is);
2532 void skipSection() {
2534 while (readSuccess() && line >> c && c != '@') {
2540 void readMaps(std::vector<std::string>& maps) {
2542 if (!readLine() || !(line >> c) || c == '@') {
2543 if (readSuccess() && line) line.putback(c);
2548 while (_reader_bits::readToken(line, map)) {
2549 maps.push_back(map);
2553 void readAttributes(std::vector<std::string>& attrs) {
2556 while (readSuccess() && line >> c && c != '@') {
2559 _reader_bits::readToken(line, attr);
2560 attrs.push_back(attr);
2568 /// \name Execution of the contents reader
2571 /// \brief Starts the reading
2573 /// This function starts the reading.
2579 while (readSuccess()) {
2584 std::string section, caption;
2585 _reader_bits::readToken(line, section);
2586 _reader_bits::readToken(line, caption);
2588 if (section == "nodes") {
2589 _node_sections.push_back(caption);
2590 _node_maps.push_back(std::vector<std::string>());
2591 readMaps(_node_maps.back());
2592 readLine(); skipSection();
2593 } else if (section == "arcs" || section == "edges") {
2594 _edge_sections.push_back(caption);
2595 _arc_sections.push_back(section == "arcs");
2596 _edge_maps.push_back(std::vector<std::string>());
2597 readMaps(_edge_maps.back());
2598 readLine(); skipSection();
2599 } else if (section == "attributes") {
2600 _attribute_sections.push_back(caption);
2601 _attributes.push_back(std::vector<std::string>());
2602 readAttributes(_attributes.back());
2604 _extra_sections.push_back(section);
2605 readLine(); skipSection();