1.1 --- a/doc/graph_io.dox Wed Feb 02 13:11:54 2005 +0000
1.2 +++ b/doc/graph_io.dox Wed Feb 02 16:23:41 2005 +0000
1.3 @@ -1,3 +1,4 @@
1.4 +namespace lemon {
1.5 /*!
1.6
1.7
1.8 @@ -5,7 +6,7 @@
1.9 \page graph-io-page Graph Input-Output
1.10
1.11 The standard graph IO makes possible to store graphs and additional maps
1.12 -in flexible and efficient way.
1.13 +in a flexible and efficient way.
1.14
1.15 \section format The general file format
1.16
1.17 @@ -33,8 +34,8 @@
1.18 The edgeset section is very similar to the nodeset section, it has
1.19 same coloumn oriented structure. It starts with the line \c \@edgeset
1.20 The next line contains the whitespace separated list of names of the map.
1.21 -Each of the next lines describes one edge. The first two element in the line
1.22 -is the ID of the source and target node as occurs in the first node map.
1.23 +Each of the next lines describes one edge. The first two elements in the line
1.24 +are the ID of the source and target node as they occur in the first node map.
1.25
1.26 \code
1.27 @edgeset
1.28 @@ -44,7 +45,8 @@
1.29 3 12 g 3.4 g-edge
1.30 \endcode
1.31
1.32 -The next section contains outpointed nodes. The section starts with
1.33 +The next section contains <em>labeles nodes</em> (i.e. nodes having a special
1.34 +label on them). The section starts with
1.35 \c \@nodes. Each of the next lines contains a label for a node in the graph
1.36 and then the ID described in the first column in the nodeset.
1.37
1.38 @@ -54,7 +56,9 @@
1.39 target 12
1.40 \endcode
1.41
1.42 -The last section describes the outpointed edges. It starts with \c \@edges
1.43 +The last section describes the <em>labeles edges</em>
1.44 +(i.e. edges having a special
1.45 +label on them). It starts with \c \@edges
1.46 and then each line contains the name of the edge and the ID.
1.47
1.48 \code
1.49 @@ -73,14 +77,14 @@
1.50
1.51 \section use Using graph input-output
1.52 The graph input and output based on writing and reading commands. The user
1.53 -adds writing and reading commands for the reader or writer class, after
1.54 -calls the \c run() method what executes all the given commands.
1.55 +adds writing and reading commands for the reader or writer class, then
1.56 +calls the \c run() method that executes all the given commands.
1.57
1.58 \subsection write Writing a graph
1.59
1.60 The \c GraphWriter class provides the graph output. To write a graph
1.61 you should first give writing commands for the writer. You can declare
1.62 -write command as \c NodeMap or \c EdgeMap writing and outpointed Node and
1.63 +write command as \c NodeMap or \c EdgeMap writing and labeled Node and
1.64 Edge writing.
1.65
1.66 \code
1.67 @@ -89,7 +93,7 @@
1.68
1.69 The \c addNodeMap() function declares a \c NodeMap writing command in the
1.70 \c GraphWriter. You should give as parameter the name of the map and the map
1.71 -object. The first NodeMap writing command should write an unique map because
1.72 +object. The first NodeMap writing command should write a unique map because
1.73 it is regarded as ID map.
1.74
1.75 \see IdMap, DescriptorMap
1.76 @@ -128,7 +132,7 @@
1.77 \endcode
1.78
1.79 After you give all write commands you must call the \c run() member
1.80 -function, what execute all the write commands.
1.81 +function, which execute all the write commands.
1.82
1.83 \code
1.84 writer.run();
1.85 @@ -136,22 +140,22 @@
1.86
1.87 \subsection reading Reading a graph
1.88
1.89 -The given file format may contain many maps and outpointed nodes or edges.
1.90 +The given file format may contain several maps and labeled nodes or edges.
1.91 If you read a graph you need not read all the maps and items just those
1.92 that you need. The interface of the \c GraphReader is very similar to
1.93 the GraphWriter but the reading method does not depend on the order the
1.94 given commands.
1.95
1.96 -The reader object suppose that each not readed value does not contains
1.97 -whitespaces therefore it has some extra possibilities to control how could
1.98 -it skip the values when the string representation contains spaces.
1.99 +The reader object suppose that each not readed value does not contain
1.100 +whitespaces, therefore it has some extra possibilities to control how
1.101 +it should skip the values when the string representation contains spaces.
1.102
1.103 \code
1.104 GraphReader<ListGraph> reader(graph);
1.105 \endcode
1.106
1.107 The \c addNodeMap() function reads a map from the \c \@nodeset section.
1.108 -If there is a map what you do not want to read from the file and there is
1.109 +If there is a map that you do not want to read from the file and there is
1.110 whitespace in the string represenation of the values then you should
1.111 call the \c skipNodeMap() template member function with proper parameters.
1.112
1.113 @@ -174,7 +178,7 @@
1.114 reader.addEdgeMap("label", labelMap);
1.115 \endcode
1.116
1.117 -With \c addNode() and \c addEdge() functions you can read outpointed Nodes and
1.118 +With \c addNode() and \c addEdge() functions you can read labeled Nodes and
1.119 Edges.
1.120
1.121 \code
1.122 @@ -185,7 +189,7 @@
1.123 \endcode
1.124
1.125 After you give all read commands you must call the \c run() member
1.126 -function, what execute all the commands.
1.127 +function, which execute all the commands.
1.128
1.129 \code
1.130 reader.run();
1.131 @@ -233,8 +237,8 @@
1.132 \endcode
1.133
1.134 The global functionality of the reader class can be changed by giving a
1.135 -special template parameter for the GraphReader class. In default way the
1.136 -template parameter the \c DefaultReaderTraits. A reader traits class
1.137 +special template parameter for the GraphReader class. By default, the
1.138 +template parameter is \c DefaultReaderTraits. A reader traits class
1.139 should provide an inner template class Reader for each type, and an
1.140 DefaultReader for skipping a value.
1.141
1.142 @@ -242,3 +246,4 @@
1.143
1.144
1.145 */
1.146 +}
1.147 \ No newline at end of file