Changeset 606:c5fd2d996909 in lemon for lemon/unionfind.h

Timestamp:

03/29/09 23:08:20 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Various doc improvements (#248)

• Rename all the ugly template parameters (too long and/or starting with an underscore).
• Rename function parameters starting with an underscore.
• Extend the doc for many classes.
• Use LaTeX-style O(...) expressions only for the complicated ones.
• A lot of small unification changes.
• Small fixes.
• Some other improvements.

File:

• lemon/unionfind.h (modified) (7 diffs)

lemon/unionfind.h

@@ -52 +52 @@
   /// \pre You need to add all the elements by the \ref insert()
   /// method.
-  template <typename _ItemIntMap>
+  template <typename IM>
   class UnionFind {
   public:
 
-    typedef _ItemIntMap ItemIntMap;
+    ///\e
+    typedef IM ItemIntMap;
+    ///\e
     typedef typename ItemIntMap::Key Item;
 
@@ -171 +173 @@
   /// method.
   ///
-  template <typename _ItemIntMap>
+  template <typename IM>
   class UnionFindEnum {
   public:
 
-    typedef _ItemIntMap ItemIntMap;
+    ///\e
+    typedef IM ItemIntMap;
+    ///\e
     typedef typename ItemIntMap::Key Item;
 
@@ -628 +632 @@
   /// \pre You need to add all the elements by the \ref insert()
   /// method.
-  template <typename _ItemIntMap>
+  template <typename IM>
   class ExtendFindEnum {
   public:
 
-    typedef _ItemIntMap ItemIntMap;
+    ///\e
+    typedef IM ItemIntMap;
+    ///\e
     typedef typename ItemIntMap::Key Item;
 
@@ -949 +955 @@
   /// \pre You need to add all the elements by the \ref insert()
   /// method.
-  ///
-  template <typename _Value, typename _ItemIntMap,
-            typename _Comp = std::less<_Value> >
+  template <typename V, typename IM, typename Comp = std::less<V> >
   class HeapUnionFind {
   public:
 
-    typedef _Value Value;
-    typedef typename _ItemIntMap::Key Item;
-
-    typedef _ItemIntMap ItemIntMap;
-
-    typedef _Comp Comp;
+    ///\e
+    typedef V Value;
+    ///\e
+    typedef typename IM::Key Item;
+    ///\e
+    typedef IM ItemIntMap;
+    ///\e
+    typedef Comp Compare;
 
   private:
@@ -1602 +1608 @@
     /// \brief Gives back the priority of the current item.
     ///
-    /// \return Gives back the priority of the current item.
+    /// Gives back the priority of the current item.
     const Value& operator[](const Item& item) const {
       return nodes[index[item]].prio;
@@ -1647 +1653 @@
     /// \brief Gives back the minimum priority of the class.
     ///
-    /// \return Gives back the minimum priority of the class.
+    /// Gives back the minimum priority of the class.
     const Value& classPrio(int cls) const {
       return nodes[~(classes[cls].parent)].prio;
@@ -1661 +1667 @@
     /// \brief Gives back a representant item of the class.
     ///
+    /// Gives back a representant item of the class.
     /// The representant is indpendent from the priorities of the
     /// items.
-    /// \return Gives back a representant item of the class.
     const Item& classRep(int id) const {
       int parent = classes[id].parent;