COIN-OR::LEMON - Graph Library

Changeset 1333:2640cf6547ff in lemon-0.x for doc


Ignore:
Timestamp:
04/09/05 21:35:33 (14 years ago)
Author:
Balazs Dezso
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1772
Message:

Functionality changed:
The first map is the id map => The map named "id" is the id map

Documentation improvments

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/graph_io.dox

    r1118 r1333  
    11namespace lemon {
    22/*!
    3 
    43
    54
     
    2120The next line contains the names of the maps separated by whitespaces.
    2221Each following line describes a node in the graph, it contains
    23 in the right order the values of the maps. The first map should contain
    24 unique values because it regarded as Id-map.
     22in the right order the values of the maps. The map named "id" should contain
     23unique values because it regarded as ID-map.
    2524
    2625\code
     
    3635The next line contains the whitespace separated list of names of the map.
    3736Each of the next lines describes one edge. The first two elements in the line
    38 are the ID of the source and target node as they occur in the first node map.
     37are the ID of the source and target node as they occur in the ID node map.
    3938
    4039\code
     
    4645\endcode
    4746
    48 The next section contains <em>labeles nodes</em> (i.e. nodes having a special
     47The next section contains <em>labeled nodes</em> (i.e. nodes having a special
    4948label on them). The section starts with
    5049\c \@nodes. Each of the next lines contains a label for a node in the graph
    51 and then the ID described in the first column in the nodeset.
     50and then the ID described in the nodeset.
    5251
    5352\code
     
    5756\endcode
    5857
    59 The last section describes the <em>labeles edges</em>
    60 (i.e. edges having a special
    61 label on them). It starts with \c \@edges
     58The last section describes the <em>labeled edges</em>
     59(i.e. edges having a special label on them). It starts with \c \@edges
    6260and then each line contains the name of the edge and the ID.
    6361
     
    8987
    9088\code
    91 GraphWriter<ListGraph> writer(graph);
     89GraphWriter<ListGraph> writer(std::cout, graph);
    9290\endcode
    9391
    9492The \c addNodeMap() function declares a \c NodeMap writing command in the
    9593\c GraphWriter. You should give as parameter the name of the map and the map
    96 object. The first NodeMap writing command should write a unique map because
    97 it is regarded as ID map.
     94object. The NodeMap writing command with name "id" should write a
     95unique map because it is regarded as ID map.
    9896
    9997\see IdMap, DescriptorMap 
     
    109107
    110108With the \c addEdgeMap() member function you can give an edge map
    111 writing command similar to the NodeMaps. The first map writing command should
    112 write unique map.
     109writing command similar to the NodeMaps.
    113110
    114111\see IdMap, DescriptorMap 
     
    133130
    134131After you give all write commands you must call the \c run() member
    135 function, which execute all the write commands.
     132function, which execute all the writer commands.
    136133
    137134\code
     
    152149
    153150\code
    154 GraphReader<ListGraph> reader(graph);
     151GraphReader<ListGraph> reader(std::cin, graph);
    155152\endcode
    156153
     
    207204template parameters to specialize it. When you give a reading
    208205command for a map you can give a Reader type as template parameter.
    209 With this template parameter you can control how does read the Reader
     206With this template parameter you can control how the Reader reads
    210207a value from the stream.
    211208
     
    245242The specialization of the writing should be very similar to the reading.
    246243
    247 
     244\author Balazs Dezso
    248245*/
    249246}
Note: See TracChangeset for help on using the changeset viewer.