Naming convention fix
authordeba
Mon, 03 Apr 2006 09:24:38 +0000
changeset 2030d769d2eb4d50
parent 2029 e00114f165f5
child 2031 080d51024ac5
Naming convention fix
lemon/prim.h
     1.1 --- a/lemon/prim.h	Mon Apr 03 08:41:52 2006 +0000
     1.2 +++ b/lemon/prim.h	Mon Apr 03 09:24:38 2006 +0000
     1.3 @@ -38,8 +38,8 @@
     1.4  
     1.5    ///Default traits class of Prim class.
     1.6    ///\param GR Graph type.
     1.7 -  ///\param LM Type of cost map.
     1.8 -  template<class GR, class LM>
     1.9 +  ///\param CM Type of cost map.
    1.10 +  template<class GR, class CM>
    1.11    struct PrimDefaultTraits{
    1.12      ///The graph type the algorithm runs on. 
    1.13      typedef GR UGraph;
    1.14 @@ -47,9 +47,9 @@
    1.15  
    1.16      ///The type of the map that stores the edge costs.
    1.17      ///It must meet the \ref concept::ReadMap "ReadMap" concept.
    1.18 -    typedef LM CostMap;
    1.19 +    typedef CM CostMap;
    1.20      //The type of the cost of the edges.
    1.21 -    typedef typename LM::Value Value;
    1.22 +    typedef typename CM::Value Value;
    1.23      /// The cross reference type used by heap.
    1.24  
    1.25      /// The cross reference type used by heap.
    1.26 @@ -70,7 +70,7 @@
    1.27      ///
    1.28      ///\sa BinHeap
    1.29      ///\sa Prim
    1.30 -    typedef BinHeap<typename UGraph::Node, typename LM::Value,
    1.31 +    typedef BinHeap<typename UGraph::Node, typename CM::Value,
    1.32  		    HeapCrossRef, std::less<Value> > Heap;
    1.33  
    1.34      static Heap *createHeap(HeapCrossRef& _ref){
    1.35 @@ -152,18 +152,18 @@
    1.36    ///is \ref ListUGraph. The value of GR is not used directly by
    1.37    ///Prim, it is only passed to \ref PrimDefaultTraits.
    1.38    ///
    1.39 -  ///\param LM This read-only UEdgeMap determines the costs of the
    1.40 +  ///\param CM This read-only UEdgeMap determines the costs of the
    1.41    ///edges. It is read once for each edge, so the map may involve in
    1.42    ///relatively time consuming process to compute the edge cost if
    1.43    ///it is necessary. The default map type is \ref
    1.44    ///concept::UGraph::UEdgeMap "UGraph::UEdgeMap<int>".  The value
    1.45 -  ///of LM is not used directly by Prim, it is only passed to \ref
    1.46 +  ///of CM is not used directly by Prim, it is only passed to \ref
    1.47    ///PrimDefaultTraits.
    1.48    ///
    1.49    ///\param TR Traits class to set
    1.50    ///various data types used by the algorithm.  The default traits
    1.51    ///class is \ref PrimDefaultTraits
    1.52 -  ///"PrimDefaultTraits<GR,LM>".  See \ref
    1.53 +  ///"PrimDefaultTraits<GR,CM>".  See \ref
    1.54    ///PrimDefaultTraits for the documentation of a Prim traits
    1.55    ///class.
    1.56    ///
    1.57 @@ -171,21 +171,20 @@
    1.58  
    1.59  #ifdef DOXYGEN
    1.60    template <typename GR,
    1.61 -	    typename LM,
    1.62 +	    typename CM,
    1.63  	    typename TR>
    1.64  #else
    1.65    template <typename GR=ListUGraph,
    1.66 -	    typename LM=typename GR::template UEdgeMap<int>,
    1.67 -	    typename TR=PrimDefaultTraits<GR,LM> >
    1.68 +	    typename CM=typename GR::template UEdgeMap<int>,
    1.69 +	    typename TR=PrimDefaultTraits<GR,CM> >
    1.70  #endif
    1.71    class Prim {
    1.72    public:
    1.73 -    /**
    1.74 -     * \brief \ref Exception for uninitialized parameters.
    1.75 -     *
    1.76 -     * This error represents problems in the initialization
    1.77 -     * of the parameters of the algorithms.
    1.78 -     */
    1.79 +    
    1.80 +    /// \brief \ref Exception for uninitialized parameters.
    1.81 +    ///
    1.82 +    /// This error represents problems in the initialization
    1.83 +    /// of the parameters of the algorithms.
    1.84      class UninitializedParameter : public lemon::UninitializedParameter {
    1.85      public:
    1.86        virtual const char* exceptionName() const {