Changeset 2030:d769d2eb4d50 in lemon-0.x

Timestamp:

04/03/06 11:24:38 (18 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2669

Message:

Naming convention fix

File:

• lemon/prim.h (modified) (6 diffs)

lemon/prim.h

@@ -39 +39 @@
   ///Default traits class of Prim class.
   ///\param GR Graph type.
-  ///\param LM Type of cost map.
-  template<class GR, class LM>
+  ///\param CM Type of cost map.
+  template<class GR, class CM>
   struct PrimDefaultTraits{
     ///The graph type the algorithm runs on. 
@@ -48 +48 @@
     ///The type of the map that stores the edge costs.
     ///It must meet the \ref concept::ReadMap "ReadMap" concept.
-    typedef LM CostMap;
+    typedef CM CostMap;
     //The type of the cost of the edges.
-    typedef typename LM::Value Value;
+    typedef typename CM::Value Value;
     /// The cross reference type used by heap.
 
@@ -71 +71 @@
     ///\sa BinHeap
     ///\sa Prim
-    typedef BinHeap<typename UGraph::Node, typename LM::Value,
+    typedef BinHeap<typename UGraph::Node, typename CM::Value,
                     HeapCrossRef, std::less<Value> > Heap;
 
@@ -153 +153 @@
   ///Prim, it is only passed to \ref PrimDefaultTraits.
   ///
-  ///\param LM This read-only UEdgeMap determines the costs of the
+  ///\param CM This read-only UEdgeMap determines the costs of the
   ///edges. It is read once for each edge, so the map may involve in
   ///relatively time consuming process to compute the edge cost if
   ///it is necessary. The default map type is \ref
   ///concept::UGraph::UEdgeMap "UGraph::UEdgeMap<int>".  The value
-  ///of LM is not used directly by Prim, it is only passed to \ref
+  ///of CM is not used directly by Prim, it is only passed to \ref
   ///PrimDefaultTraits.
   ///
@@ -164 +164 @@
   ///various data types used by the algorithm.  The default traits
   ///class is \ref PrimDefaultTraits
-  ///"PrimDefaultTraits<GR,LM>".  See \ref
+  ///"PrimDefaultTraits<GR,CM>".  See \ref
   ///PrimDefaultTraits for the documentation of a Prim traits
   ///class.
@@ -172 +172 @@
 #ifdef DOXYGEN
   template <typename GR,
-            typename LM,
+            typename CM,
             typename TR>
 #else
   template <typename GR=ListUGraph,
-            typename LM=typename GR::template UEdgeMap<int>,
-            typename TR=PrimDefaultTraits<GR,LM> >
+            typename CM=typename GR::template UEdgeMap<int>,
+            typename TR=PrimDefaultTraits<GR,CM> >
 #endif
   class Prim {
   public:
-    /**
-     * \brief \ref Exception for uninitialized parameters.
-     *
-     * This error represents problems in the initialization
-     * of the parameters of the algorithms.
-     */
+    
+    /// \brief \ref Exception for uninitialized parameters.
+    ///
+    /// This error represents problems in the initialization
+    /// of the parameters of the algorithms.
     class UninitializedParameter : public lemon::UninitializedParameter {
     public: