COIN-OR::LEMON - Graph Library

Changeset 2408:467ca6d16556 in lemon-0.x for doc


Ignore:
Timestamp:
03/13/07 16:42:06 (13 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3239
Message:

Doc improvements contributed by Peter Kovacs.

Location:
doc
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • doc/algorithms.dox

    r2391 r2408  
    2929\subsection Bfs
    3030The algorithm is implemented in the \ref lemon::Bfs "Bfs" template class - rather than as function.
    31 The class has two template parameters: \b GR and \TR.<br>
     31The class has two template parameters: \b GR and \b TR.<br>
    3232GR is the graph the algorithm runs on. It has \ref lemon::ListGraph "ListGraph" as default type.
    3333TR is a Traits class commonly used to easy the parametrization of templates. In most cases you
     
    5252Now the distances and path information are stored in maps which you can access with
    5353member functions like \ref lemon::Bfs::distMap "distMap()" or \ref lemon::Bfs::predMap "predMap()".<br>
    54 Or more directly whit other member functions like \c predNode(). Once the algorithm
     54Or more directly with other member functions like \ref lemon::Bfs::predNode "predNode()". Once the algorithm
    5555is finished (or to be precise reached that node) \ref lemon::Bfs::dist "dist()" or \ref lemon::Bfs::predNode
    5656"predNode()" can be called.
     
    116116\until };
    117117The class meets the \ref lemon::WriteMap "WriteMap" concept. In it's \c set() method the only thing
    118 we need to do is insert the key - that is the node who's processing just finished - into the beginning
     118we need to do is insert the key - that is the node whose processing just finished - into the beginning
    119119of the list.<br>
    120120Although we implemented this needed helper class ourselves it was not necessary.
  • doc/getting_started.dox

    r2391 r2408  
    7777In the next few lines we add some more nodes and edges and to the graph we need.
    7878Those lines are not very interesting so we skip them, but you find the whole
    79 working program in file hello_lemon.cc in the demo section.
     79working program in file hello_world.cc in the demo section.
    8080
    8181The next statement must be familiar. But what is that INVALID in the \c while
  • doc/maps1.dox

    r2391 r2408  
    3535To make easy to use them - especially as template parameters - there are <i>map concepts</i> like by graph classes.
    3636<ul>
    37 <li>\ref ReadMap - values can be red out with the \c operator[].
     37<li>\ref ReadMap - values can be read out with the \c operator[].
    3838\code value_typed_variable = map_instance[key_value]; \endcode
    3939</li>
     
    6060type. As an example, think of a edge-weighted directed graph.
    6161\code ListGraph::EdgeMap<int>  weight(graph); \endcode
    62 You can see that the map needs the graph hows edges will mapped, but nothing more.
     62You can see that the map needs the graph whose edges will mapped, but nothing more.
    6363
    6464If the graph class is extendable or erasable the map will automatically follow
  • doc/maps2.dox

    r2391 r2408  
    4343  typedef double Value;
    4444  typedef Graph::Edge Key;
    45   double operator[](Key e) const { return M_PI;}
     45  double operator[](const Key &e) const { return M_PI;}
    4646};
    4747\endcode
     
    5252struct MyMap : public MapBase<Graph::Edge,double>
    5353{
    54   Value operator[](Key e) const { return M_PI;}
     54  Value operator[](const Key& e) const { return M_PI;}
    5555};
    5656\endcode
Note: See TracChangeset for help on using the changeset viewer.