# Changeset 1024:745312f9b441 in lemon for lemon

Ignore:
Timestamp:
01/09/11 23:20:56 (10 years ago)
Branch:
default
Phase:
public
Message:

Improve the doc of path structures (#406)

File:
1 edited

Unmodified
Added
Removed
• ## lemon/path.h

 r956 /// /// In a sense, the path can be treated as a list of arcs. The /// lemon path type stores just this list. As a consequence, it /// LEMON path type stores just this list. As a consequence, it /// cannot enumerate the nodes of the path and the source node of /// a zero length path is undefined. void clear() { head.clear(); tail.clear(); } /// \brief The nth arc. /// \brief The n-th arc. /// /// \pre \c n is in the [0..length() - 1] range. } /// \brief Initialize arc iterator to point to the nth arc /// \brief Initialize arc iterator to point to the n-th arc /// /// \pre \c n is in the [0..length() - 1] range. /// /// In a sense, the path can be treated as a list of arcs. The /// lemon path type stores just this list. As a consequence it /// LEMON path type stores just this list. As a consequence it /// cannot enumerate the nodes in the path and the zero length paths /// cannot store the source. void clear() { data.clear(); } /// \brief The nth arc. /// \brief The n-th arc. /// /// \pre \c n is in the [0..length() - 1] range. } /// \brief  Initializes arc iterator to point to the nth arc. /// \brief  Initializes arc iterator to point to the n-th arc. ArcIt nthIt(int n) const { return ArcIt(*this, n); /// /// In a sense, the path can be treated as a list of arcs. The /// lemon path type stores just this list. As a consequence it /// LEMON path type stores just this list. As a consequence it /// cannot enumerate the nodes in the path and the zero length paths /// cannot store the source. }; /// \brief The nth arc. /// /// This function looks for the nth arc in O(n) time. /// \brief The n-th arc. /// /// This function looks for the n-th arc in O(n) time. /// \pre \c n is in the [0..length() - 1] range. const Arc& nth(int n) const { } /// \brief Initializes arc iterator to point to the nth arc. /// \brief Initializes arc iterator to point to the n-th arc. ArcIt nthIt(int n) const { Node *node = first; /// /// In a sense, the path can be treated as a list of arcs. The /// lemon path type stores just this list. As a consequence it /// LEMON path type stores just this list. As a consequence it /// cannot enumerate the nodes in the path and the source node of /// a zero length path is undefined. }; /// \brief The nth arc. /// \brief The n-th arc. /// /// \pre \c n is in the [0..length() - 1] range. } /// \brief The arc iterator pointing to the nth arc. /// \brief The arc iterator pointing to the n-th arc. ArcIt nthIt(int n) const { return ArcIt(*this, n); /// /// In a sense, the path can be treated as a list of arcs. The /// lemon path type stores only this list. As a consequence, it /// LEMON path type stores only this list. As a consequence, it /// cannot enumerate the nodes in the path and the zero length paths /// cannot have a source node.
Note: See TracChangeset for help on using the changeset viewer.