lemon-0.x: comparison lemon/graph

equal deleted inserted replaced

-:3b272d0d07e0
+:5904e8a90656
 /// \brief The graph reader class.
 ///
 /// The \c GraphReader class provides the graph input.
 /// Before you read this documentation it might be useful to read the general
 /// description of  \ref graph-io-page "Graph Input-Output".
+///
 /// If you don't need very sophisticated
 /// behaviour then you can use the versions of the public function
 /// \ref readGraph() to read a graph (or a max flow instance etc).
 ///
-/// The given file format may contain several maps and labeled nodes or
+/// The file to be read may contain several maps and labeled nodes or
 /// edges.
 ///
 /// If you read a graph you need not read all the maps and items just those
 /// that you need. The interface of the \c GraphReader is very similar to
 /// the GraphWriter but the reading method does not depend on the order the
-/// given commands.
+/// given commands (i.e. you don't have to insist on the order in which the
-///
+/// maps are given in the file).
-/// The reader object suppose that each not readed value does not contain
+///
+/// The reader object assumes that not readed values do not contain
 /// whitespaces, therefore it has some extra possibilities to control how
 /// it should skip the values when the string representation contains spaces.
 ///
 /// \code
 /// GraphReader<ListGraph> reader(std::cin, graph);
 ///
 /// reader.readEdge("observed", edge);
 /// \endcode
 ///
 /// With the \c readAttribute() functions you can read an attribute
-/// in a variable. You can specify the reader for the attribute as
+/// into a variable. You can specify the reader for the attribute as
 /// the nodemaps.
 ///
 /// After you give all read commands you must call the \c run() member
-/// function, which execute all the commands.
+/// function, which executes all the commands.
 ///
 /// \code
 /// reader.run();
 /// \endcode
 ///
 typedef typename ReaderTraits::Skipper DefaultSkipper;
 /// \brief Construct a new GraphReader.
 ///
 /// Construct a new GraphReader. It reads into the given graph
-/// and it use the given reader as the default skipper.
+/// and it uses the given reader as the default skipper.
 GraphReader(std::istream& _is,
 		typename SmartParameter<Graph>::Type _graph,
 		const DefaultSkipper& _skipper = DefaultSkipper())
 : reader(new LemonReader(_is)), own_reader(true), skipper(_skipper),
 	nodeset_reader(*reader, _graph, std::string(), skipper),
 	attribute_reader(*reader, std::string()) {}
 /// \brief Construct a new GraphReader.
 ///
 /// Construct a new GraphReader. It reads into the given graph
-/// and it use the given reader as the default skipper.
+/// and it uses the given reader as the default skipper.
 GraphReader(const std::string& _filename,
 		typename SmartParameter<Graph>::Type _graph,
 		const DefaultSkipper& _skipper = DefaultSkipper())
 : reader(new LemonReader(_filename)), own_reader(true),
 	skipper(_skipper),
 	attribute_reader(*reader, std::string()) {}
 /// \brief Construct a new GraphReader.
 ///
 /// Construct a new GraphReader. It reads into the given graph
-/// and it use the given reader as the default skipper.
+/// and it uses the given reader as the default skipper.
 GraphReader(LemonReader& _reader,
 		typename SmartParameter<Graph>::Type _graph,
 		const DefaultSkipper& _skipper = DefaultSkipper())
 : reader(_reader), own_reader(false), skipper(_skipper),
 	nodeset_reader(*reader, _graph, std::string(), skipper),
 ~GraphReader() {
 if (own_reader)
 	delete reader;
 }
-/// \brief Add a new node map reader command for the reader.
+/// \brief Give a new node map reading command to the reader.
 ///
-/// Add a new node map reader command for the reader.
+/// Give a new node map reading command to the reader.
 template <typename Map>
 GraphReader& readNodeMap(std::string name, Map& map) {
 nodeset_reader.readNodeMap(name, map);
 return *this;
 }
 GraphReader& readNodeMap(std::string name, const Map& map) {
 nodeset_reader.readNodeMap(name, map);
 return *this;
 }
-/// \brief Add a new node map reader command for the reader.
+/// \brief Give a new node map reading command to the reader.
 ///
-/// Add a new node map reader command for the reader.
+/// Give a new node map reading command to the reader.
 template <typename Reader, typename Map>
 GraphReader& readNodeMap(std::string name, Map& map,
 			     const Reader& reader = Reader()) {
 nodeset_reader.readNodeMap(name, map, reader);
 return *this;
 			     const Reader& reader = Reader()) {
 nodeset_reader.readNodeMap(name, map, reader);
 return *this;
 }
-/// \brief Add a new node map skipper command for the reader.
+/// \brief Give a new node map skipping command to the reader.
 ///
-/// Add a new node map skipper command for the reader.
+/// Give a new node map skipping command to the reader.
 template <typename Reader>
 GraphReader& skipNodeMap(std::string name,
 			     const Reader& reader = Reader()) {
 nodeset_reader.skipNodeMap(name, reader);
 return *this;
 }
-/// \brief Add a new edge map reader command for the reader.
+/// \brief Give a new edge map reading command to the reader.
 ///
-/// Add a new edge map reader command for the reader.
+/// Give a new edge map reading command to the reader.
 template <typename Map>
 GraphReader& readEdgeMap(std::string name, Map& map) {
 edgeset_reader.readEdgeMap(name, map);
 return *this;
 }
 edgeset_reader.readEdgeMap(name, map);
 return *this;
 }
-/// \brief Add a new edge map reader command for the reader.
+/// \brief Give a new edge map reading command to the reader.
 ///
-/// Add a new edge map reader command for the reader.
+/// Give a new edge map reading command to the reader.
 template <typename Reader, typename Map>
 GraphReader& readEdgeMap(std::string name, Map& map,
 			     const Reader& reader = Reader()) {
 edgeset_reader.readEdgeMap(name, map, reader);
 return *this;
 			     const Reader& reader = Reader()) {
 edgeset_reader.readEdgeMap(name, map, reader);
 return *this;
 }
-/// \brief Add a new edge map skipper command for the reader.
+/// \brief Give a new edge map skipping command to the reader.
 ///
-/// Add a new edge map skipper command for the reader.
+/// Give a new edge map skipping command to the reader.
 template <typename Reader>
 GraphReader& skipEdgeMap(std::string name,
 			     const Reader& reader = Reader()) {
 edgeset_reader.skipEdgeMap(name, reader);
 return *this;
 }
-/// \brief Add a new labeled node reader for the reader.
+/// \brief Give a new labeled node reading command to the reader.
 ///
-/// Add a new labeled node reader for the reader.
+/// Give a new labeled node reading command to the reader.
 GraphReader& readNode(std::string name, Node& node) {
 node_reader.readNode(name, node);
 return *this;
 }
-/// \brief Add a new labeled edge reader for the reader.
+/// \brief Give a new labeled edge reading command to the reader.
 ///
-/// Add a new labeled edge reader for the reader.
+/// Give a new labeled edge reading command to the reader.
 GraphReader& readEdge(std::string name, Edge& edge) {
 edge_reader.readEdge(name, edge);
 return *this;
 }
-/// \brief Add a new attribute reader command.
+/// \brief Give a new attribute reading command.
 ///
-///  Add a new attribute reader command.
+///  Give a new attribute reading command.
 template <typename Value>
 GraphReader& readAttribute(std::string name, Value& value) {
 attribute_reader.readAttribute(name, value);
 return *this;
 }
-/// \brief Add a new attribute reader command.
+/// \brief Give a new attribute reading command.
 ///
-///  Add a new attribute reader command.
+///  Give a new attribute reading command.
 template <typename Reader, typename Value>
 GraphReader& readAttribute(std::string name, Value& value,
 			       const Reader& reader) {
 attribute_reader.readAttribute<Reader>(name, value, reader);
 return *this;
 }
 /// \brief Conversion operator to LemonReader.
 ///
-/// Conversion operator to LemonReader. It make possible
+/// Conversion operator to LemonReader. It makes possible to access the
-/// to access the encapsulated \e LemonReader, this way
+/// encapsulated \e LemonReader, this way you can attach to this reader
-/// you can attach to this reader new instances of
+/// new instances of \e LemonReader::SectionReader. For more details see
-/// \e LemonReader::SectionReader.
+/// the \ref rwbackground "Background of Reading and Writing".
 operator LemonReader&() {
 return *reader;
 }
-/// \brief Executes the reader commands.
+/// \brief Executes the reading commands.
 ///
-/// Executes the reader commands.
+/// Executes the reading commands.
 void run() {
 reader->run();
 }
 /// \brief Gives back the node by its id.
 }
 /// \brief The undir graph reader class.
 ///
+/// The \c UndirGraphReader class provides the graph input.
+/// Before you read this documentation it might be useful to read the general
+/// description of  \ref graph-io-page "Graph Input-Output".
+///
+/// If you don't need very sophisticated
+/// behaviour then you can use the versions of the public function
+/// \ref readGraph() to read a graph (or a max flow instance etc).
+///
 /// The given file format may contain several maps and labeled nodes or
 /// edges.
 ///
 /// If you read a graph you need not read all the maps and items just those
-/// that you need. The interface of the \c GraphReader is very similar to
+/// that you need. The interface of the \c UndirGraphReader is very similar
-/// the GraphWriter but the reading method does not depend on the order the
+/// to the UndirGraphWriter but the reading method does not depend on the
-/// given commands.
+/// order of the given commands.
 ///
 /// The reader object suppose that each not readed value does not contain
 /// whitespaces, therefore it has some extra possibilities to control how
 /// it should skip the values when the string representation contains spaces.
 ///
 ~UndirGraphReader() {
 if (own_reader)
 	delete reader;
 }
-/// \brief Add a new node map reader command for the reader.
+/// \brief Give a new node map reading command to the reader.
 ///
-/// Add a new node map reader command for the reader.
+/// Give a new node map reading command to the reader.
 template <typename Map>
 UndirGraphReader& readNodeMap(std::string name, Map& map) {
 nodeset_reader.readNodeMap(name, map);
 return *this;
 }
 UndirGraphReader& readNodeMap(std::string name, const Map& map) {
 nodeset_reader.readNodeMap(name, map);
 return *this;
 }
-/// \brief Add a new node map reader command for the reader.
+/// \brief Give a new node map reading command to the reader.
 ///
-/// Add a new node map reader command for the reader.
+/// Give a new node map reading command to the reader.
 template <typename Reader, typename Map>
 UndirGraphReader& readNodeMap(std::string name, Map& map,
 				  const Reader& reader = Reader()) {
 nodeset_reader.readNodeMap(name, map, reader);
 return *this;
 				  const Reader& reader = Reader()) {
 nodeset_reader.readNodeMap(name, map, reader);
 return *this;
 }
-/// \brief Add a new node map skipper command for the reader.
+/// \brief Give a new node map skipping command to the reader.
 ///
-/// Add a new node map skipper command for the reader.
+/// Give a new node map skipping command to the reader.
 template <typename Reader>
 UndirGraphReader& skipNodeMap(std::string name,
 			     const Reader& reader = Reader()) {
 nodeset_reader.skipNodeMap(name, reader);
 return *this;
 }
-/// \brief Add a new undirected edge map reader command for the reader.
+/// \brief Give a new undirected edge map reading command to the reader.
 ///
-/// Add a new undirected edge map reader command for the reader.
+/// Give a new undirected edge map reading command to the reader.
 template <typename Map>
 UndirGraphReader& readUndirEdgeMap(std::string name, Map& map) {
 undir_edgeset_reader.readUndirEdgeMap(name, map);
 return *this;
 }
 undir_edgeset_reader.readUndirEdgeMap(name, map);
 return *this;
 }
-/// \brief Add a new undirected edge map reader command for the reader.
+/// \brief Give a new undirected edge map reading command to the reader.
 ///
-/// Add a new undirected edge map reader command for the reader.
+/// Give a new undirected edge map reading command to the reader.
 template <typename Reader, typename Map>
 UndirGraphReader& readUndirEdgeMap(std::string name, Map& map,
 				       const Reader& reader = Reader()) {
 undir_edgeset_reader.readUndirEdgeMap(name, map, reader);
 return *this;
 				       const Reader& reader = Reader()) {
 undir_edgeset_reader.readUndirEdgeMap(name, map, reader);
 return *this;
 }
-/// \brief Add a new undirected edge map skipper command for the reader.
+/// \brief Give a new undirected edge map skipping command to the reader.
 ///
-/// Add a new undirected edge map skipper command for the reader.
+/// Give a new undirected edge map skipping command to the reader.
 template <typename Reader>
 UndirGraphReader& skipUndirEdgeMap(std::string name,
 				       const Reader& reader = Reader()) {
 undir_edgeset_reader.skipUndirMap(name, reader);
 return *this;
 }
-/// \brief Add a new edge map reader command for the reader.
+/// \brief Give a new edge map reading command to the reader.
 ///
-/// Add a new edge map reader command for the reader.
+/// Give a new edge map reading command to the reader.
 template <typename Map>
 UndirGraphReader& readEdgeMap(std::string name, Map& map) {
 undir_edgeset_reader.readEdgeMap(name, map);
 return *this;
 }
 undir_edgeset_reader.readEdgeMap(name, map);
 return *this;
 }
-/// \brief Add a new edge map reader command for the reader.
+/// \brief Give a new edge map reading command to the reader.
 ///
-/// Add a new edge map reader command for the reader.
+/// Give a new edge map reading command to the reader.
 template <typename Reader, typename Map>
 UndirGraphReader& readEdgeMap(std::string name, Map& map,
 				       const Reader& reader = Reader()) {
 undir_edgeset_reader.readEdgeMap(name, map, reader);
 return *this;
 				       const Reader& reader = Reader()) {
 undir_edgeset_reader.readEdgeMap(name, map, reader);
 return *this;
 }
-/// \brief Add a new edge map skipper command for the reader.
+/// \brief Give a new edge map skipping command to the reader.
 ///
-/// Add a new edge map skipper command for the reader.
+/// Give a new edge map skipping command to the reader.
 template <typename Reader>
 UndirGraphReader& skipEdgeMap(std::string name,
 				       const Reader& reader = Reader()) {
 undir_edgeset_reader.skipEdgeMap(name, reader);
 return *this;
 }
-/// \brief Add a new labeled node reader for the reader.
+/// \brief Give a new labeled node reading command to the reader.
 ///
-/// Add a new labeled node reader for the reader.
+/// Give a new labeled node reading command to the reader.
 UndirGraphReader& readNode(std::string name, Node& node) {
 node_reader.readNode(name, node);
 return *this;
 }
-/// \brief Add a new labeled edge reader for the reader.
+/// \brief Give a new labeled edge reading command to the reader.
 ///
-/// Add a new labeled edge reader for the reader.
+/// Give a new labeled edge reading command to the reader.
 UndirGraphReader& readEdge(std::string name, Edge& edge) {
 undir_edge_reader.readEdge(name, edge);
 }
-/// \brief Add a new labeled undirected edge reader for the reader.
+/// \brief Give a new labeled undirected edge reading command to the
-///
+/// reader.
-/// Add a new labeled undirected edge reader for the reader.
+///
+/// Give a new labeled undirected edge reading command to the reader.
 UndirGraphReader& readUndirEdge(std::string name, UndirEdge& edge) {
 undir_edge_reader.readUndirEdge(name, edge);
 }
-/// \brief Add a new attribute reader command.
+/// \brief Give a new attribute reading command.
 ///
-///  Add a new attribute reader command.
+///  Give a new attribute reading command.
 template <typename Value>
 UndirGraphReader& readAttribute(std::string name, Value& value) {
 attribute_reader.readAttribute(name, value);
 return *this;
 }
-/// \brief Add a new attribute reader command.
+/// \brief Give a new attribute reading command.
 ///
-///  Add a new attribute reader command.
+///  Give a new attribute reading command.
 template <typename Reader, typename Value>
 UndirGraphReader& readAttribute(std::string name, Value& value,
 			       const Reader& reader) {
 attribute_reader.readAttribute<Reader>(name, value, reader);
 return *this;
 /// \e LemonReader::SectionReader.
 operator LemonReader&() {
 return *reader;
 }
-/// \brief Executes the reader commands.
+/// \brief Executes the reading commands.
 ///
-/// Executes the reader commands.
+/// Executes the reading commands.
 void run() {
 reader->run();
 }
 /// \brief Gives back the node by its id.

changeset 1679	e825655c24a4
parent 1534	b86aad11f842
child 1705	3f63d9db307b