Changeset 1023:e0cef67fe565 in lemon for lemon

Ignore:
Timestamp:
01/09/11 16:51:14 (9 years ago)
Branch:
default
Phase:
public
Message:

Various doc improvements (#406)

Location:
lemon
Files:
6 edited

Unmodified
Removed
• lemon/capacity_scaling.h

 r956 /// \warning Both number types must be signed and all input data must /// be integer. /// \warning This algorithm does not support negative costs for such /// arcs that have infinite upper bound. /// \warning This algorithm does not support negative costs for /// arcs having infinite upper bound. #ifdef DOXYGEN template /// /// Using this function has the same effect as using \ref supplyMap() /// with such a map in which \c k is assigned to \c s, \c -k is /// with a map in which \c k is assigned to \c s, \c -k is /// assigned to \c t and all other nodes have zero supply value. ///
• lemon/core.h

 r988 } /// Check whether a graph is undirected. /// \brief Check whether a graph is undirected. /// /// This function returns \c true if the given graph is undirected.
• lemon/cost_scaling.h

 r956 /// "preflow push-relabel" algorithm for the maximum flow problem. /// /// In general, \ref NetworkSimplex and \ref CostScaling are the fastest /// implementations available in LEMON for this problem. /// /// Most of the parameters of the problem (except for the digraph) /// can be given using separate functions, and the algorithm can be /// \warning Both number types must be signed and all input data must /// be integer. /// \warning This algorithm does not support negative costs for such /// arcs that have infinite upper bound. /// \warning This algorithm does not support negative costs for /// arcs having infinite upper bound. /// /// \note %CostScaling provides three different internal methods, /// relabel operation. /// By default, the so called \ref PARTIAL_AUGMENT /// "Partial Augment-Relabel" method is used, which proved to be /// "Partial Augment-Relabel" method is used, which turned out to be /// the most efficient and the most robust on various test inputs. /// However, the other methods can be selected using the \ref run() /// /// Using this function has the same effect as using \ref supplyMap() /// with such a map in which \c k is assigned to \c s, \c -k is /// with a map in which \c k is assigned to \c s, \c -k is /// assigned to \c t and all other nodes have zero supply value. ///
• lemon/cycle_canceling.h

 r956 /// \warning Both number types must be signed and all input data must /// be integer. /// \warning This algorithm does not support negative costs for such /// arcs that have infinite upper bound. /// \warning This algorithm does not support negative costs for /// arcs having infinite upper bound. /// /// \note For more information about the three available methods, /// \ref CycleCanceling provides three different cycle-canceling /// methods. By default, \ref CANCEL_AND_TIGHTEN "Cancel and Tighten" /// is used, which proved to be the most efficient and the most robust /// on various test inputs. /// is used, which is by far the most efficient and the most robust. /// However, the other methods can be selected using the \ref run() /// function with the proper parameter. /// /// Using this function has the same effect as using \ref supplyMap() /// with such a map in which \c k is assigned to \c s, \c -k is /// with a map in which \c k is assigned to \c s, \c -k is /// assigned to \c t and all other nodes have zero supply value. ///
• lemon/euler.h

 r956 ///Euler tour iterator for digraphs. /// \ingroup graph_prop /// \ingroup graph_properties ///This iterator provides an Euler tour (Eulerian circuit) of a \e directed ///graph (if there exists) and it converts to the \c Arc type of the digraph.
• lemon/network_simplex.h

 r991 /// flow problem. /// /// In general, %NetworkSimplex is the fastest implementation available /// in LEMON for this problem. /// Moreover, it supports both directions of the supply/demand inequality /// constraints. For more information, see \ref SupplyType. /// In general, \ref NetworkSimplex and \ref CostScaling are the fastest /// implementations available in LEMON for this problem. /// Furthermore, this class supports both directions of the supply/demand /// inequality constraints. For more information, see \ref SupplyType. /// /// Most of the parameters of the problem (except for the digraph) /// of the algorithm. /// By default, \ref BLOCK_SEARCH "Block Search" is used, which /// proved to be the most efficient and the most robust on various /// turend out to be the most efficient and the most robust on various /// test inputs. /// However, another pivot rule can be selected using the \ref run() typedef std::vector CostVector; typedef std::vector CharVector; // Note: vector is used instead of vector and // Note: vector is used instead of vector and // vector for efficiency reasons /// /// \return (*this) /// /// \sa supplyType() template NetworkSimplex& supplyMap(const SupplyMap& map) { /// /// Using this function has the same effect as using \ref supplyMap() /// with such a map in which \c k is assigned to \c s, \c -k is /// with a map in which \c k is assigned to \c s, \c -k is /// assigned to \c t and all other nodes have zero supply value. ///
Note: See TracChangeset for help on using the changeset viewer.