COIN-OR::LEMON - Graph Library

Changeset 891:75e6020b19b1 in lemon for lemon/bellman_ford.h


Ignore:
Timestamp:
02/12/10 11:00:20 (10 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Phase:
public
Message:

Add doc for the traits class parameters (#315)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • lemon/bellman_ford.h

    r870 r891  
    172172  /// the lengths of the arcs. The default map type is
    173173  /// \ref concepts::Digraph::ArcMap "GR::ArcMap<int>".
     174  /// \tparam TR The traits class that defines various types used by the
     175  /// algorithm. By default, it is \ref BellmanFordDefaultTraits
     176  /// "BellmanFordDefaultTraits<GR, LEN>".
     177  /// In most cases, this parameter should not be set directly,
     178  /// consider to use the named template parameters instead.
    174179#ifdef DOXYGEN
    175180  template <typename GR, typename LEN, typename TR>
     
    934939  /// This class should only be used through the \ref bellmanFord()
    935940  /// function, which makes it easier to use the algorithm.
     941  ///
     942  /// \tparam TR The traits class that defines various types used by the
     943  /// algorithm.
    936944  template<class TR>
    937945  class BellmanFordWizard : public TR {
Note: See TracChangeset for help on using the changeset viewer.