COIN-OR::LEMON - Graph Library

Changeset 2123:85c6f5e82108 in lemon-0.x


Ignore:
Timestamp:
07/11/06 15:51:52 (13 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2836
Message:

Minor doc improvements

Location:
lemon
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • lemon/list_graph.h

    r2117 r2123  
    167167    /// Adds a new node to the graph.
    168168
     169    /// Adds a new node to the graph.
     170    ///
    169171    /// \warning It adds the new node to the front of the list.
    170172    /// (i.e. the lastly added node becomes the first.)
     
    350352    ///the changed edge remain valid. However <tt>InEdgeIt</tt>s are
    351353    ///invalidated.
     354    ///\warning This functionality cannot be used together with the Snapshot
     355    ///feature.
    352356    void changeTarget(Edge e, Node n) {
    353357      Parent::changeTarget(e,n);
     
    360364    ///the changed edge remain valid. However <tt>OutEdgeIt</tt>s are
    361365    ///invalidated.
     366    ///\warning This functionality cannot be used together with the Snapshot
     367    ///feature.
    362368    void changeSource(Edge e, Node n) {
    363369      Parent::changeSource(e,n);
     
    369375    ///valid. However <tt>OutEdgeIt</tt>s and <tt>InEdgeIt</tt>s are
    370376    ///invalidated.
     377    ///\warning This functionality cannot be used together with the Snapshot
     378    ///feature.
    371379    void reverseEdge(Edge e) {
    372380      Node t=target(e);
     
    380388    ///Using this it is possible to avoid the superfluous memory
    381389    ///allocation: if you know that the graph you want to build will
    382     ///contain at least 10 million nodes then it is worth to reserve
     390    ///contain at least 10 million nodes then it is worth reserving
    383391    ///space for this amount before starting to build the graph.
    384392    void reserveNode(int n) { nodes.reserve(n); };
     
    405413    ///valid. However <tt>InEdge</tt>s and <tt>OutEdge</tt>s
    406414    ///may be invalidated.
     415    ///\warning This functionality cannot be used together with the Snapshot
     416    ///feature.
    407417    void contract(Node a, Node b, bool r = true)
    408418    {
     
    681691      /// \brief Undo the changes until the last snapshot.
    682692      //
    683       /// Undo the changes until last snapshot created by save().
    684       ///
    685       /// \todo This function might be called undo().
     693      /// Undo the changes until the last snapshot created by save().
    686694      void restore() {
    687695        detach();
  • lemon/smart_graph.h

    r2116 r2123  
    240240  ///node and edge deletions</b>.
    241241  ///It conforms to
    242   ///the \ref concept::Graph "Graph" concept.
     242  ///the \ref concept::Graph "Graph concept".
    243243  ///\sa concept::Graph.
    244244  ///
     
    371371  /// node and edge deletions</b>.
    372372  /// Except from this it conforms to
    373   /// the \ref concept::UGraph "UGraph" concept.
     373  /// the \ref concept::UGraph "UGraph concept".
    374374  /// \sa concept::UGraph.
    375375  ///
     
    605605  /// that <b> it does not support node and edge deletions</b>.
    606606  /// Except from this it conforms to
    607   /// the \ref concept::BpUGraph "BpUGraph" concept.
     607  /// the \ref concept::BpUGraph "BpUGraph concept".
    608608  /// \sa concept::BpUGraph.
    609609  ///
Note: See TracChangeset for help on using the changeset viewer.