COIN-OR::LEMON - Graph Library

Changeset 97:ee1324c91288 in lemon-1.0 for lemon/path_utils.h


Ignore:
Timestamp:
01/24/08 17:49:10 (12 years ago)
Author:
Alpar Juttner <alpar@…>
Branch:
default
Phase:
public
Message:

Doc improvements

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/path_utils.h

    r96 r97  
    9191
    9292
    93   /// \brief Make of copy of a path.
    94   ///
    95   ///  Make of copy of a path.
     93  /// \brief Make a copy of a path.
     94  ///
     95  ///  This function makes a copy of a path.
    9696  template <typename Target, typename Source>
    9797  void copyPath(Target& target, const Source& source) {
     
    100100  }
    101101
    102   /// \brief Checks the path's consistency.
    103   ///
    104   /// Checks that each arc's target is the next's source.
     102  /// \brief Check the consistency of a path.
     103  ///
     104  /// This function checks that the target of each arc is the same
     105  /// as the source of the next one.
    105106  ///
    106107  template <typename Digraph, typename Path>
     
    118119  }
    119120
    120   /// \brief Gives back the source of the path
    121   ///
    122   /// Gives back the source of the path.
     121  /// \brief The source of a path
     122  ///
     123  /// This function returns the source of the given path.
    123124  template <typename Digraph, typename Path>
    124125  typename Digraph::Node pathSource(const Digraph& digraph, const Path& path) {
     
    126127  }
    127128
    128   /// \brief Gives back the target of the path
    129   ///
    130   /// Gives back the target of the path.
     129  /// \brief The target of a path
     130  ///
     131  /// This function returns the target of the given path.
    131132  template <typename Digraph, typename Path>
    132133  typename Digraph::Node pathTarget(const Digraph& digraph, const Path& path) {
     
    134135  }
    135136
    136   /// \brief Class which helps to iterate the nodes of a path
     137  /// \brief Class which helps to iterate through the nodes of a path
    137138  ///
    138139  /// In a sense, the path can be treated as a list of arcs. The
    139   /// lemon path type stores just this list. As a consequence it
     140  /// lemon path type stores only this list. As a consequence, it
    140141  /// cannot enumerate the nodes in the path and the zero length paths
    141   /// cannot store the node.
     142  /// cannot have a source node.
    142143  ///
    143144  /// This class implements the node iterator of a path structure. To
    144   /// provide this feature, the underlying digraph should be given to
     145  /// provide this feature, the underlying digraph should be passed to
    145146  /// the constructor of the iterator.
    146147  template <typename Path>
Note: See TracChangeset for help on using the changeset viewer.