COIN-OR::LEMON - Graph Library

Changeset 1526:8c14aa8f27a2 in lemon-0.x for lemon/graph_utils.h


Ignore:
Timestamp:
06/30/05 18:13:30 (15 years ago)
Author:
athos
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2012
Message:

Mainly doc review.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/graph_utils.h

    r1515 r1526  
    7474  /// This function counts the nodes in the graph.
    7575  /// The complexity of the function is O(n) but for some
    76   /// graph structure it is specialized to run in O(1).
     76  /// graph structures it is specialized to run in O(1).
    7777  ///
    7878  /// \todo refer how to specialize it
     
    101101  /// This function counts the edges in the graph.
    102102  /// The complexity of the function is O(e) but for some
    103   /// graph structure it is specialized to run in O(1).
     103  /// graph structures it is specialized to run in O(1).
    104104
    105105  template <typename Graph>
     
    122122  }
    123123
    124   /// \brief Function to count the edges in the graph.
    125   ///
    126   /// This function counts the edges in the graph.
     124  /// \brief Function to count the undirected edges in the graph.
     125  ///
     126  /// This function counts the undirected edges in the graph.
    127127  /// The complexity of the function is O(e) but for some
    128128  /// graph structure it is specialized to run in O(1).
     
    175175  }
    176176 
    177   ///\e
    178 
    179   ///\todo Please document.
    180   ///
     177  /// \brief Function to count the number of the out-edges from node \c n.
     178  ///
     179  /// This function counts the number of the out-edges from node \c n
     180  /// in the graph. 
    181181  template <typename Graph>
    182182  inline int countOutEdges(const Graph& _g,  const typename Graph::Node& _n) {
     
    184184  }
    185185
    186   ///\e
    187 
    188   ///\todo Please document.
    189   ///
     186  /// \brief Function to count the number of the in-edges to node \c n.
     187  ///
     188  /// This function counts the number of the in-edges to node \c n
     189  /// in the graph. 
    190190  template <typename Graph>
    191191  inline int countInEdges(const Graph& _g,  const typename Graph::Node& _n) {
     
    365365  /// Provides an immutable and unique id for each item in the graph.
    366366
    367   /// The IdMap class provides an unique and immutable mapping for each item
     367  /// The IdMap class provides a unique and immutable mapping for each item
    368368  /// in the graph.
    369369  ///
     
    430430
    431431 
    432   /// \brief General inversable graph-map type.
    433 
    434   /// This type provides simple inversable map functions.
    435   /// The InversableMap wraps an arbitrary ReadWriteMap
    436   /// and if a key is setted to a new value then store it
     432  /// \brief General invertable graph-map type.
     433
     434  /// This type provides simple invertable map functions.
     435  /// The InvertableMap wraps an arbitrary ReadWriteMap
     436  /// and if a key is set to a new value then store it
    437437  /// in the inverse map.
    438438  /// \param _Graph The graph type.
    439   /// \param _Map The map to extend with inversable functionality.
     439  /// \param _Map The map to extend with invertable functionality.
    440440  template <
    441441    typename _Graph,
Note: See TracChangeset for help on using the changeset viewer.