LEMON/LEMON-official Changeset - r192:7bf5f97d574f

Repositories » LEMON » LEMON-official

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r192:7bf5f97d574f

« 190:1e6af6

193:65cba1 »

r192:7bf5f97d574f

Sat, 05 Jul 2008 00:14:27

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

Doc improvements in LGF related files

0 5 0

default

5 files changed with 166 insertions and 115 deletions:

demo/lgf_demo.cc

doc/groups.dox

doc/lgf.dox

lemon/lgf_reader.h

lemon/lgf_writer.h

↑ Collapse diff ↑

demo/lgf_demo.cc

Show inline comments

@@ -13,54 +13,52 @@
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		///\ingroup demos
 		///\file
 		///\brief Demonstrating graph input and output
 		///
 		/// This program gives an example of how to load a directed graph from
 		/// an \ref lgf-format "LGF" file with the \ref lemon::DigraphReader
 		/// "DigraphReader" class.
 		///
 		/// The \c "digraph.lgf" file:
 		/// \include digraph.lgf
 		///
 		/// And the program which reads it:
 		/// \include lgf_demo.cc
 		#include <iostream>
 		#include <lemon/smart_graph.h>
 		#include <lemon/lgf_reader.h>
 		#include <lemon/lgf_writer.h>
 		#include <lemon/random.h>
 		using namespace lemon;
 		int main() {
 		  SmartDigraph g;
 		  SmartDigraph::ArcMap<int> cap(g);
 		  SmartDigraph::Node s, t;
-		  digraphReader("digraph.lgf", g). // read the directeg graph into g
+		  digraphReader("digraph.lgf", g). // read the directed graph into g
 		    arcMap("capacity", cap).       // read the 'capacity' arc map into cap
 		    node("source", s).             // read 'source' node to s
 		    node("target", t).             // read 'target' node to t
 		    run();
-		  std::cout << "Digraph read from 'digraph.lgf'" << std::endl;
+		  std::cout << "A digraph is read from 'digraph.lgf'." << std::endl;
 		  std::cout << "Number of nodes: " << countNodes(g) << std::endl;
 		  std::cout << "Number of arcs: " << countArcs(g) << std::endl;
 		  std::cout << "We can write it to the standard output:" << std::endl;
 		  digraphWriter(std::cout, g).     // write g to the standard output
 		    arcMap("capacity", cap).       // write cap into 'capacity'
 		    node("source", s).             // write s to 'source'
 		    node("target", t).             // write t to 'target'
 		    run();
 		  return 0;
+		}

doc/groups.dox

Show inline comments

@@ -454,53 +454,51 @@
 		This group describes the tools that makes it easier to create graphs and
 		the maps that dynamically update with the graph changes.
 		*/
 		/**
 		@defgroup exceptions Exceptions
 		@ingroup utils
 		\brief Exceptions defined in LEMON.
 		This group describes the exceptions defined in LEMON.
 		*/
 		/**
 		@defgroup io_group Input-Output
 		\brief Graph Input-Output methods
 		This group describes the tools for importing and exporting graphs
 		and graph related data. Now it supports the LEMON format, the
 		\c DIMACS format and the encapsulated postscript (EPS) format.
 		*/
 		/**
 		@defgroup lemon_io Lemon Input-Output
 		@ingroup io_group
-		\brief Reading and writing LEMON format
+		\brief Reading and writing \ref lgf-format "Lemon Graph Format".
 		This group describes methods for reading and writing LEMON format.
 		You can find more about this format on the \ref graph-io-page "Graph Input-Output"
-		tutorial pages.
+		This group describes methods for reading and writing \ref lgf-format "Lemon Graph Format".
 		*/
 		/**
 		@defgroup eps_io Postscript exporting
 		@ingroup io_group
 		\brief General \c EPS drawer and graph exporter
 		This group describes general \c EPS drawing methods and special
 		graph exporting tools.
 		*/
 		/**
 		@defgroup concept Concepts
 		\brief Skeleton classes and concept checking classes
 		This group describes the data/algorithm skeletons and concept checking
 		classes implemented in LEMON.
 		The purpose of the classes in this group is fourfold.
 		- These classes contain the documentations of the concepts. In order
 		  to avoid document multiplications, an implementation of a concept
 		  simply refers to the corresponding concept class.

doc/lgf.dox

Show inline comments

@@ -25,67 +25,67 @@
 		The \e LGF is a <em>column oriented</em>
 		file format for storing graphs and associated data like
 		node and edge maps.
 		Each line with \c '#' first non-whitespace
 		character is considered as a comment line.
 		Otherwise the file consists of sections starting with
 		a header line. The header lines starts with an \c '@' character followed by the
 		type of section. The standard section types are \c \@nodes, \c
 		\@arcs and \c \@edges
 		and \@attributes. Each header line may also have an optional
 		\e name, which can be use to distinguish the sections of the same
 		type.
 		The standard sections are column oriented, each line consists of
 		<em>token</em>s separated by whitespaces. A token can be \e plain or
 		\e quoted. A plain token is just a sequence of non-whitespace characters,
 		while a quoted token is a
 		character sequence surrounded by double quotes, and it can also
 		contain whitespaces and escape sequences.
 		The \c \@nodes section describes a set of nodes and associated
-		maps. The first is a header line, it columns are the names of the
+		maps. The first is a header line, its columns are the names of the
 		maps appearing in the following lines.
 		One of the maps must be called \c
 		"label", which plays special role in the file.
 		The following
 		non-empty lines until the next section describes nodes of the
 		graph. Each line contains the values of the node maps
 		associated to the current node.
 		\code
 		 @nodes
 		 label   coordinates size    title
 (10,20)     10      "First node"
 (80,80)     8       "Second node"
 (40,10)     10      "Third node"
 		\endcode
 		The \c \@arcs section is very similar to the \c \@nodes section,
-		it again starts with a header line describing the names of the arc,
+		it again starts with a header line describing the names of the maps,
 		but the \c "label" map is not obligatory here. The following lines
 		describe the arcs. The first two tokens of each line are
 		the source and the target node of the arc, respectively, then come the map
 		values. The source and target tokens must be node labels.
 		\code
 		 @arcs
 		 	      capacity
 2   16
 3   12
 3   18
 		\endcode
 		The \c \@edges is just a synonym of \c \@arcs.
 		The \c \@attributes section contains key-value pairs, each line
 		consists of two tokens, an attribute name, and then an attribute value.
 		\code
 		 @attributes
 		 source 1
 		 target 3
 		 caption "LEMON test digraph"
 		\endcode

lemon/lgf_reader.h

Show inline comments

 		/* -*- C++ -*-
+		 *
 		 * This file is a part of LEMON, a generic C++ optimization library
+		 *
 		 * Copyright (C) 2003-2008
 		 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 		 * (Egervary Research Group on Combinatorial Optimization, EGRES).
+		 *
 		 * Permission to use, modify and distribute this software is granted
 		 * provided that this copyright notice appears in all copies. For
 		 * precise terms see the accompanying LICENSE file.
+		 *
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		///\ingroup lemon_io
 		///\file
 		///\brief Lemon Graph Format reader.
+		///\brief \ref lgf-format "Lemon Graph Format" reader.
 		#ifndef LEMON_LGF_READER_H
 		#define LEMON_LGF_READER_H
 		#include <iostream>
 		#include <fstream>
 		#include <sstream>
 		#include <set>
 		#include <map>
 		#include <lemon/assert.h>
 		#include <lemon/graph_utils.h>
 		#include <lemon/lgf_writer.h>
 		#include <lemon/concept_check.h>
 		#include <lemon/concepts/maps.h>
 		namespace lemon {
 		  namespace _reader_bits {
@@ -379,93 +379,93 @@
 			    ++line_num;
+			  }
+			}
 			if (is) is.putback(c);
 			else if (is.eof()) is.clear();
+		      }
 		    };
+		  }
 		  template <typename Digraph>
 		  class DigraphReader;
 		  template <typename Digraph>
 		  DigraphReader<Digraph> digraphReader(std::istream& is, Digraph& digraph);
 		  template <typename Digraph>
 		  DigraphReader<Digraph> digraphReader(const std::string& fn, Digraph& digraph);
 		  template <typename Digraph>
 		  DigraphReader<Digraph> digraphReader(const char *fn, Digraph& digraph);
 		  /// \ingroup lemon_io
 		  ///
 		  /// \brief LGF reader for directed graphs
+		  /// \brief \ref lgf-format "LGF" reader for directed graphs
 		  ///
 		  /// This utility reads an \ref lgf-format "LGF" file.
 		  ///
 		  /// The reading method does a batch processing. The user creates a
 		  /// reader object, then various reading rules can be added to the
 		  /// reader, and eventually the reading is executed with the \c run()
 		  /// member function. A map reading rule can be added to the reader
 		  /// with the \c nodeMap() or \c arcMap() members. An optional
 		  /// converter parameter can also be added as a standard functor
 		  /// converting from std::string to the value type of the map. If it
+		  /// converting from \c std::string to the value type of the map. If it
 		  /// is set, it will determine how the tokens in the file should be
-		  /// is converted to the map's value type. If the functor is not set,
+		  /// converted to the value type of the map. If the functor is not set,
 		  /// then a default conversion will be used. One map can be read into
 		  /// multiple map objects at the same time. The \c attribute(), \c
 		  /// node() and \c arc() functions are used to add attribute reading
 		  /// rules.
 		  ///
 		  ///\code
 		  ///     DigraphReader<Digraph>(std::cin, digraph).
 		  ///       nodeMap("coordinates", coord_map).
 		  ///       arcMap("capacity", cap_map).
 		  ///       node("source", src).
 		  ///       node("target", trg).
 		  ///       attribute("caption", caption).
-		  ///       run();
+		  /// DigraphReader<Digraph>(std::cin, digraph).
 		  ///   nodeMap("coordinates", coord_map).
 		  ///   arcMap("capacity", cap_map).
 		  ///   node("source", src).
 		  ///   node("target", trg).
 		  ///   attribute("caption", caption).
 		  ///   run();
 		  ///\endcode
 		  ///
 		  /// By default the reader uses the first section in the file of the
 		  /// proper type. If a section has an optional name, then it can be
 		  /// selected for reading by giving an optional name parameter to the
 		  /// \c nodes(), \c arcs() or \c attributes() functions.
 		  ///
 		  /// The \c useNodes() and \c useArcs() functions are used to tell the reader
 		  /// that the nodes or arcs should not be constructed (added to the
 		  /// graph) during the reading, but instead the label map of the items
 		  /// are given as a parameter of these functions. An
 		  /// application of these function is multipass reading, which is
 		  /// important if two \e \@arcs sections must be read from the
-		  /// file. In this example the first phase would read the node set and one
+		  /// application of these functions is multipass reading, which is
 		  /// important if two \c \@arcs sections must be read from the
 		  /// file. In this case the first phase would read the node set and one
 		  /// of the arc sets, while the second phase would read the second arc
 		  /// set into an \e ArcSet class (\c SmartArcSet or \c ListArcSet).
 		  /// The previously read label node map should be passed to the \c
 		  /// useNodes() functions. Another application of multipass reading when
 		  /// paths are given as a node map or an arc map. It is impossible read this in
+		  /// paths are given as a node map or an arc map. It is impossible to read this in
 		  /// a single pass, because the arcs are not constructed when the node
 		  /// maps are read.
 		  template <typename _Digraph>
 		  class DigraphReader {
 		  public:
 		    typedef _Digraph Digraph;
 		    TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
 		  private:
 		    std::istream* _is;
 		    bool local_is;
 		    Digraph& _digraph;
 		    std::string _nodes_caption;
 		    std::string _arcs_caption;
 		    std::string _attributes_caption;
 		    typedef std::map<std::string, Node> NodeIndex;
 		    NodeIndex _node_index;
 		    typedef std::map<std::string, Arc> ArcIndex;
@@ -714,113 +714,112 @@
 		    /// \name Using previously constructed node or arc set
 		    /// @{
 		    /// \brief Use previously constructed node set
 		    ///
 		    /// Use previously constructed node set, and specify the node
 		    /// label map.
 		    template <typename Map>
 		    DigraphReader& useNodes(const Map& map) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
 		      _use_nodes = true;
 		      _writer_bits::DefaultConverter<typename Map::Value> converter;
 		      for (NodeIt n(_digraph); n != INVALID; ++n) {
 			_node_index.insert(std::make_pair(converter(map[n]), n));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed node set
 		    ///
 		    /// Use previously constructed node set, and specify the node
 		    /// label map and a functor which converts the label map values to
 		    /// std::string.
+		    /// \c std::string.
 		    template <typename Map, typename Converter>
 		    DigraphReader& useNodes(const Map& map,
 					    const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
 		      _use_nodes = true;
 		      for (NodeIt n(_digraph); n != INVALID; ++n) {
 			_node_index.insert(std::make_pair(converter(map[n]), n));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed arc set
 		    ///
 		    /// Use previously constructed arc set, and specify the arc
 		    /// label map.
 		    template <typename Map>
 		    DigraphReader& useArcs(const Map& map) {
 		      checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
 		      _use_arcs = true;
 		      _writer_bits::DefaultConverter<typename Map::Value> converter;
 		      for (ArcIt a(_digraph); a != INVALID; ++a) {
 			_arc_index.insert(std::make_pair(converter(map[a]), a));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed arc set
 		    ///
 		    /// Use previously constructed arc set, and specify the arc
 		    /// label map and a functor which converts the label map values to
 		    /// std::string.
+		    /// \c std::string.
 		    template <typename Map, typename Converter>
 		    DigraphReader& useArcs(const Map& map,
 					   const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Arc, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_arcs, "Multiple usage of useArcs() member");
 		      _use_arcs = true;
 		      for (ArcIt a(_digraph); a != INVALID; ++a) {
 			_arc_index.insert(std::make_pair(converter(map[a]), a));
+		      }
 		      return *this;
+		    }
 		    /// \brief Skips the reading of node section
 		    ///
 		    /// Omit the reading of the node section. This implies that each node
-		    /// map reading rule will be abanoned, and the nodes of the graph
+		    /// map reading rule will be abandoned, and the nodes of the graph
 		    /// will not be constructed, which usually cause that the arc set
 		    /// could not be read due to lack of node name
 		    /// resolving. Therefore, the \c skipArcs() should be used too, or
 		    /// the useNodes() member function should be used to specify the
 		    /// label of the nodes.
 		    /// could not be read due to lack of node name resolving.
 		    /// Therefore \c skipArcs() function should also be used, or
 		    /// \c useNodes() should be used to specify the label of the nodes.
 		    DigraphReader& skipNodes() {
 		      LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
 		      _skip_nodes = true;
 		      return *this;
+		    }
 		    /// \brief Skips the reading of arc section
 		    ///
 		    /// Omit the reading of the arc section. This implies that each arc
-		    /// map reading rule will be abanoned, and the arcs of the graph
+		    /// map reading rule will be abandoned, and the arcs of the graph
 		    /// will not be constructed.
 		    DigraphReader& skipArcs() {
 		      LEMON_ASSERT(!_skip_arcs, "Skip arcs already set");
 		      _skip_arcs = true;
 		      return *this;
+		    }
 		    /// @}
 		  private:
 		    bool readLine() {
 		      std::string str;
 		      while(++line_num, std::getline(*_is, str)) {
 			line.clear(); line.str(str);
 			char c;
 			if (line >> std::ws >> c && c != '#') {
 			  line.putback(c);
 			  return true;
+			}
+		      }
 		      return false;
+		    }
@@ -1154,154 +1153,167 @@
 			} catch (DataFormatError& error) {
 			  error.line(line_num);
 			  throw;
+			}
+		      }
 		      if (!nodes_done) {
 			throw DataFormatError("Section @nodes not found");
+		      }
 		      if (!arcs_done) {
 			throw DataFormatError("Section @arcs not found");
+		      }
 		      if (!attributes_done && !_attributes.empty()) {
 			throw DataFormatError("Section @attributes not found");
+		      }
+		    }
 		    /// @}
 		  };
 		  /// \brief Return a \ref DigraphReader class
 		  ///
 		  /// This function just returns a \ref DigraphReader class.
 		  /// \relates DigraphReader
 		  template <typename Digraph>
 		  DigraphReader<Digraph> digraphReader(std::istream& is, Digraph& digraph) {
 		    DigraphReader<Digraph> tmp(is, digraph);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref DigraphReader class
 		  ///
 		  /// This function just returns a \ref DigraphReader class.
 		  /// \relates DigraphReader
 		  template <typename Digraph>
 		  DigraphReader<Digraph> digraphReader(const std::string& fn,
 						       Digraph& digraph) {
 		    DigraphReader<Digraph> tmp(fn, digraph);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref DigraphReader class
 		  ///
 		  /// This function just returns a \ref DigraphReader class.
 		  /// \relates DigraphReader
 		  template <typename Digraph>
 		  DigraphReader<Digraph> digraphReader(const char* fn, Digraph& digraph) {
 		    DigraphReader<Digraph> tmp(fn, digraph);
 		    return tmp;
+		  }
 		  template <typename Graph>
 		  class GraphReader;
 		  template <typename Graph>
 		  GraphReader<Graph> graphReader(std::istream& is, Graph& graph);
 		  template <typename Graph>
 		  GraphReader<Graph> graphReader(const std::string& fn, Graph& graph);
 		  template <typename Graph>
 		  GraphReader<Graph> graphReader(const char *fn, Graph& graph);
 		  /// \ingroup lemon_io
 		  ///
 		  /// \brief LGF reader for undirected graphs
+		  /// \brief \ref lgf-format "LGF" reader for undirected graphs
 		  ///
 		  /// This utility reads an \ref lgf-format "LGF" file.
 		  ///
 		  /// It can be used almost the same way as \c DigraphReader.
 		  /// The only difference is that this class can handle edges and
 		  /// edge maps as well as arcs and arc maps.
 		  template <typename _Graph>
 		  class GraphReader {
 		  public:
 		    typedef _Graph Graph;
 		    TEMPLATE_GRAPH_TYPEDEFS(Graph);
 		  private:
 		    std::istream* _is;
 		    bool local_is;
 		    Graph& _graph;
 		    std::string _nodes_caption;
 		    std::string _edges_caption;
 		    std::string _attributes_caption;
 		    typedef std::map<std::string, Node> NodeIndex;
 		    NodeIndex _node_index;
 		    typedef std::map<std::string, Edge> EdgeIndex;
 		    EdgeIndex _edge_index;
 		    typedef std::vector<std::pair<std::string,
 		      _reader_bits::MapStorageBase<Node>*> > NodeMaps;
 		    NodeMaps _node_maps;
 		    typedef std::vector<std::pair<std::string,
 		      _reader_bits::MapStorageBase<Edge>*> > EdgeMaps;
 		    EdgeMaps _edge_maps;
 		    typedef std::multimap<std::string, _reader_bits::ValueStorageBase*>
 		      Attributes;
 		    Attributes _attributes;
 		    bool _use_nodes;
 		    bool _use_edges;
 		    bool _skip_nodes;
 		    bool _skip_edges;
 		    int line_num;
 		    std::istringstream line;
 		  public:
 		    /// \brief Constructor
 		    ///
-		    /// Construct a undirected graph reader, which reads from the given
+		    /// Construct an undirected graph reader, which reads from the given
 		    /// input stream.
 		    GraphReader(std::istream& is, Graph& graph)
 		      : _is(&is), local_is(false), _graph(graph),
 			_use_nodes(false), _use_edges(false),
 			_skip_nodes(false), _skip_edges(false) {}
 		    /// \brief Constructor
 		    ///
-		    /// Construct a undirected graph reader, which reads from the given
+		    /// Construct an undirected graph reader, which reads from the given
 		    /// file.
 		    GraphReader(const std::string& fn, Graph& graph)
 		      : _is(new std::ifstream(fn.c_str())), local_is(true), _graph(graph),
 		    	_use_nodes(false), _use_edges(false),
 			_skip_nodes(false), _skip_edges(false) {}
 		    /// \brief Constructor
 		    ///
-		    /// Construct a undirected graph reader, which reads from the given
+		    /// Construct an undirected graph reader, which reads from the given
 		    /// file.
 		    GraphReader(const char* fn, Graph& graph)
 		      : _is(new std::ifstream(fn)), local_is(true), _graph(graph),
 		    	_use_nodes(false), _use_edges(false),
 			_skip_nodes(false), _skip_edges(false) {}
 		    /// \brief Destructor
 		    ~GraphReader() {
 		      for (typename NodeMaps::iterator it = _node_maps.begin();
 			   it != _node_maps.end(); ++it) {
 			delete it->second;
+		      }
 		      for (typename EdgeMaps::iterator it = _edge_maps.begin();
 			   it != _edge_maps.end(); ++it) {
 			delete it->second;
+		      }
 		      for (typename Attributes::iterator it = _attributes.begin();
 			   it != _attributes.end(); ++it) {
 			delete it->second;
+		      }
 		      if (local_is) {
@@ -1476,160 +1488,160 @@
 			new _reader_bits::ValueStorage<Edge, Converter>(edge, converter);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc reading rule
 		    ///
 		    /// Add an arc reading rule to reader.
 		    GraphReader& arc(const std::string& caption, Arc& arc) {
 		      typedef _reader_bits::GraphArcLookUpConverter<Graph> Converter;
 		      Converter converter(_graph, _edge_index);
 		      _reader_bits::ValueStorageBase* storage =
 			new _reader_bits::ValueStorage<Arc, Converter>(arc, converter);
 		      _attributes.insert(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// @}
 		    /// \name Select section by name
 		    /// @{
 		    /// \brief Set \c \@nodes section to be read
 		    ///
 		    /// Set \c \@nodes section to be read
+		    /// Set \c \@nodes section to be read.
 		    GraphReader& nodes(const std::string& caption) {
 		      _nodes_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Set \c \@edges section to be read
 		    ///
 		    /// Set \c \@edges section to be read
+		    /// Set \c \@edges section to be read.
 		    GraphReader& edges(const std::string& caption) {
 		      _edges_caption = caption;
 		      return *this;
+		    }
 		    /// \brief Set \c \@attributes section to be read
 		    ///
 		    /// Set \c \@attributes section to be read
+		    /// Set \c \@attributes section to be read.
 		    GraphReader& attributes(const std::string& caption) {
 		      _attributes_caption = caption;
 		      return *this;
+		    }
 		    /// @}
 		    /// \name Using previously constructed node or edge set
 		    /// @{
 		    /// \brief Use previously constructed node set
 		    ///
 		    /// Use previously constructed node set, and specify the node
 		    /// label map.
 		    template <typename Map>
 		    GraphReader& useNodes(const Map& map) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
 		      _use_nodes = true;
 		      _writer_bits::DefaultConverter<typename Map::Value> converter;
 		      for (NodeIt n(_graph); n != INVALID; ++n) {
 			_node_index.insert(std::make_pair(converter(map[n]), n));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed node set
 		    ///
 		    /// Use previously constructed node set, and specify the node
 		    /// label map and a functor which converts the label map values to
 		    /// std::string.
+		    /// \c std::string.
 		    template <typename Map, typename Converter>
 		    GraphReader& useNodes(const Map& map,
 					    const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_nodes, "Multiple usage of useNodes() member");
 		      _use_nodes = true;
 		      for (NodeIt n(_graph); n != INVALID; ++n) {
 			_node_index.insert(std::make_pair(converter(map[n]), n));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed edge set
 		    ///
 		    /// Use previously constructed edge set, and specify the edge
 		    /// label map.
 		    template <typename Map>
 		    GraphReader& useEdges(const Map& map) {
 		      checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
 		      _use_edges = true;
 		      _writer_bits::DefaultConverter<typename Map::Value> converter;
 		      for (EdgeIt a(_graph); a != INVALID; ++a) {
 			_edge_index.insert(std::make_pair(converter(map[a]), a));
+		      }
 		      return *this;
+		    }
 		    /// \brief Use previously constructed edge set
 		    ///
 		    /// Use previously constructed edge set, and specify the edge
 		    /// label map and a functor which converts the label map values to
 		    /// std::string.
+		    /// \c std::string.
 		    template <typename Map, typename Converter>
 		    GraphReader& useEdges(const Map& map,
 					    const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Edge, typename Map::Value>, Map>();
 		      LEMON_ASSERT(!_use_edges, "Multiple usage of useEdges() member");
 		      _use_edges = true;
 		      for (EdgeIt a(_graph); a != INVALID; ++a) {
 			_edge_index.insert(std::make_pair(converter(map[a]), a));
+		      }
 		      return *this;
+		    }
-		    /// \brief Skips the reading of node section
+		    /// \brief Skip the reading of node section
 		    ///
 		    /// Omit the reading of the node section. This implies that each node
-		    /// map reading rule will be abanoned, and the nodes of the graph
+		    /// map reading rule will be abandoned, and the nodes of the graph
 		    /// will not be constructed, which usually cause that the edge set
 		    /// could not be read due to lack of node name
 		    /// resolving. Therefore, the \c skipEdges() should be used too, or
 		    /// the useNodes() member function should be used to specify the
-		    /// label of the nodes.
+		    /// could not be read due to lack of node name resolving.
 		    /// Therefore \c skipEdges() function should also be used, or
 		    /// \c useNodes() should be used to specify the label of the nodes.
 		    GraphReader& skipNodes() {
 		      LEMON_ASSERT(!_skip_nodes, "Skip nodes already set");
 		      _skip_nodes = true;
 		      return *this;
+		    }
-		    /// \brief Skips the reading of edge section
+		    /// \brief Skip the reading of edge section
 		    ///
 		    /// Omit the reading of the edge section. This implies that each edge
-		    /// map reading rule will be abanoned, and the edges of the graph
+		    /// map reading rule will be abandoned, and the edges of the graph
 		    /// will not be constructed.
 		    GraphReader& skipEdges() {
 		      LEMON_ASSERT(!_skip_edges, "Skip edges already set");
 		      _skip_edges = true;
 		      return *this;
+		    }
 		    /// @}
 		  private:
 		    bool readLine() {
 		      std::string str;
 		      while(++line_num, std::getline(*_is, str)) {
 			line.clear(); line.str(str);
 			char c;
 			if (line >> std::ws >> c && c != '#') {
 			  line.putback(c);
 			  return true;
+			}
+		      }
 		      return false;
+		    }
@@ -1961,83 +1973,94 @@
 			} catch (DataFormatError& error) {
 			  error.line(line_num);
 			  throw;
+			}
+		      }
 		      if (!nodes_done) {
 			throw DataFormatError("Section @nodes not found");
+		      }
 		      if (!edges_done) {
 			throw DataFormatError("Section @edges not found");
+		      }
 		      if (!attributes_done && !_attributes.empty()) {
 			throw DataFormatError("Section @attributes not found");
+		      }
+		    }
 		    /// @}
 		  };
 		  /// \brief Return a \ref GraphReader class
 		  ///
 		  /// This function just returns a \ref GraphReader class.
 		  /// \relates GraphReader
 		  template <typename Graph>
 		  GraphReader<Graph> graphReader(std::istream& is, Graph& graph) {
 		    GraphReader<Graph> tmp(is, graph);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref GraphReader class
 		  ///
 		  /// This function just returns a \ref GraphReader class.
 		  /// \relates GraphReader
 		  template <typename Graph>
 		  GraphReader<Graph> graphReader(const std::string& fn,
 						       Graph& graph) {
 		    GraphReader<Graph> tmp(fn, graph);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref GraphReader class
 		  ///
 		  /// This function just returns a \ref GraphReader class.
 		  /// \relates GraphReader
 		  template <typename Graph>
 		  GraphReader<Graph> graphReader(const char* fn, Graph& graph) {
 		    GraphReader<Graph> tmp(fn, graph);
 		    return tmp;
+		  }
 		  class SectionReader;
 		  SectionReader sectionReader(std::istream& is);
 		  SectionReader sectionReader(const std::string& fn);
 		  SectionReader sectionReader(const char* fn);
 		  /// \ingroup lemon_io
 		  ///
 		  /// \brief Section reader class
 		  ///
 		  /// In the \e LGF file extra sections can be placed, which contain
 		  /// any data in arbitrary format. Such sections can be read with
 		  /// this class. A reading rule can be added with two different
 		  /// functions, with the \c sectionLines() function a functor can
-		  /// process the section line-by-line. While with the \c
+		  /// In the \ref lgf-format "LGF" file extra sections can be placed,
 		  /// which contain any data in arbitrary format. Such sections can be
 		  /// read with this class. A reading rule can be added to the class
 		  /// with two different functions. With the \c sectionLines() function a
 		  /// functor can process the section line-by-line, while with the \c
 		  /// sectionStream() member the section can be read from an input
 		  /// stream.
 		  class SectionReader {
 		  private:
 		    std::istream* _is;
 		    bool local_is;
 		    typedef std::map<std::string, _reader_bits::Section*> Sections;
 		    Sections _sections;
 		    int line_num;
 		    std::istringstream line;
 		  public:
 		    /// \brief Constructor
 		    ///
 		    /// Construct a section reader, which reads from the given input
 		    /// stream.
 		    SectionReader(std::istream& is)
 		      : _is(&is), local_is(false) {}
 		    /// \brief Constructor
@@ -2084,130 +2107,130 @@
 		  public:
 		    /// \name Section readers
 		    /// @{
 		    /// \brief Add a section processor with line oriented reading
 		    ///
 		    /// The first parameter is the type descriptor of the section, the
 		    /// second is a functor, which takes just one \c std::string
 		    /// parameter. At the reading process, each line of the section
 		    /// will be given to the functor object. However, the empty lines
 		    /// and the comment lines are filtered out, and the leading
 		    /// whitespaces are trimmed from each processed string.
 		    ///
 		    /// For example let's see a section, which contain several
 		    /// integers, which should be inserted into a vector.
 		    ///\code
 		    ///  @numbers
 		    ///  12 45 23
 		    ///  4
 		    ///  23 6
 		    ///\endcode
 		    ///
-		    /// The functor is implemented as an struct:
+		    /// The functor is implemented as a struct:
 		    ///\code
 		    ///  struct NumberSection {
 		    ///    std::vector<int>& _data;
 		    ///    NumberSection(std::vector<int>& data) : _data(data) {}
 		    ///    void operator()(const std::string& line) {
 		    ///      std::istringstream ls(line);
 		    ///      int value;
 		    ///      while (ls >> value) _data.push_back(value);
 		    ///    }
 		    ///  };
 		    ///
 		    ///  // ...
 		    ///
 		    ///  reader.sectionLines("numbers", NumberSection(vec));
 		    ///\endcode
 		    template <typename Functor>
 		    SectionReader& sectionLines(const std::string& type, Functor functor) {
-		      LEMON_ASSERT(!type.empty(), "Type is not empty.");
 		      LEMON_ASSERT(!type.empty(), "Type is empty.");
 		      LEMON_ASSERT(_sections.find(type) == _sections.end(),
 				   "Multiple reading of section.");
 		      _sections.insert(std::make_pair(type,
 		        new _reader_bits::LineSection<Functor>(functor)));
 		      return *this;
+		    }
 		    /// \brief Add a section processor with stream oriented reading
 		    ///
 		    /// The first parameter is the type of the section, the second is
 		    /// a functor, which takes an \c std::istream& and an int&
+		    /// a functor, which takes an \c std::istream& and an \c int&
 		    /// parameter, the latter regard to the line number of stream. The
 		    /// functor can read the input while the section go on, and the
 		    /// line number should be modified accordingly.
 		    template <typename Functor>
 		    SectionReader& sectionStream(const std::string& type, Functor functor) {
-		      LEMON_ASSERT(!type.empty(), "Type is not empty.");
 		      LEMON_ASSERT(!type.empty(), "Type is empty.");
 		      LEMON_ASSERT(_sections.find(type) == _sections.end(),
 				   "Multiple reading of section.");
 		      _sections.insert(std::make_pair(type,
 			 new _reader_bits::StreamSection<Functor>(functor)));
 		      return *this;
+		    }
 		    /// @}
 		  private:
 		    bool readLine() {
 		      std::string str;
 		      while(++line_num, std::getline(*_is, str)) {
 			line.clear(); line.str(str);
 			char c;
 			if (line >> std::ws >> c && c != '#') {
 			  line.putback(c);
 			  return true;
+			}
+		      }
 		      return false;
+		    }
 		    bool readSuccess() {
 		      return static_cast<bool>(*_is);
+		    }
 		    void skipSection() {
 		      char c;
 		      while (readSuccess() && line >> c && c != '@') {
 			readLine();
+		      }
 		      line.putback(c);
+		    }
 		  public:
 		    /// \name Execution of the reader
 		    /// @{
 		    /// \brief Start the batch processing
 		    ///
 		    /// This function starts the batch processing
+		    /// This function starts the batch processing.
 		    void run() {
 		      LEMON_ASSERT(_is != 0, "This reader assigned to an other reader");
 		      std::set<std::string> extra_sections;
 		      line_num = 0;
 		      readLine();
 		      skipSection();
 		      while (readSuccess()) {
 			try {
 			  char c;
 			  std::string section, caption;
 			  line >> c;
 			  _reader_bits::readToken(line, section);
 			  _reader_bits::readToken(line, caption);
 			  if (line >> c)
 			    throw DataFormatError("Extra character on the end of line");
 			  if (extra_sections.find(section) != extra_sections.end()) {
 			    std::ostringstream msg;
 			    msg << "Multiple occurence of section " << section;
@@ -2218,91 +2241,101 @@
 			    extra_sections.insert(section);
 			    it->second->process(*_is, line_num);
+			  }
 			  readLine();
 			  skipSection();
 			} catch (DataFormatError& error) {
 			  error.line(line_num);
 			  throw;
+			}
+		      }
 		      for (Sections::iterator it = _sections.begin();
 			   it != _sections.end(); ++it) {
 			if (extra_sections.find(it->first) == extra_sections.end()) {
 			  std::ostringstream os;
 			  os << "Cannot find section: " << it->first;
 			  throw DataFormatError(os.str().c_str());
+			}
+		      }
+		    }
 		    /// @}
 		  };
 		  /// \brief Return a \ref SectionReader class
 		  ///
 		  /// This function just returns a \ref SectionReader class.
 		  /// \relates SectionReader
 		  inline SectionReader sectionReader(std::istream& is) {
 		    SectionReader tmp(is);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref SectionReader class
 		  ///
 		  /// This function just returns a \ref SectionReader class.
 		  /// \relates SectionReader
 		  inline SectionReader sectionReader(const std::string& fn) {
 		    SectionReader tmp(fn);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref SectionReader class
 		  ///
 		  /// This function just returns a \ref SectionReader class.
 		  /// \relates SectionReader
 		  inline SectionReader sectionReader(const char* fn) {
 		    SectionReader tmp(fn);
 		    return tmp;
+		  }
 		  /// \ingroup lemon_io
 		  ///
 		  /// \brief Reader for the contents of the \ref lgf-format "LGF" file
 		  ///
 		  /// This class can be used to read the sections, the map names and
 		  /// the attributes from a file. Usually, the Lemon programs know
 		  /// that, which type of graph, which maps and which attributes
 		  /// should be read from a file, but in general tools (like glemon)
 		  /// the contents of an LGF file should be guessed somehow. This class
 		  /// reads the graph and stores the appropriate information for
 		  /// reading the graph.
 		  ///
-		  ///\code LgfContents contents("graph.lgf");
 		  ///\code
 		  /// LgfContents contents("graph.lgf");
 		  /// contents.run();
 		  ///
-		  /// // does it contain any node section and arc section
+		  /// // Does it contain any node section and arc section?
 		  /// if (contents.nodeSectionNum() == 0 || contents.arcSectionNum()) {
 		  ///   std::cerr << "Failure, cannot find graph" << std::endl;
+		  ///   std::cerr << "Failure, cannot find graph." << std::endl;
 		  ///   return -1;
 		  /// }
-		  /// std::cout << "The name of the default node section : "
 		  /// std::cout << "The name of the default node section: "
 		  ///           << contents.nodeSection(0) << std::endl;
-		  /// std::cout << "The number of the arc maps : "
 		  /// std::cout << "The number of the arc maps: "
 		  ///           << contents.arcMaps(0).size() << std::endl;
-		  /// std::cout << "The name of second arc map : "
 		  /// std::cout << "The name of second arc map: "
 		  ///           << contents.arcMaps(0)[1] << std::endl;
 		  ///\endcode
 		  class LgfContents {
 		  private:
 		    std::istream* _is;
 		    bool local_is;
 		    std::vector<std::string> _node_sections;
 		    std::vector<std::string> _edge_sections;
 		    std::vector<std::string> _attribute_sections;
 		    std::vector<std::string> _extra_sections;
 		    std::vector<bool> _arc_sections;
 		    std::vector<std::vector<std::string> > _node_maps;
 		    std::vector<std::vector<std::string> > _edge_maps;
 		    std::vector<std::vector<std::string> > _attributes;
 		    int line_num;
 		    std::istringstream line;
@@ -2331,78 +2364,78 @@
 		    /// \brief Destructor
 		    ~LgfContents() {
 		      if (local_is) delete _is;
+		    }
 		  private:
 		    LgfContents(const LgfContents&);
 		    LgfContents& operator=(const LgfContents&);
 		  public:
 		    /// \name Node sections
 		    /// @{
 		    /// \brief Gives back the number of node sections in the file.
 		    ///
 		    /// Gives back the number of node sections in the file.
 		    int nodeSectionNum() const {
 		      return _node_sections.size();
+		    }
 		    /// \brief Returns the section name at the given position.
+		    /// \brief Returns the node section name at the given position.
 		    ///
 		    /// Returns the section name at the given position.
+		    /// Returns the node section name at the given position.
 		    const std::string& nodeSection(int i) const {
 		      return _node_sections[i];
+		    }
 		    /// \brief Gives back the node maps for the given section.
 		    ///
 		    /// Gives back the node maps for the given section.
 		    const std::vector<std::string>& nodeMapNames(int i) const {
 		      return _node_maps[i];
+		    }
 		    /// @}
 		    /// \name Arc/Edge sections
 		    /// @{
 		    /// \brief Gives back the number of arc/edge sections in the file.
 		    ///
 		    /// Gives back the number of arc/edge sections in the file.
 		    /// \note It is synonym of \c edgeSectionNum().
 		    int arcSectionNum() const {
 		      return _edge_sections.size();
+		    }
 		    /// \brief Returns the section name at the given position.
+		    /// \brief Returns the arc/edge section name at the given position.
 		    ///
 		    /// Returns the section name at the given position.
+		    /// Returns the arc/edge section name at the given position.
 		    /// \note It is synonym of \c edgeSection().
 		    const std::string& arcSection(int i) const {
 		      return _edge_sections[i];
+		    }
 		    /// \brief Gives back the arc/edge maps for the given section.
 		    ///
 		    /// Gives back the arc/edge maps for the given section.
 		    /// \note It is synonym of \c edgeMapNames().
 		    const std::vector<std::string>& arcMapNames(int i) const {
 		      return _edge_maps[i];
+		    }
 		    /// @}
 		    /// \name Synonyms
 		    /// @{
 		    /// \brief Gives back the number of arc/edge sections in the file.
 		    ///
 		    /// Gives back the number of arc/edge sections in the file.
 		    /// \note It is synonym of \c arcSectionNum().
 		    int edgeSectionNum() const {
 		      return _edge_sections.size();
@@ -2415,51 +2448,51 @@
 		    const std::string& edgeSection(int i) const {
 		      return _edge_sections[i];
+		    }
 		    /// \brief Gives back the edge maps for the given section.
 		    ///
 		    /// Gives back the edge maps for the given section.
 		    /// \note It is synonym of \c arcMapNames().
 		    const std::vector<std::string>& edgeMapNames(int i) const {
 		      return _edge_maps[i];
+		    }
 		    /// @}
 		    /// \name Attribute sections
 		    /// @{
 		    /// \brief Gives back the number of attribute sections in the file.
 		    ///
 		    /// Gives back the number of attribute sections in the file.
 		    int attributeSectionNum() const {
 		      return _attribute_sections.size();
+		    }
 		    /// \brief Returns the section name at the given position.
+		    /// \brief Returns the attribute section name at the given position.
 		    ///
 		    /// Returns the section name at the given position.
+		    /// Returns the attribute section name at the given position.
 		    const std::string& attributeSectionNames(int i) const {
 		      return _attribute_sections[i];
+		    }
 		    /// \brief Gives back the attributes for the given section.
 		    ///
 		    /// Gives back the attributes for the given section.
 		    const std::vector<std::string>& attributes(int i) const {
 		      return _attributes[i];
+		    }
 		    /// @}
 		    /// \name Extra sections
 		    /// @{
 		    /// \brief Gives back the number of extra sections in the file.
 		    ///
 		    /// Gives back the number of extra sections in the file.
 		    int extraSectionNum() const {
 		      return _extra_sections.size();
+		    }
 		    /// \brief Returns the extra section type at the given position.
@@ -2508,51 +2541,51 @@
 		      std::string map;
 		      while (_reader_bits::readToken(line, map)) {
 			maps.push_back(map);
+		      }
+		    }
 		    void readAttributes(std::vector<std::string>& attrs) {
 		      readLine();
 		      char c;
 		      while (readSuccess() && line >> c && c != '@') {
 			line.putback(c);
 			std::string attr;
 			_reader_bits::readToken(line, attr);
 			attrs.push_back(attr);
 			readLine();
+		      }
 		      line.putback(c);
+		    }
 		  public:
 		    /// \name Execution of the contents reader
 		    /// @{
-		    /// \brief Start the reading
+		    /// \brief Starts the reading
 		    ///
 		    /// This function starts the reading
+		    /// This function starts the reading.
 		    void run() {
 		      readLine();
 		      skipSection();
 		      while (readSuccess()) {
 			char c;
 			line >> c;
 			std::string section, caption;
 			_reader_bits::readToken(line, section);
 			_reader_bits::readToken(line, caption);
 			if (section == "nodes") {
 			  _node_sections.push_back(caption);
 			  _node_maps.push_back(std::vector<std::string>());
 			  readMaps(_node_maps.back());
 			  readLine(); skipSection();
 			} else if (section == "arcs" || section == "edges") {
 			  _edge_sections.push_back(caption);
 			  _arc_sections.push_back(section == "arcs");
 			  _edge_maps.push_back(std::vector<std::string>());
 			  readMaps(_edge_maps.back());

lemon/lgf_writer.h

Show inline comments

 		/* -*- C++ -*-
+		 *
 		 * This file is a part of LEMON, a generic C++ optimization library
+		 *
 		 * Copyright (C) 2003-2008
 		 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
 		 * (Egervary Research Group on Combinatorial Optimization, EGRES).
+		 *
 		 * Permission to use, modify and distribute this software is granted
 		 * provided that this copyright notice appears in all copies. For
 		 * precise terms see the accompanying LICENSE file.
+		 *
 		 * This software is provided "AS IS" with no warranty of any kind,
 		 * express or implied, and with no claim as to its suitability for any
 		 * purpose.
+		 *
 		 */
 		///\ingroup lemon_io
 		///\file
 		///\brief Lemon Graph Format writer.
+		///\brief \ref lgf-format "Lemon Graph Format" writer.
 		#ifndef LEMON_LGF_WRITER_H
 		#define LEMON_LGF_WRITER_H
 		#include <iostream>
 		#include <fstream>
 		#include <sstream>
 		#include <algorithm>
 		#include <vector>
 		#include <functional>
 		#include <lemon/assert.h>
 		#include <lemon/graph_utils.h>
 		namespace lemon {
 		  namespace _writer_bits {
 		    template <typename Value>
 		    struct DefaultConverter {
 		      std::string operator()(const Value& value) {
@@ -301,74 +301,74 @@
 			os << str;
+		      }
 		      return os;
+		    }
+		  }
 		  template <typename Digraph>
 		  class DigraphWriter;
 		  template <typename Digraph>
 		  DigraphWriter<Digraph> digraphWriter(std::ostream& os,
 						       const Digraph& digraph);
 		  template <typename Digraph>
 		  DigraphWriter<Digraph> digraphWriter(const std::string& fn,
 						       const Digraph& digraph);
 		  template <typename Digraph>
 		  DigraphWriter<Digraph> digraphWriter(const char *fn,
 						       const Digraph& digraph);
 		  /// \ingroup lemon_io
 		  ///
 		  /// \brief LGF writer for directed graphs
+		  /// \brief \ref lgf-format "LGF" writer for directed graphs
 		  ///
 		  /// This utility writes an \ref lgf-format "LGF" file.
 		  ///
 		  /// The writing method does a batch processing. The user creates a
 		  /// writer object, then various writing rules can be added to the
 		  /// writer, and eventually the writing is executed with the \c run()
 		  /// member function. A map writing rule can be added to the writer
 		  /// with the \c nodeMap() or \c arcMap() members. An optional
 		  /// converter parameter can also be added as a standard functor
 		  /// converting from the value type of the map to std::string. If it
 		  /// is set, it will determine how the map's value type is written to
 		  /// converting from the value type of the map to \c std::string. If it
 		  /// is set, it will determine how the value type of the map is written to
 		  /// the output stream. If the functor is not set, then a default
 		  /// conversion will be used. The \c attribute(), \c node() and \c
 		  /// arc() functions are used to add attribute writing rules.
 		  ///
 		  ///\code
 		  ///     DigraphWriter<Digraph>(std::cout, digraph).
 		  ///       nodeMap("coordinates", coord_map).
 		  ///       nodeMap("size", size).
 		  ///       nodeMap("title", title).
 		  ///       arcMap("capacity", cap_map).
 		  ///       node("source", src).
 		  ///       node("target", trg).
 		  ///       attribute("caption", caption).
-		  ///       run();
+		  /// DigraphWriter<Digraph>(std::cout, digraph).
 		  ///   nodeMap("coordinates", coord_map).
 		  ///   nodeMap("size", size).
 		  ///   nodeMap("title", title).
 		  ///   arcMap("capacity", cap_map).
 		  ///   node("source", src).
 		  ///   node("target", trg).
 		  ///   attribute("caption", caption).
 		  ///   run();
 		  ///\endcode
 		  ///
 		  ///
 		  /// By default, the writer does not write additional captions to the
 		  /// sections, but they can be give as an optional parameter of
 		  /// the \c nodes(), \c arcs() or \c
 		  /// attributes() functions.
 		  ///
 		  /// The \c skipNodes() and \c skipArcs() functions forbid the
 		  /// writing of the sections. If two arc sections should be written
 		  /// to the output, it can be done in two passes, the first pass
 		  /// writes the node section and the first arc section, then the
 		  /// second pass skips the node section and writes just the arc
 		  /// section to the stream. The output stream can be retrieved with
 		  /// the \c ostream() function, hence the second pass can append its
 		  /// output to the output of the first pass.
 		  template <typename _Digraph>
 		  class DigraphWriter {
 		  public:
 		    typedef _Digraph Digraph;
 		    TEMPLATE_DIGRAPH_TYPEDEFS(Digraph);
 		  private:
@@ -465,51 +465,51 @@
 			_skip_nodes(other._skip_nodes), _skip_arcs(other._skip_arcs) {
 		      other._os = 0;
 		      other.local_os = false;
 		      _node_index.swap(other._node_index);
 		      _arc_index.swap(other._arc_index);
 		      _node_maps.swap(other._node_maps);
 		      _arc_maps.swap(other._arc_maps);
 		      _attributes.swap(other._attributes);
 		      _nodes_caption = other._nodes_caption;
 		      _arcs_caption = other._arcs_caption;
 		      _attributes_caption = other._attributes_caption;
+		    }
 		    DigraphWriter& operator=(const DigraphWriter&);
 		  public:
 		    /// \name Writing rules
 		    /// @{
-		    /// \brief Node map reading rule
+		    /// \brief Node map writing rule
 		    ///
-		    /// Add a node map reading rule to the writer.
+		    /// Add a node map writing rule to the writer.
 		    template <typename Map>
 		    DigraphWriter& nodeMap(const std::string& caption, const Map& map) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Node>* storage =
 			new _writer_bits::MapStorage<Node, Map>(map);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node map writing rule
 		    ///
 		    /// Add a node map writing rule with specialized converter to the
 		    /// writer.
 		    template <typename Map, typename Converter>
 		    DigraphWriter& nodeMap(const std::string& caption, const Map& map,
 					   const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Node>* storage =
 			new _writer_bits::MapStorage<Node, Map, Converter>(map, converter);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc map writing rule
@@ -565,90 +565,90 @@
 		    /// \brief Node writing rule
 		    ///
 		    /// Add a node writing rule to the writer.
 		    DigraphWriter& node(const std::string& caption, const Node& node) {
 		      typedef _writer_bits::MapLookUpConverter<Node> Converter;
 		      Converter converter(_node_index);
 		      _writer_bits::ValueStorageBase* storage =
 			new _writer_bits::ValueStorage<Node, Converter>(node, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc writing rule
 		    ///
 		    /// Add an arc writing rule to writer.
 		    DigraphWriter& arc(const std::string& caption, const Arc& arc) {
 		      typedef _writer_bits::MapLookUpConverter<Arc> Converter;
 		      Converter converter(_arc_index);
 		      _writer_bits::ValueStorageBase* storage =
 			new _writer_bits::ValueStorage<Arc, Converter>(arc, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
-		    /// \name Select section by name
+		    /// \name Section captions
 		    /// @{
-		    /// \brief Set \c \@nodes section to be read
+		    /// \brief Add an additional caption to the \c \@nodes section
 		    ///
-		    /// Set \c \@nodes section to be read
+		    /// Add an additional caption to the \c \@nodes section.
 		    DigraphWriter& nodes(const std::string& caption) {
 		      _nodes_caption = caption;
 		      return *this;
+		    }
-		    /// \brief Set \c \@arcs section to be read
+		    /// \brief Add an additional caption to the \c \@arcs section
 		    ///
-		    /// Set \c \@arcs section to be read
+		    /// Add an additional caption to the \c \@arcs section.
 		    DigraphWriter& arcs(const std::string& caption) {
 		      _arcs_caption = caption;
 		      return *this;
+		    }
-		    /// \brief Set \c \@attributes section to be read
+		    /// \brief Add an additional caption to the \c \@attributes section
 		    ///
-		    /// Set \c \@attributes section to be read
+		    /// Add an additional caption to the \c \@attributes section.
 		    DigraphWriter& attributes(const std::string& caption) {
 		      _attributes_caption = caption;
 		      return *this;
+		    }
 		    /// \name Skipping section
 		    /// @{
 		    /// \brief Skip writing the node set
 		    ///
-		    /// The \c \@nodes section will be not written to the stream.
+		    /// The \c \@nodes section will not be written to the stream.
 		    DigraphWriter& skipNodes() {
 		      LEMON_ASSERT(!_skip_nodes, "Multiple usage of skipNodes() member");
 		      _skip_nodes = true;
 		      return *this;
+		    }
 		    /// \brief Skip writing arc set
 		    ///
-		    /// The \c \@arcs section will be not written to the stream.
+		    /// The \c \@arcs section will not be written to the stream.
 		    DigraphWriter& skipArcs() {
 		      LEMON_ASSERT(!_skip_arcs, "Multiple usage of skipArcs() member");
 		      _skip_arcs = true;
 		      return *this;
+		    }
 		    /// @}
 		  private:
 		    void writeNodes() {
 		      _writer_bits::MapStorageBase<Node>* label = 0;
 		      for (typename NodeMaps::iterator it = _node_maps.begin();
 			   it != _node_maps.end(); ++it) {
 		        if (it->first == "label") {
 			  label = it->second;
 			  break;
+			}
+		      }
 		      *_os << "@nodes";
 		      if (!_nodes_caption.empty()) {
 			_writer_bits::writeToken(*_os << ' ', _nodes_caption);
+		      }
@@ -814,114 +814,127 @@
+		    }
 		    void writeAttributes() {
 		      if (_attributes.empty()) return;
 		      *_os << "@attributes";
 		      if (!_attributes_caption.empty()) {
 			_writer_bits::writeToken(*_os << ' ', _attributes_caption);
+		      }
 		      *_os << std::endl;
 		      for (typename Attributes::iterator it = _attributes.begin();
 			   it != _attributes.end(); ++it) {
 			_writer_bits::writeToken(*_os, it->first) << ' ';
 			_writer_bits::writeToken(*_os, it->second->get());
 			*_os << std::endl;
+		      }
+		    }
 		  public:
 		    /// \name Execution of the writer
 		    /// @{
 		    /// \brief Start the batch processing
 		    ///
 		    /// This function starts the batch processing
+		    /// This function starts the batch processing.
 		    void run() {
 		      if (!_skip_nodes) {
 			writeNodes();
 		      } else {
 			createNodeIndex();
+		      }
 		      if (!_skip_arcs) {
 			writeArcs();
 		      } else {
 			createArcIndex();
+		      }
 		      writeAttributes();
+		    }
-		    /// \brief Gives back the stream of the writer
+		    /// \brief Give back the stream of the writer
 		    ///
-		    /// Gives back the stream of the writer
+		    /// Give back the stream of the writer.
 		    std::ostream& ostream() {
 		      return *_os;
+		    }
 		    /// @}
 		  };
 		  /// \brief Return a \ref DigraphWriter class
 		  ///
 		  /// This function just returns a \ref DigraphWriter class.
 		  /// \relates DigraphWriter
 		  template <typename Digraph>
 		  DigraphWriter<Digraph> digraphWriter(std::ostream& os,
 						       const Digraph& digraph) {
 		    DigraphWriter<Digraph> tmp(os, digraph);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref DigraphWriter class
 		  ///
 		  /// This function just returns a \ref DigraphWriter class.
 		  /// \relates DigraphWriter
 		  template <typename Digraph>
 		  DigraphWriter<Digraph> digraphWriter(const std::string& fn,
 						       const Digraph& digraph) {
 		    DigraphWriter<Digraph> tmp(fn, digraph);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref DigraphWriter class
 		  ///
 		  /// This function just returns a \ref DigraphWriter class.
 		  /// \relates DigraphWriter
 		  template <typename Digraph>
 		  DigraphWriter<Digraph> digraphWriter(const char* fn,
 						       const Digraph& digraph) {
 		    DigraphWriter<Digraph> tmp(fn, digraph);
 		    return tmp;
+		  }
 		  template <typename Graph>
 		  class GraphWriter;
 		  template <typename Graph>
 		  GraphWriter<Graph> graphWriter(std::ostream& os, const Graph& graph);
 		  template <typename Graph>
 		  GraphWriter<Graph> graphWriter(const std::string& fn, const Graph& graph);
 		  template <typename Graph>
 		  GraphWriter<Graph> graphWriter(const char *fn, const Graph& graph);
 		  /// \ingroup lemon_io
 		  ///
 		  /// \brief LGF writer for directed graphs
+		  /// \brief \ref lgf-format "LGF" writer for directed graphs
 		  ///
 		  /// This utility writes an \ref lgf-format "LGF" file.
 		  ///
 		  /// It can be used almost the same way as \c DigraphWriter.
 		  /// The only difference is that this class can handle edges and
 		  /// edge maps as well as arcs and arc maps.
 		  template <typename _Graph>
 		  class GraphWriter {
 		  public:
 		    typedef _Graph Graph;
 		    TEMPLATE_GRAPH_TYPEDEFS(Graph);
 		  private:
 		    std::ostream* _os;
 		    bool local_os;
 		    Graph& _graph;
 		    std::string _nodes_caption;
 		    std::string _edges_caption;
 		    std::string _attributes_caption;
 		    typedef std::map<Node, std::string> NodeIndex;
 		    NodeIndex _node_index;
 		    typedef std::map<Edge, std::string> EdgeIndex;
 		    EdgeIndex _edge_index;
@@ -1002,51 +1015,51 @@
 			_skip_nodes(other._skip_nodes), _skip_edges(other._skip_edges) {
 		      other._os = 0;
 		      other.local_os = false;
 		      _node_index.swap(other._node_index);
 		      _edge_index.swap(other._edge_index);
 		      _node_maps.swap(other._node_maps);
 		      _edge_maps.swap(other._edge_maps);
 		      _attributes.swap(other._attributes);
 		      _nodes_caption = other._nodes_caption;
 		      _edges_caption = other._edges_caption;
 		      _attributes_caption = other._attributes_caption;
+		    }
 		    GraphWriter& operator=(const GraphWriter&);
 		  public:
 		    /// \name Writing rules
 		    /// @{
-		    /// \brief Node map reading rule
+		    /// \brief Node map writing rule
 		    ///
-		    /// Add a node map reading rule to the writer.
+		    /// Add a node map writing rule to the writer.
 		    template <typename Map>
 		    GraphWriter& nodeMap(const std::string& caption, const Map& map) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Node>* storage =
 			new _writer_bits::MapStorage<Node, Map>(map);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Node map writing rule
 		    ///
 		    /// Add a node map writing rule with specialized converter to the
 		    /// writer.
 		    template <typename Map, typename Converter>
 		    GraphWriter& nodeMap(const std::string& caption, const Map& map,
 					   const Converter& converter = Converter()) {
 		      checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 		      _writer_bits::MapStorageBase<Node>* storage =
 			new _writer_bits::MapStorage<Node, Map, Converter>(map, converter);
 		      _node_maps.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Edge map writing rule
@@ -1148,90 +1161,90 @@
 		    /// \brief Edge writing rule
 		    ///
 		    /// Add an edge writing rule to writer.
 		    GraphWriter& edge(const std::string& caption, const Edge& edge) {
 		      typedef _writer_bits::MapLookUpConverter<Edge> Converter;
 		      Converter converter(_edge_index);
 		      _writer_bits::ValueStorageBase* storage =
 			new _writer_bits::ValueStorage<Edge, Converter>(edge, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
 		    /// \brief Arc writing rule
 		    ///
 		    /// Add an arc writing rule to writer.
 		    GraphWriter& arc(const std::string& caption, const Arc& arc) {
 		      typedef _writer_bits::GraphArcLookUpConverter<Graph> Converter;
 		      Converter converter(_graph, _edge_index);
 		      _writer_bits::ValueStorageBase* storage =
 			new _writer_bits::ValueStorage<Arc, Converter>(arc, converter);
 		      _attributes.push_back(std::make_pair(caption, storage));
 		      return *this;
+		    }
-		    /// \name Select section by name
+		    /// \name Section captions
 		    /// @{
-		    /// \brief Set \c \@nodes section to be read
+		    /// \brief Add an additional caption to the \c \@nodes section
 		    ///
-		    /// Set \c \@nodes section to be read
+		    /// Add an additional caption to the \c \@nodes section.
 		    GraphWriter& nodes(const std::string& caption) {
 		      _nodes_caption = caption;
 		      return *this;
+		    }
-		    /// \brief Set \c \@edges section to be read
+		    /// \brief Add an additional caption to the \c \@arcs section
 		    ///
-		    /// Set \c \@edges section to be read
+		    /// Add an additional caption to the \c \@arcs section.
 		    GraphWriter& edges(const std::string& caption) {
 		      _edges_caption = caption;
 		      return *this;
+		    }
-		    /// \brief Set \c \@attributes section to be read
+		    /// \brief Add an additional caption to the \c \@attributes section
 		    ///
-		    /// Set \c \@attributes section to be read
+		    /// Add an additional caption to the \c \@attributes section.
 		    GraphWriter& attributes(const std::string& caption) {
 		      _attributes_caption = caption;
 		      return *this;
+		    }
 		    /// \name Skipping section
 		    /// @{
 		    /// \brief Skip writing the node set
 		    ///
-		    /// The \c \@nodes section will be not written to the stream.
+		    /// The \c \@nodes section will not be written to the stream.
 		    GraphWriter& skipNodes() {
 		      LEMON_ASSERT(!_skip_nodes, "Multiple usage of skipNodes() member");
 		      _skip_nodes = true;
 		      return *this;
+		    }
 		    /// \brief Skip writing edge set
 		    ///
-		    /// The \c \@edges section will be not written to the stream.
+		    /// The \c \@edges section will not be written to the stream.
 		    GraphWriter& skipEdges() {
 		      LEMON_ASSERT(!_skip_edges, "Multiple usage of skipEdges() member");
 		      _skip_edges = true;
 		      return *this;
+		    }
 		    /// @}
 		  private:
 		    void writeNodes() {
 		      _writer_bits::MapStorageBase<Node>* label = 0;
 		      for (typename NodeMaps::iterator it = _node_maps.begin();
 			   it != _node_maps.end(); ++it) {
 		        if (it->first == "label") {
 			  label = it->second;
 			  break;
+			}
+		      }
 		      *_os << "@nodes";
 		      if (!_nodes_caption.empty()) {
 			_writer_bits::writeToken(*_os << ' ', _nodes_caption);
+		      }
@@ -1397,72 +1410,81 @@
+		    }
 		    void writeAttributes() {
 		      if (_attributes.empty()) return;
 		      *_os << "@attributes";
 		      if (!_attributes_caption.empty()) {
 			_writer_bits::writeToken(*_os << ' ', _attributes_caption);
+		      }
 		      *_os << std::endl;
 		      for (typename Attributes::iterator it = _attributes.begin();
 			   it != _attributes.end(); ++it) {
 			_writer_bits::writeToken(*_os, it->first) << ' ';
 			_writer_bits::writeToken(*_os, it->second->get());
 			*_os << std::endl;
+		      }
+		    }
 		  public:
 		    /// \name Execution of the writer
 		    /// @{
 		    /// \brief Start the batch processing
 		    ///
 		    /// This function starts the batch processing
+		    /// This function starts the batch processing.
 		    void run() {
 		      if (!_skip_nodes) {
 			writeNodes();
 		      } else {
 			createNodeIndex();
+		      }
 		      if (!_skip_edges) {
 			writeEdges();
 		      } else {
 			createEdgeIndex();
+		      }
 		      writeAttributes();
+		    }
-		    /// \brief Gives back the stream of the writer
+		    /// \brief Give back the stream of the writer
 		    ///
-		    /// Gives back the stream of the writer
+		    /// Give back the stream of the writer
 		    std::ostream& ostream() {
 		      return *_os;
+		    }
 		    /// @}
 		  };
 		  /// \brief Return a \ref GraphWriter class
 		  ///
 		  /// This function just returns a \ref GraphWriter class.
 		  /// \relates GraphWriter
 		  template <typename Graph>
 		  GraphWriter<Graph> graphWriter(std::ostream& os, const Graph& graph) {
 		    GraphWriter<Graph> tmp(os, graph);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref GraphWriter class
 		  ///
 		  /// This function just returns a \ref GraphWriter class.
 		  /// \relates GraphWriter
 		  template <typename Graph>
 		  GraphWriter<Graph> graphWriter(const std::string& fn, const Graph& graph) {
 		    GraphWriter<Graph> tmp(fn, graph);
 		    return tmp;
+		  }
 		  /// \brief Return a \ref GraphWriter class
 		  ///
 		  /// This function just returns a \ref GraphWriter class.
 		  /// \relates GraphWriter
 		  template <typename Graph>
 		  GraphWriter<Graph> graphWriter(const char* fn, const Graph& graph) {
 		    GraphWriter<Graph> tmp(fn, graph);
 		    return tmp;
+		  }
+		}
 		#endif

0 comments (0 inline)

RhodeCode

Login to your account