# Changeset 2408:467ca6d16556 in lemon-0.x for lemon

Ignore:
Timestamp:
03/13/07 16:42:06 (13 years ago)
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3239
Message:

Doc improvements contributed by Peter Kovacs.

Location:
lemon
Files:
5 edited

Unmodified
Removed
• ## lemon/bellman_ford.h

 r2394 /// /// It defines all computational operations and constants which are /// used in the bellman ford algorithm. The default implementation /// used in the Bellman-Ford algorithm. The default implementation /// is based on the numeric_limits class. If the numeric type does not /// have infinity value then the maximum value is used as extremal typedef typename _LengthMap::Value Value; /// \brief Operation traits for bellman-ford algorithm. /// \brief Operation traits for Bellman-Ford algorithm. /// /// It defines the infinity type on the given Value type /// \brief Adds a new source node. /// /// The optional second parameter is the initial distance of the node. /// It just sets the distance of the node to the given value. /// Adds a new source node. The optional second parameter is the /// initial distance of the node. It just sets the distance of the /// node to the given value. void addSource(Node source, Value dst = OperationTraits::zero()) { _dist->set(source, dst); } /// \brief Executes one round from the bellman ford algorithm. /// \brief Executes one round from the Bellman-Ford algorithm. /// /// If the algoritm calculated the distances in the previous round } /// \brief Executes one weak round from the bellman ford algorithm. /// \brief Executes one weak round from the Bellman-Ford algorithm. /// /// If the algorithm calculated the distances in the /// \pre init() must be called and at least one node should be added /// with addSource() before using this function. If there is /// a negative cycles in the graph it gives back false. /// a negative cycle in the graph it gives back false. /// /// This method runs the %BellmanFord algorithm from the root node(s) ///@{ /// \brief Lemon iterator for get a active nodes. /// \brief Lemon iterator for get the active nodes. /// /// Lemon iterator for get the active nodes. This class provides a typedef typename _LengthMap::Value Value; /// \brief Operation traits for bellman-ford algorithm. /// \brief Operation traits for Bellman-Ford algorithm. /// /// It defines the infinity type on the given Value type
• ## lemon/circulation.h

 r2391 bool checkX() { return checkX(_x); } ///Chech if \c bar is a real barrier ///Chech if \c bar is a real barrier ///Check if \c bar is a real barrier ///Check if \c bar is a real barrier ///\sa barrier() template return _tol.negative(delta); } ///Chech whether or not the last execution provides a barrier ///Chech whether or not the last execution provides a barrier ///Check whether or not the last execution provides a barrier ///Check whether or not the last execution provides a barrier ///\sa barrier() bool checkBarrier()
 r2392 ///\endcode /// ///Then RevGraphAdaptor implements the graph structure with node-set ///Then ResGraphAdaptor implements the graph structure with node-set /// \f$V \f$ and edge-set \f$A_{forward}\cup A_{backward} \f$, ///where \f\$ A_{forward}=\{uv : uv\in A, f(uv)