COIN-OR::LEMON - Graph Library

Changeset 2102:eb73ab0e4c74 in lemon-0.x


Ignore:
Timestamp:
06/20/06 17:20:08 (13 years ago)
Author:
athos
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2793
Message:

Slight changes in doc.

Location:
lemon
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • lemon/bits/graph_extender.h

    r2098 r2102  
    190190    /// \brief Base node of the iterator
    191191    ///
    192     /// Returns the base node (ie. the source in this case) of the iterator
     192    /// Returns the base node (i.e. the source in this case) of the iterator
    193193    Node baseNode(const OutEdgeIt &e) const {
    194194      return Parent::source(e);
     
    196196    /// \brief Running node of the iterator
    197197    ///
    198     /// Returns the running node (ie. the target in this case) of the
     198    /// Returns the running node (i.e. the target in this case) of the
    199199    /// iterator
    200200    Node runningNode(const OutEdgeIt &e) const {
     
    204204    /// \brief Base node of the iterator
    205205    ///
    206     /// Returns the base node (ie. the target in this case) of the iterator
     206    /// Returns the base node (i.e. the target in this case) of the iterator
    207207    Node baseNode(const InEdgeIt &e) const {
    208208      return Parent::target(e);
     
    210210    /// \brief Running node of the iterator
    211211    ///
    212     /// Returns the running node (ie. the source in this case) of the
     212    /// Returns the running node (i.e. the source in this case) of the
    213213    /// iterator
    214214    Node runningNode(const InEdgeIt &e) const {
  • lemon/list_graph.h

    r2098 r2102  
    317317  ///This is a simple and fast erasable graph implementation.
    318318  ///
    319   ///It addition that it conforms to the
    320   ///\ref concept::ErasableGraph "ErasableGraph" concept,
     319  ///It conforms to the
     320  ///\ref concept::ErasableGraph "ErasableGraph" concept and
    321321  ///it also provides several additional useful extra functionalities.
    322322  ///\sa concept::ErasableGraph.
     
    331331    /// Changes the target of \c e to \c n
    332332    ///
    333     ///\note The <tt>Edge</tt>'s and <tt>OutEdge</tt>'s
     333    ///\note The <tt>Edge</tt>s and <tt>OutEdge</tt>s
    334334    ///referencing the changed edge remain
    335     ///valid. However <tt>InEdge</tt>'s are invalidated.
     335    ///valid. However <tt>InEdge</tt>s are invalidated.
    336336    void changeTarget(Edge e, Node n) {
    337337      _changeTarget(e,n);
     
    341341    /// Changes the source of \c e to \c n
    342342    ///
    343     ///\note The <tt>Edge</tt>'s and <tt>InEdge</tt>'s
     343    ///\note The <tt>Edge</tt>s and <tt>InEdge</tt>s
    344344    ///referencing the changed edge remain
    345     ///valid. However <tt>OutEdge</tt>'s are invalidated.
     345    ///valid. However <tt>OutEdge</tt>s are invalidated.
    346346    void changeSource(Edge e, Node n) {
    347347      _changeSource(e,n);
     
    350350    /// Invert the direction of an edge.
    351351
    352     ///\note The <tt>Edge</tt>'s
     352    ///\note The <tt>Edge</tt>s
    353353    ///referencing the changed edge remain
    354     ///valid. However <tt>OutEdge</tt>'s  and <tt>InEdge</tt>'s are invalidated.
     354    ///valid. However <tt>OutEdge</tt>s  and <tt>InEdge</tt>s are invalidated.
    355355    void reverseEdge(Edge e) {
    356356      Node t=target(e);
     
    359359    }
    360360
    361     ///Using this it possible to avoid the superfluous memory allocation.
    362 
    363     ///Using this it possible to avoid the superfluous memory allocation.
     361    ///Using this it is possible to avoid the superfluous memory allocation.
     362
     363    ///Using this it is possible to avoid the superfluous memory allocation.
    364364    ///\todo more docs...
    365365    void reserveEdge(int n) { edges.reserve(n); };
     
    370370    ///
    371371    ///Node \p b will be removed but instead of deleting
    372     ///its neighboring edges, they will be joined to \p a.
     372    ///incident edges, they will be joined to \p a.
    373373    ///The last parameter \p r controls whether to remove loops. \c true
    374374    ///means that loops will be removed.
     
    376376    ///\note The <tt>Edge</tt>s
    377377    ///referencing a moved edge remain
    378     ///valid. However <tt>InEdge</tt>'s and <tt>OutEdge</tt>'s
     378    ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
    379379    ///may be invalidated.
    380380    void contract(Node a, Node b, bool r = true)
     
    407407    ///\note The <tt>Edge</tt>s
    408408    ///referencing a moved edge remain
    409     ///valid. However <tt>InEdge</tt>'s and <tt>OutEdge</tt>'s
     409    ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
    410410    ///may be invalidated.
    411411    ///\warning This functionality cannot be used together with the Snapshot
     
    427427    ///Split an edge.
    428428
    429     ///This function splits an edge. First a new node \c b is added to the graph,
    430     ///then the original edge is re-targetes to \c b. Finally an edge
    431     ///from \c b to the original target is added.
    432     ///\return The newly created node.
    433     ///\warning This functionality cannot be used together with the Snapshot
    434     ///feature.
     429    ///This function splits an edge. First a new node \c b is added to
     430    ///the graph, then the original edge is re-targeted to \c
     431    ///b. Finally an edge from \c b to the original target is added.
     432    ///\return The newly created node. 
     433    ///\warning This functionality
     434    ///cannot be used together with the Snapshot feature.
    435435    Node split(Edge e)
    436436    {
     
    441441    }
    442442     
    443     ///Class to make a snapshot of the graph and to restrore to it later.
    444 
    445     ///Class to make a snapshot of the graph and to restrore to it later.
     443    ///Class to make a snapshot of the graph and to restore it later.
     444
     445    ///Class to make a snapshot of the graph and to restore it later.
    446446    ///
    447447    ///The newly added nodes and edges can be removed using the
Note: See TracChangeset for help on using the changeset viewer.