COIN-OR::LEMON - Graph Library

Changeset 1118:62296604afb4 in lemon-0.x for doc


Ignore:
Timestamp:
02/02/05 17:23:41 (15 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1517
Message:

Minor changes.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/graph_io.dox

    r1114 r1118  
     1namespace lemon {
    12/*!
    23
     
    67
    78The standard graph IO makes possible to store graphs and additional maps
    8 in flexible and efficient way.
     9in a flexible and efficient way.
    910
    1011\section format The general file format
     
    3435same coloumn oriented structure. It starts with the line \c \@edgeset
    3536The next line contains the whitespace separated list of names of the map.
    36 Each of the next lines describes one edge. The first two element in the line
    37 is the ID of the source and target node as occurs in the first node map.
     37Each of the next lines describes one edge. The first two elements in the line
     38are the ID of the source and target node as they occur in the first node map.
    3839
    3940\code
     
    4546\endcode
    4647
    47 The next section contains outpointed nodes. The section starts with
     48The next section contains <em>labeles nodes</em> (i.e. nodes having a special
     49label on them). The section starts with
    4850\c \@nodes. Each of the next lines contains a label for a node in the graph
    4951and then the ID described in the first column in the nodeset.
     
    5557\endcode
    5658
    57 The last section describes the outpointed edges. It starts with \c \@edges
     59The last section describes the <em>labeles edges</em>
     60(i.e. edges having a special
     61label on them). It starts with \c \@edges
    5862and then each line contains the name of the edge and the ID.
    5963
     
    7478\section use Using graph input-output
    7579The graph input and output based on writing and reading commands. The user
    76 adds writing and reading commands for the reader or writer class, after
    77 calls the \c run() method what executes all the given commands.
     80adds writing and reading commands for the reader or writer class, then
     81calls the \c run() method that executes all the given commands.
    7882
    7983\subsection write Writing a graph
     
    8185The \c GraphWriter class provides the graph output. To write a graph
    8286you should first give writing commands for the writer. You can declare
    83 write command as \c NodeMap or \c EdgeMap writing and outpointed Node and
     87write command as \c NodeMap or \c EdgeMap writing and labeled Node and
    8488Edge writing.
    8589
     
    9094The \c addNodeMap() function declares a \c NodeMap writing command in the
    9195\c GraphWriter. You should give as parameter the name of the map and the map
    92 object. The first NodeMap writing command should write an unique map because
     96object. The first NodeMap writing command should write a unique map because
    9397it is regarded as ID map.
    9498
     
    129133
    130134After you give all write commands you must call the \c run() member
    131 function, what execute all the write commands.
     135function, which execute all the write commands.
    132136
    133137\code
     
    137141\subsection reading Reading a graph
    138142
    139 The given file format may contain many maps and outpointed nodes or edges.
     143The given file format may contain several maps and labeled nodes or edges.
    140144If you read a graph you need not read all the maps and items just those
    141145that you need. The interface of the \c GraphReader is very similar to
     
    143147given commands.
    144148
    145 The reader object suppose that each not readed value does not contains
    146 whitespaces therefore it has some extra possibilities to control how could
    147 it skip the values when the string representation contains spaces.
     149The reader object suppose that each not readed value does not contain
     150whitespaces, therefore it has some extra possibilities to control how
     151it should skip the values when the string representation contains spaces.
    148152
    149153\code
     
    152156
    153157The \c addNodeMap() function reads a map from the \c \@nodeset section.
    154 If there is a map what you do not want to read from the file and there is
     158If there is a map that you do not want to read from the file and there is
    155159whitespace in the string represenation of the values then you should
    156160call the \c skipNodeMap() template member function with proper parameters.
     
    175179\endcode
    176180
    177 With \c addNode() and \c addEdge() functions you can read outpointed Nodes and
     181With \c addNode() and \c addEdge() functions you can read labeled Nodes and
    178182Edges.
    179183
     
    186190
    187191After you give all read commands you must call the \c run() member
    188 function, what execute all the commands.
     192function, which execute all the commands.
    189193
    190194\code
     
    234238
    235239The global functionality of the reader class can be changed by giving a
    236 special template parameter for the GraphReader class. In default way the
    237 template parameter the \c DefaultReaderTraits. A reader traits class
     240special template parameter for the GraphReader class. By default, the
     241template parameter is \c DefaultReaderTraits. A reader traits class
    238242should provide an inner template class Reader for each type, and an
    239243DefaultReader for skipping a value.
     
    243247
    244248*/
     249}
Note: See TracChangeset for help on using the changeset viewer.