Changeset 2502:9c23c3762bc5 in lemon-0.x for doc/graph_io.dox

Timestamp:

10/24/07 18:31:49 (17 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3342

Message:

BpUGraphReader and Writer

File:

• doc/graph_io.dox (modified) (3 diffs)

doc/graph_io.dox

@@ -336 +336 @@
 The specialization of writing is very similar to that of reading.
 
-\section u Undirected graphs
+\section undir Undirected and Bipartite graphs
 
 In a file describing an undirected graph (ugraph, for short) you find an
@@ -344 +344 @@
 values of the map.
 
-The format handles directed edge maps as a syntactical sugar???, if there
-are two maps with names being the same with a \c '+' and a \c '-' prefix
-then this will be read as a directed map.
+The format could store directed edge maps, if there are two maps with 
+names being the same with a \c '+' and a \c '-' prefix then this could 
+be read as such a map.
 
 \code
@@ -385 +385 @@
 reader.readUEdge("u_edge", u_edge);
 reader.readEdge("edge", edge);
+\endcode
+
+The undirected bipartite graphs could be read with the \c BpUGraph
+class and it has specialized nodeset section, which should be start
+with \c "@bpnodeset". This section is separated to two
+subsections. The header line of these sections start with "&anodeset"
+or "&bnodeset" and after that the line contains the names of the
+regular and A-node or B-node maps accordingly. The lines of each
+section contains the mapped values. The labels of the graph should be
+unique overall both subsections.
+
+\code
+@bpnodeset
+&anodeset label   coords        radius
+          0       (0, 0)        14.0
+          1       (0, 1)        12.0
+&bnodeset label   coords
+          2       (1, 0)
+          3       (1, 1)
+\endcode
+
+The reading can be done with \ref lemon::BpUGraphReader::readANodeMap() 
+"readANodeMap()", \ref lemon::BpUGraphReader::readBNodeMap() 
+"readBNodeMap()" or \ref lemon::BpUGraphReader::readNodeMap() 
+"readNodeMap()" members.
+
+\code
+reader.readNodeMap("coords", coords);
+reader.readAnodeMap("radius", radius);
 \endcode