doc/graph_io.dox
changeset 1333 2640cf6547ff
parent 1118 62296604afb4
child 1394 f0c48d7fa73d
     1.1 --- a/doc/graph_io.dox	Sat Apr 09 19:32:06 2005 +0000
     1.2 +++ b/doc/graph_io.dox	Sat Apr 09 19:35:33 2005 +0000
     1.3 @@ -2,7 +2,6 @@
     1.4  /*!
     1.5  
     1.6  
     1.7 -
     1.8  \page graph-io-page Graph Input-Output
     1.9  
    1.10  The standard graph IO makes possible to store graphs and additional maps
    1.11 @@ -20,8 +19,8 @@
    1.12  The nodeset section starts with the \c \@nodeset line.
    1.13  The next line contains the names of the maps separated by whitespaces.
    1.14  Each following line describes a node in the graph, it contains
    1.15 -in the right order the values of the maps. The first map should contain
    1.16 -unique values because it regarded as Id-map. 
    1.17 +in the right order the values of the maps. The map named "id" should contain
    1.18 +unique values because it regarded as ID-map. 
    1.19  
    1.20  \code
    1.21  @nodeset
    1.22 @@ -35,7 +34,7 @@
    1.23  same coloumn oriented structure. It starts with the line \c \@edgeset
    1.24  The next line contains the whitespace separated list of names of the map.
    1.25  Each of the next lines describes one edge. The first two elements in the line
    1.26 -are the ID of the source and target node as they occur in the first node map. 
    1.27 +are the ID of the source and target node as they occur in the ID node map. 
    1.28  
    1.29  \code
    1.30  @edgeset
    1.31 @@ -45,10 +44,10 @@
    1.32  3   12       g     3.4      g-edge
    1.33  \endcode
    1.34  
    1.35 -The next section contains <em>labeles nodes</em> (i.e. nodes having a special
    1.36 +The next section contains <em>labeled nodes</em> (i.e. nodes having a special
    1.37  label on them). The section starts with
    1.38  \c \@nodes. Each of the next lines contains a label for a node in the graph 
    1.39 -and then the ID described in the first column in the nodeset.
    1.40 +and then the ID described in the nodeset.
    1.41  
    1.42  \code
    1.43  @nodes 
    1.44 @@ -56,9 +55,8 @@
    1.45  target 12
    1.46  \endcode
    1.47  
    1.48 -The last section describes the <em>labeles edges</em>
    1.49 -(i.e. edges having a special
    1.50 -label on them). It starts with \c \@edges
    1.51 +The last section describes the <em>labeled edges</em>
    1.52 +(i.e. edges having a special label on them). It starts with \c \@edges
    1.53  and then each line contains the name of the edge and the ID.
    1.54  
    1.55  \code
    1.56 @@ -88,13 +86,13 @@
    1.57  Edge writing.
    1.58  
    1.59  \code
    1.60 -GraphWriter<ListGraph> writer(graph);
    1.61 +GraphWriter<ListGraph> writer(std::cout, graph);
    1.62  \endcode
    1.63  
    1.64  The \c addNodeMap() function declares a \c NodeMap writing command in the
    1.65  \c GraphWriter. You should give as parameter the name of the map and the map
    1.66 -object. The first NodeMap writing command should write a unique map because
    1.67 -it is regarded as ID map.
    1.68 +object. The NodeMap writing command with name "id" should write a 
    1.69 +unique map because it is regarded as ID map.
    1.70  
    1.71  \see IdMap, DescriptorMap  
    1.72  
    1.73 @@ -108,8 +106,7 @@
    1.74  \endcode
    1.75  
    1.76  With the \c addEdgeMap() member function you can give an edge map
    1.77 -writing command similar to the NodeMaps. The first map writing command should
    1.78 -write unique map.
    1.79 +writing command similar to the NodeMaps.
    1.80  
    1.81  \see IdMap, DescriptorMap  
    1.82  \code
    1.83 @@ -132,7 +129,7 @@
    1.84  \endcode
    1.85  
    1.86  After you give all write commands you must call the \c run() member
    1.87 -function, which execute all the write commands.
    1.88 +function, which execute all the writer commands.
    1.89  
    1.90  \code
    1.91  writer.run();
    1.92 @@ -151,7 +148,7 @@
    1.93  it should skip the values when the string representation contains spaces.
    1.94  
    1.95  \code
    1.96 -GraphReader<ListGraph> reader(graph);
    1.97 +GraphReader<ListGraph> reader(std::cin, graph);
    1.98  \endcode
    1.99  
   1.100  The \c addNodeMap() function reads a map from the \c \@nodeset section.
   1.101 @@ -206,7 +203,7 @@
   1.102  If you want to change the functionality of the reader, you can use
   1.103  template parameters to specialize it. When you give a reading
   1.104  command for a map you can give a Reader type as template parameter.
   1.105 -With this template parameter you can control how does read the Reader
   1.106 +With this template parameter you can control how the Reader reads
   1.107  a value from the stream.
   1.108  
   1.109  The reader has the next structure: 
   1.110 @@ -244,6 +241,6 @@
   1.111  
   1.112  The specialization of the writing should be very similar to the reading.
   1.113  
   1.114 -
   1.115 +\author Balazs Dezso
   1.116  */
   1.117 -}
   1.118 \ No newline at end of file
   1.119 +}