COIN-OR::LEMON - Graph Library

Changeset 964:2c0c20e90116 in lemon-0.x


Ignore:
Timestamp:
11/05/04 08:26:20 (16 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1348
Message:

Doc improvements

Location:
src/lemon
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • src/lemon/concept/graph_component.h

    r962 r964  
    3535
    3636    /// \note Because Node and Edge are forbidden to inherit from the same
    37     /// base class, this is a template. For Node you shoul instantiate it
     37    /// base class, this is a template. For Node you should instantiate it
    3838    /// with character 'n' and for Edge with 'e'.
    3939
  • src/lemon/dimacs.h

    r921 r964  
    3636
    3737  /// This function reads a min cost flow instance from dimacs format,
    38   /// i.e. from dimacs files having a line starting with \c p \c "min".
     38  /// i.e. from dimacs files having a line starting with
     39  /// \code
     40  /// p "min"
     41  /// \endcode
    3942  /// At the beginning \c g is cleared by \c g.clear(). The edge
    4043  /// capacities are written to \c capacity, \c s and \c t are set to
     
    113116
    114117  /// This function reads a max flow instance from dimacs format,
    115   /// i.e. from dimacs files having a line starting with \c p \c
    116   /// "max".  At the beginning \c g is cleared by \c g.clear(). The
     118  /// i.e. from dimacs files having a line starting with
     119  /// \code
     120  /// p "max"
     121  /// \endcode
     122  ///At the beginning \c g is cleared by \c g.clear(). The
    117123  /// edge capacities are written to \c capacity and \c s and \c t are
    118124  /// set to the source and the target nodes.
     
    130136
    131137  /// This function reads a shortest path instance from dimacs format,
    132   /// i.e. from dimacs files having a line starting with \c p \c "sp".
     138  /// i.e. from dimacs files having a line starting with
     139  /// \code
     140  /// p "sp"
     141  /// \endcode
    133142  /// At the beginning \c g is cleared by \c g.clear(). The edge
    134143  /// capacities are written to \c capacity and \c s is set to the
     
    163172  /// This function reads a graph without any designated nodes and
    164173  /// maps from dimacs format, i.e. from dimacs files having a line
    165   /// starting with \c p \c "mat".  At the beginning \c g is cleared
     174  /// starting with
     175  /// \code
     176  /// p "mat"
     177  /// \endcode
     178  /// At the beginning \c g is cleared
    166179  /// by \c g.clear().
    167180  ///
  • src/lemon/graph_utils.h

    r947 r964  
    2525///\file
    2626///\brief Graph utilities.
     27///
     28///\todo Please
     29///revise the documentation.
    2730///
    2831
     
    5356  /// This function counts the nodes in the graph.
    5457  /// The complexity of the function is O(n) but for some
    55   /// graph structure it is specialized to O(1).
     58  /// graph structure it is specialized to run in O(1).
    5659
    5760  template <typename Graph>
     
    6467  /// This function counts the edges in the graph.
    6568  /// The complexity of the function is O(e) but for some
    66   /// graph structure it is specialized to O(1).
     69  /// graph structure it is specialized to run in O(1).
    6770  template <typename Graph>
    6871  inline int countEdges(const Graph& _g) {
     
    7477  /// This function counts the symmetric edges in the graph.
    7578  /// The complexity of the function is O(e) but for some
    76   /// graph structure it is specialized to O(1).
     79  /// graph structure it is specialized to run in O(1).
    7780  template <typename Graph>
    7881  inline int countSymEdges(const Graph& _g) {
     
    8891    return num;
    8992  }
     93 
     94  ///\e
    9095
     96  ///\todo Please document.
     97  ///
    9198  template <typename Graph>
    9299  inline int countOutEdges(const Graph& _g,  const typename Graph::Node& _n) {
     
    94101  }
    95102
     103  ///\e
     104
     105  ///\todo Please document.
     106  ///
    96107  template <typename Graph>
    97108  inline int countInEdges(const Graph& _g,  const typename Graph::Node& _n) {
  • src/lemon/xy.h

    r921 r964  
    5151    public:
    5252
     53      typedef T ValueType;
     54
    5355      T x,y;     
    5456     
Note: See TracChangeset for help on using the changeset viewer.