lemon-0.x: comparison doc/graph

equal deleted inserted replaced

-:71a95f67888e
+:ed204329ab82
 <tt>\@nodeset</tt>
 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
+maps in the right order. The map named "label" should contain unique values
-because it is regarded as an ID-map. These ids need not be numbers but they
+because it is regarded as a label map. These labels need not be numbers but they
 must identify the nodes uniquely for later reference. For example:
 \code
 @nodeset
-id  x-coord  y-coord  color
+label  x-coord  y-coord  color
 3   1.0      4.0      blue
 5   2.3      5.7      red
 12  7.8      2.3      green
 \endcode
 <tt>\@edgeset</tt>
 The next line contains the whitespace separated list of names of the edge
 maps.  Each of the next lines describes one edge. The first two elements in
-the line are the IDs of the source and target (or tail and head) nodes of the
+the line are the labels of the source and target (or tail and head) nodes of the
-edge as they occur in the ID node map of the nodeset section. You can also
+edge as they occur in the label node map of the nodeset section. You can also
-have an optional ID map on the edges for later reference (which has to be
+have an optional label map on the edges for later reference (which has to be
 unique in this case).
 \code
 @edgeset
-id    weight   label
+label      weight   note
-3   5        a     4.3      a-edge
+3   5        a          4.3      a-edge
-5   12       c     2.6      c-edge
+5   12       c          2.6      c-edge
-3   12       g     3.4      g-edge
+3   12       g          3.4      g-edge
 \endcode
 The \e nodes section contains <em>labeled (distinguished) nodes</em>
 (i.e. nodes having a special
 label on them). The section starts with
 <tt> \@nodes </tt>
 Each of the next lines contains a label for a node in the graph
-and then the ID as described in the \e nodeset section.
+and then the label as described in the \e nodeset section.
 \code
 @nodes
 source 3
 target 12
 \endcode
 The last section describes the <em>labeled (distinguished) edges</em>
 (i.e. edges having a special label on them). It starts with \c \@edges
-and then each line contains the name of the edge and the ID.
+and then each line contains the name of the edge and the label.
 \code
 @edges
 observed c
 \endcode
 author "Balazs DEZSO"
 copyright "Lemon Library"
 version 12
 \endcode
-<tt> \@end </tt>
+Finally, the file should be closed with \c \@end line.
-line.
 \section use Using graph input-output
 The \ref lemon::GraphWriter::writeNodeMap() "writeNodeMap()"
 function declares a \c NodeMap writing command in the
 \ref lemon::GraphWriter "GraphWriter".
 You should give a name to the map and the map
-object as parameters. The NodeMap writing command with name "id" should write a
+object as parameters. The NodeMap writing command with name "label" should write a
-unique map because it will be regarded as an ID map.
+unique map because it will be regarded as a label map.
 \see IdMap, DescriptorMap
 \code
-IdMap<ListGraph, Node> nodeIdMap;
+IdMap<ListGraph, Node> nodeLabelMap;
-writer.writeNodeMap("id", nodeIdMap);
+writer.writeNodeMap("label", nodeLabelMap);
 writer.writeNodeMap("x-coord", xCoordMap);
 writer.writeNodeMap("y-coord", yCoordMap);
 writer.writeNodeMap("color", colorMap);
 \endcode
 \code
 DescriptorMap<ListGraph, Edge, ListGraph::EdgeMap<int> > edgeDescMap(graph);
 writer.writeEdgeMap("descriptor", edgeDescMap);
 writer.writeEdgeMap("weight", weightMap);
-writer.writeEdgeMap("label", labelMap);
+writer.writeEdgeMap("note", noteMap);
 \endcode
 With \ref lemon::GraphWriter::writeNode() "writeNode()"
 and \ref lemon::GraphWriter::writeEdge() "writeEdge()"
 functions you can designate Nodes and
 \endcode
 The global functionality of the reader class can be changed by giving a
 special template parameter to the GraphReader class. By default, the
 template parameter is \c DefaultReaderTraits. A reader traits class
-should provide an inner template class Reader for each type, and a
+should provide a nested template class Reader for each type, and a
 DefaultReader for skipping a value.
-The specialization of  writing is very similar to that of reading.
+The specialization of writing is very similar to that of reading.
 \section undir Undirected graphs
 In a file describing an undirected graph (undir graph, for short) you find an
 \c undiredgeset section instead of the \c edgeset section. The first line of
 are two maps with names being the same with a \c '+' and a \c '-' prefix
 then this will be read as a directed map.
 \code
 @undiredgeset
-id    capacity +flow -flow
+label      capacity        +flow   -flow
-32   2       1     4.3      2.0	  0.0
+32   2       1          4.3             2.0     0.0
-21   21      5     2.6      0.0   2.6
+21   21      5          2.6             0.0     2.6
-21   12      8     3.4      0.0   0.0
+21   12      8          3.4             0.0     0.0
 \endcode
 The \c edges section is changed to \c undiredges section. This section
 describes labeled edges and undirected edges. The directed edge label
 should start with a \c '+' or a \c '-' prefix to decide the direction
 \endcode
 Because both the \ref lemon::GraphReader "GraphReader"
 and the \ref lemon::UndirGraphReader "UndirGraphReader" can be converted
 to \ref lemon::LemonReader "LemonReader"
-and it can resolve the ID's of the items, the previous
+and it can resolve the label's of the items, the previous
 result can be achived with the \ref lemon::UndirGraphReader "UndirGraphReader"
 class, too.
 \code

changeset 1901	723b2b81d900
parent 1848	291764ce6d91
child 1909	2d806130e700