Changeset 1337 for trunk

Timestamp:

Jun 6, 2008, 9:00:46 PM (15 years ago)

Author:

Peter

Message:

correcting docs

File:

• trunk/yat/utility/Range.h (modified) (6 diffs)

trunk/yat/utility/Range.h

@@ -87 +87 @@
   /**
      \brief Equality comparison
-     \return true iff underlying std::type_info are equal
+     \return true iff underlying elements are equal
    */  
   template<typename T1, typename T2>
@@ -100 +100 @@
   /**
      \brief Ordering relation
-     \return true iff underlying lhs.get()<rhs.get()
+
+     Using std::lexicographical_compare
+
+     \return true if \a lhs < \a rhs
    */  
   template<typename T1, typename T2>
@@ -106 +109 @@
 
   /**
-     \brief Based on operators == and <
-   */  
-  template<typename T1, typename T2>
-  bool operator<=(const Range<T1>&, const Range<T2>&);
-
-  /**
-     \brief Based on operators == and <
+     \return ! (\a rhs < \a lhs )
+   */  
+  template<typename T1, typename T2>
+  bool operator<=(const Range<T1>& lhs, const Range<T2>& rhs);
+
+  /**
+     \return \a rhs < \a lhs
    */  
   template<typename T1, typename T2>
@@ -118 +121 @@
 
   /**
-     \brief Based on operators == and <
+     \return ! (\a lhs < \a rhs )
    */  
   template<typename T1, typename T2>
@@ -155 +158 @@
   bool operator==(const Range<T>& lhs, const Range<T>& rhs)
   {
-    // we are not using std::equal in order to handle ranges of equal length
+    // we are not using std::equal because we want to handle ranges of
+    // different length
     T first1(lhs.begin());
     T last1(lhs.end());
@@ -166 +170 @@
       ++first2;
     }
+    // check that ranges are equally long
     return first1==last1 && first2==last2;
   }