lemon-0.x: comparison doc/graph

equal deleted inserted replaced

-:1ab0553929ac
+:e5009c503812
 /*!
 \page graph-io-page Graph Input-Output
-The standard graph IO makes possible to store graphs and additional maps
+The standard graph IO enables to store graphs and additional maps
 in a flexible and efficient way.
 \section format The general file format
-The graph file contains at most four section in the next order:
+The file contains at most four sections in the following order:
 \li nodeset
 \li edgeset
 \li nodes
 \li edges
-The nodeset section starts with the \c \@nodeset line.
+The nodeset section starts with the following line:
-The next line contains the names of the maps separated by whitespaces.
-Each following line describes a node in the graph, it contains
+<tt>\@nodeset</tt>
-in the right order the values of the maps. The map named "id" should contain
-unique values because it regarded as ID-map.
+The next line contains the names of the nodemaps, separated by whitespaces.  Each
+following line describes a node in the graph: it contains the values of the
+maps in the right order. The map named "id" should contain unique values
+because it is regarded as an ID-map. For example:
 \code
 @nodeset
 id  x-coord  y-coord  color
 3   1.0      4.0      blue
 5   2.3      5.7      red
 12  7.8      2.3      green
 \endcode
 The edgeset section is very similar to the nodeset section, it has
-same coloumn oriented structure. It starts with the line \c \@edgeset
+the same coloumn oriented structure. It starts with the line
-The next line contains the whitespace separated list of names of the map.
+<tt>\@edgeset</tt>
+The next line contains the whitespace separated list of names of the maps.
 Each of the next lines describes one edge. The first two elements in the line
-are the ID of the source and target node as they occur in the ID node map.
+are the IDs of the source and target (or tail and head) node of the edge as they occur in the ID node
+map. You can also have an optional ID map on the edges for later reference.
 \code
 @edgeset
 id    weight   label
 3   5        a     4.3      a-edge
 3   12       g     3.4      g-edge
 \endcode
 The next section contains <em>labeled nodes</em> (i.e. nodes having a special
 label on them). The section starts with
-\c \@nodes. Each of the next lines contains a label for a node in the graph
-and then the ID described in the nodeset.
+<tt> \@nodes </tt>
+Each of the next lines contains a label for a node in the graph
+and then the ID described in the nodeset section.
 \code
 @nodes
 source 3
 target 12
 \code
 @nodes
 observed c
 \endcode
-The file ends with the \c \@end line.
 The file may contain empty lines and comment lines. The comment lines
 start with an \c # character.
-\code
+The file ends with the
-@end
-\endcode
+<tt> \@end </tt>
+line.
 \section use Using graph input-output
-The graph input and output based on writing and reading commands. The user
+The graph input and output is based on reading and writing  commands. The user
-adds writing and reading commands for the reader or writer class, then
+adds reading and writing commands to the reader or writer class, then he
 calls the \c run() method that executes all the given commands.
 \subsection write Writing a graph
 The \c GraphWriter class provides the graph output. To write a graph
 \code
 GraphWriter<ListGraph> writer(std::cout, graph);
 \endcode
 The \c writeNodeMap() function declares a \c NodeMap writing command in the
-\c GraphWriter. You should give as parameter the name of the map and the map
+\c GraphWriter. You should give a name of the map and the map
-object. The NodeMap writing command with name "id" should write a
+object as parameters. The NodeMap writing command with name "id" should write a
 unique map because it is regarded as ID map.
 \see IdMap, DescriptorMap
 \code
 With the \c writeEdgeMap() member function you can give an edge map
 writing command similar to the NodeMaps.
 \see IdMap, DescriptorMap
 \code
 DescriptorMap<ListGraph, Edge, ListGraph::EdgeMap<int> > edgeDescMap(graph);
 writer.writeEdgeMap("descriptor", edgeDescMap);
 writer.writeEdgeMap("weight", weightMap);
 writer.writeEdgeMap("label", labelMap);
 \endcode
-With \c writeNode() and \c writeEdge() functions you can point out Nodes and
+With \c writeNode() and \c writeEdge() functions you can designate Nodes and
-Edges in the graph. By example, you can write out the source and target
+Edges in the graph. For example, you can write out the source and target node
-of the graph.
+of a maximum flow instance.
 \code
 writer.writeNode("source", sourceNode);
 writer.writeNode("target", targetNode);
 writer.writeEdge("observed", edge);
 \endcode
 After you give all write commands you must call the \c run() member
-function, which execute all the writer commands.
+function, which executes all the writing commands.
 \code
 writer.run();
 \endcode
 \subsection reading Reading a graph
 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
-the GraphWriter but the reading method does not depend on the order the
+the GraphWriter but the reading method does not depend on the order of the
 given commands.
-The reader object suppose that each not readed value does not contain
+The reader object assumes 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.
 \code
 GraphReader<ListGraph> reader(std::cin, graph);
 \endcode
 The \c readNodeMap() function reads a map from the \c \@nodeset section.
-If there is a map that you do not want to read from the file and there is
+If there is a map that you do not want to read from the file and there are
-whitespace in the string represenation of the values then you should
+whitespaces in the string represenation of the values then you should
 call the \c skipNodeMap() template member function with proper parameters.
 \see QuotedStringReader
 \code
 reader.readNodeMap("x-coord", xCoordMap);
 reader.readNodeMap("y-coord", yCoordMap);
 reader.readNodeMap<QuotedStringReader>("label", labelMap);
 reader.readEdge("observed", edge);
 \endcode
 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
-\section types The background of the Reading and Writing
+\section types The background of Reading and Writing
-The \c GraphReader should know how can read a Value from the given map.
+The \c GraphReader should know how to read a Value from the given map.
 By the default implementation the input operator reads a value from
 the stream and the type of the readed value is the value type of the given map.
 When the reader should skip a value in the stream, because you do not
 want to store it in map, the reader skips a character sequence without
 whitespace.

changeset 1522	321661278137
parent 1394	f0c48d7fa73d
child 1526	8c14aa8f27a2