COIN-OR::LEMON - Graph Library

Changeset 1909:2d806130e700 in lemon-0.x for doc


Ignore:
Timestamp:
01/26/06 16:42:13 (14 years ago)
Author:
Mihaly Barasz
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2484
Message:

Undir -> U transition

Location:
doc
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • doc/Makefile.am

    r1671 r1909  
    2020        namespaces.dox \
    2121        quicktour.dox \
    22         undir_graphs.dox
     22        ugraphs.dox
    2323
    2424html/index.html:
  • doc/graph_io.dox

    r1901 r1909  
    318318The specialization of writing is very similar to that of reading.
    319319
    320 \section undir Undirected graphs
    321 
    322 In a file describing an undirected graph (undir graph, for short) you find an
    323 \c undiredgeset section instead of the \c edgeset section. The first line of
     320\section u Undirected graphs
     321
     322In a file describing an undirected graph (ugraph, for short) you find an
     323\c uedgeset section instead of the \c edgeset section. The first line of
    324324the section describes the names of the maps on the undirected egdes and all
    325325next lines describe one undirected edge with the the incident nodes and the
     
    331331
    332332\code
    333 @undiredgeset
     333@uedgeset
    334334             label      capacity        +flow   -flow
    33533532   2       1          4.3             2.0     0.0
     
    338338\endcode
    339339
    340 The \c edges section is changed to \c undiredges section. This section
     340The \c edges section is changed to \c uedges section. This section
    341341describes labeled edges and undirected edges. The directed edge label
    342342should start with a \c '+' or a \c '-' prefix to decide the direction
     
    344344
    345345\code
    346 @undiredges
    347 undiredge 1
     346@uedges
     347uedge 1
    348348+edge 5
    349349-back 5
     
    353353\ref lemon::GraphWriter "GraphWriter" which
    354354handle the undirected graphs. These classes are
    355 the \ref lemon::UndirGraphReader "UndirGraphReader"
    356 and \ref lemon::UndirGraphWriter "UndirGraphWriter".
    357 
    358 The \ref lemon::UndirGraphReader::readUndirEdgeMap() "readUndirEdgeMap()"
     355the \ref lemon::UGraphReader "UGraphReader"
     356and \ref lemon::UGraphWriter "UGraphWriter".
     357
     358The \ref lemon::UGraphReader::readUEdgeMap() "readUEdgeMap()"
    359359function reads an undirected map and the
    360 \ref lemon::UndirGraphReader::readUndirEdge() "readUndirEdge()"
     360\ref lemon::UGraphReader::readUEdge() "readUEdge()"
    361361reads an undirected edge from the file,
    362362
    363363\code
    364 reader.readUndirEdgeMap("capacity", capacityMap);
     364reader.readUEdgeMap("capacity", capacityMap);
    365365reader.readEdgeMap("flow", flowMap);
    366366...
    367 reader.readUndirEdge("undir_edge", undir_edge);
     367reader.readUEdge("u_edge", u_edge);
    368368reader.readEdge("edge", edge);
    369369\endcode
     
    440440
    441441\code
    442 UndirListGraph network;
    443 UndirListGraph::UndirEdgeMap<double> capacity;
    444 ListEdgeSet<UndirListGraph> traffic(network);
    445 ListEdgeSet<UndirListGraph>::EdgeMap<double> request(network);
     442ListUGraph network;
     443ListUGraph::UEdgeMap<double> capacity;
     444ListEdgeSet<ListUGraph> traffic(network);
     445ListEdgeSet<ListUGraph>::EdgeMap<double> request(network);
    446446
    447447LemonReader reader(std::cin);
    448 NodeSetReader<UndirListGraph> nodesetReader(reader, network);
    449 UndirEdgeSetReader<UndirListGraph>
    450   undirEdgesetReader(reader, network, nodesetReader);
    451 undirEdgesetReader.readEdgeMap("capacity", capacity);
    452 EdgeSetReader<ListEdgeSet<UndirListGraph> >
     448NodeSetReader<ListUGraph> nodesetReader(reader, network);
     449UEdgeSetReader<ListUGraph>
     450  uEdgesetReader(reader, network, nodesetReader);
     451uEdgesetReader.readEdgeMap("capacity", capacity);
     452EdgeSetReader<ListEdgeSet<ListUGraph> >
    453453  edgesetReader(reader, traffic, nodesetReader, "traffic");
    454454edgesetReader.readEdgeMap("request", request);
     
    458458
    459459Because both the \ref lemon::GraphReader "GraphReader"
    460 and the \ref lemon::UndirGraphReader "UndirGraphReader" can be converted
     460and the \ref lemon::UGraphReader "UGraphReader" can be converted
    461461to \ref lemon::LemonReader "LemonReader"
    462462and it can resolve the label's of the items, the previous
    463 result can be achived with the \ref lemon::UndirGraphReader "UndirGraphReader"
     463result can be achived with the \ref lemon::UGraphReader "UGraphReader"
    464464class, too.
    465465
    466466
    467467\code
    468 UndirListGraph network;
    469 UndirListGraph::UndirEdgeSet<double> capacity;
    470 ListEdgeSet<UndirListGraph> traffic(network);
    471 ListEdgeSet<UndirListGraph>::EdgeMap<double> request(network);
    472 
    473 UndirGraphReader<UndirListGraph> reader(std::cin, network);
     468ListUGraph network;
     469ListUGraph::UEdgeSet<double> capacity;
     470ListEdgeSet<ListUGraph> traffic(network);
     471ListEdgeSet<ListUGraph>::EdgeMap<double> request(network);
     472
     473UGraphReader<ListUGraph> reader(std::cin, network);
    474474reader.readEdgeMap("capacity", capacity);
    475 EdgeSetReader<ListEdgeSet<UndirListGraph> >
     475EdgeSetReader<ListEdgeSet<ListUGraph> >
    476476  edgesetReader(reader, traffic, reader, "traffic");
    477477edgesetReader.readEdgeMap("request", request);
  • doc/undir_graphs.dox

    r1030 r1909  
    11/*!
    22
    3 \page undir_graphs Undirected graph structures
     3\page ugraphs Undirected graph structures
    44
    55The primary data structures of LEMON are the graph classes.
Note: See TracChangeset for help on using the changeset viewer.