# Changeset 825:75e6020b19b1 in lemon-1.2

Ignore:
Timestamp:
02/12/10 11:00:20 (9 years ago)
Branch:
default
Phase:
public
Message:

Add doc for the traits class parameters (#315)

Location:
lemon
Files:
12 edited

Unmodified
Removed
• ## lemon/bellman_ford.h

 r804 /// the lengths of the arcs. The default map type is /// \ref concepts::Digraph::ArcMap "GR::ArcMap". /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref BellmanFordDefaultTraits /// "BellmanFordDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. #ifdef DOXYGEN template /// This class should only be used through the \ref bellmanFord() /// function, which makes it easier to use the algorithm. /// /// \tparam TR The traits class that defines various types used by the /// algorithm. template class BellmanFordWizard : public TR {
• ## lemon/bfs.h

 r788 ///\tparam GR The type of the digraph the algorithm runs on. ///The default type is \ref ListDigraph. ///\tparam TR The traits class that defines various types used by the ///algorithm. By default, it is \ref BfsDefaultTraits ///"BfsDefaultTraits". ///In most cases, this parameter should not be set directly, ///consider to use the named template parameters instead. #ifdef DOXYGEN template class BfsWizard : public TR /// does not observe the BFS events. If you want to observe the BFS /// events, you should implement your own visitor class. /// \tparam TR Traits class to set various data types used by the /// algorithm. The default traits class is /// \ref BfsVisitDefaultTraits "BfsVisitDefaultTraits". /// See \ref BfsVisitDefaultTraits for the documentation of /// a BFS visit traits class. /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref BfsVisitDefaultTraits /// "BfsVisitDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. #ifdef DOXYGEN template
• ## lemon/capacity_scaling.h

 r821 /// \tparam GR The digraph type the algorithm runs on. /// \tparam V The number type used for flow amounts, capacity bounds /// and supply values in the algorithm. By default it is \c int. /// and supply values in the algorithm. By default, it is \c int. /// \tparam C The number type used for costs and potentials in the /// algorithm. By default it is the same as \c V. /// algorithm. By default, it is the same as \c V. /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref CapacityScalingDefaultTraits /// "CapacityScalingDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. /// /// \warning Both number types must be signed and all input data must
• ## lemon/circulation.h

 r786 \tparam SM The type of the supply map. The default map type is \ref concepts::Digraph::NodeMap "GR::NodeMap". \tparam TR The traits class that defines various types used by the algorithm. By default, it is \ref CirculationDefaultTraits "CirculationDefaultTraits". In most cases, this parameter should not be set directly, consider to use the named template parameters instead. */ #ifdef DOXYGEN
• ## lemon/cost_scaling.h

 r821 /// \tparam GR The digraph type the algorithm runs on. /// \tparam V The number type used for flow amounts, capacity bounds /// and supply values in the algorithm. By default it is \c int. /// and supply values in the algorithm. By default, it is \c int. /// \tparam C The number type used for costs and potentials in the /// algorithm. By default it is the same as \c V. /// algorithm. By default, it is the same as \c V. /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref CostScalingDefaultTraits /// "CostScalingDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. /// /// \warning Both number types must be signed and all input data must /// /// The large cost type used for internal computations. /// Using the \ref CostScalingDefaultTraits "default traits class", /// it is \c long \c long if the \c Cost type is integer, /// By default, it is \c long \c long if the \c Cost type is integer, /// otherwise it is \c double. typedef typename TR::LargeCost LargeCost;
• ## lemon/dfs.h

 r788 ///\tparam GR The type of the digraph the algorithm runs on. ///The default type is \ref ListDigraph. ///\tparam TR The traits class that defines various types used by the ///algorithm. By default, it is \ref DfsDefaultTraits ///"DfsDefaultTraits". ///In most cases, this parameter should not be set directly, ///consider to use the named template parameters instead. #ifdef DOXYGEN template class DfsWizard : public TR /// does not observe the DFS events. If you want to observe the DFS /// events, you should implement your own visitor class. /// \tparam TR Traits class to set various data types used by the /// algorithm. The default traits class is /// \ref DfsVisitDefaultTraits "DfsVisitDefaultTraits". /// See \ref DfsVisitDefaultTraits for the documentation of /// a DFS visit traits class. /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref DfsVisitDefaultTraits /// "DfsVisitDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. #ifdef DOXYGEN template
• ## lemon/dijkstra.h

 r788 ///it is necessary. The default map type is \ref ///concepts::Digraph::ArcMap "GR::ArcMap". ///\tparam TR The traits class that defines various types used by the ///algorithm. By default, it is \ref DijkstraDefaultTraits ///"DijkstraDefaultTraits". ///In most cases, this parameter should not be set directly, ///consider to use the named template parameters instead. #ifdef DOXYGEN template /// This class should only be used through the \ref dijkstra() function, /// which makes it easier to use the algorithm. /// /// \tparam TR The traits class that defines various types used by the /// algorithm. template class DijkstraWizard : public TR
• ## lemon/hartmann_orlin.h

 r795 /// \tparam LEN The type of the length map. The default /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap". /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref HartmannOrlinDefaultTraits /// "HartmannOrlinDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. #ifdef DOXYGEN template /// /// The large value type used for internal computations. /// Using the \ref HartmannOrlinDefaultTraits "default traits class", /// it is \c long \c long if the \c Value type is integer, /// By default, it is \c long \c long if the \c Value type is integer, /// otherwise it is \c double. typedef typename TR::LargeValue LargeValue;
• ## lemon/howard.h

 r771 /// \tparam LEN The type of the length map. The default /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap". /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref HowardDefaultTraits /// "HowardDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. #ifdef DOXYGEN template /// /// The large value type used for internal computations. /// Using the \ref HowardDefaultTraits "default traits class", /// it is \c long \c long if the \c Value type is integer, /// By default, it is \c long \c long if the \c Value type is integer, /// otherwise it is \c double. typedef typename TR::LargeValue LargeValue;
• ## lemon/karp.h

 r772 /// \tparam LEN The type of the length map. The default /// map type is \ref concepts::Digraph::ArcMap "GR::ArcMap". /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref KarpDefaultTraits /// "KarpDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. #ifdef DOXYGEN template /// /// The large value type used for internal computations. /// Using the \ref KarpDefaultTraits "default traits class", /// it is \c long \c long if the \c Value type is integer, /// By default, it is \c long \c long if the \c Value type is integer, /// otherwise it is \c double. typedef typename TR::LargeValue LargeValue;
• ## lemon/min_cost_arborescence.h

 r713 /// it is necessary. The default map type is \ref /// concepts::Digraph::ArcMap "Digraph::ArcMap". /// \param TR Traits class to set various data types used /// by the algorithm. The default traits class is /// \ref MinCostArborescenceDefaultTraits /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref MinCostArborescenceDefaultTraits /// "MinCostArborescenceDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. #ifndef DOXYGEN template > #else template template #endif class MinCostArborescence {
• ## lemon/preflow.h

 r823 /// \tparam CAP The type of the capacity map. The default map /// type is \ref concepts::Digraph::ArcMap "GR::ArcMap". /// \tparam TR The traits class that defines various types used by the /// algorithm. By default, it is \ref PreflowDefaultTraits /// "PreflowDefaultTraits". /// In most cases, this parameter should not be set directly, /// consider to use the named template parameters instead. #ifdef DOXYGEN template
Note: See TracChangeset for help on using the changeset viewer.