Ignore:
Timestamp:
Jun 6, 2008, 9:00:46 PM (13 years ago)
Author:
Peter
Message:

correcting docs

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/utility/Range.h

    r1336 r1337  
    8787  /**
    8888     \brief Equality comparison
    89      \return true iff underlying std::type_info are equal
     89     \return true iff underlying elements are equal
    9090   */ 
    9191  template<typename T1, typename T2>
     
    100100  /**
    101101     \brief Ordering relation
    102      \return true iff underlying lhs.get()<rhs.get()
     102
     103     Using std::lexicographical_compare
     104
     105     \return true if \a lhs < \a rhs
    103106   */ 
    104107  template<typename T1, typename T2>
     
    106109
    107110  /**
    108      \brief Based on operators == and <
    109    */ 
    110   template<typename T1, typename T2>
    111   bool operator<=(const Range<T1>&, const Range<T2>&);
    112 
    113   /**
    114      \brief Based on operators == and <
     111     \return ! (\a rhs < \a lhs )
     112   */ 
     113  template<typename T1, typename T2>
     114  bool operator<=(const Range<T1>& lhs, const Range<T2>& rhs);
     115
     116  /**
     117     \return \a rhs < \a lhs
    115118   */ 
    116119  template<typename T1, typename T2>
     
    118121
    119122  /**
    120      \brief Based on operators == and <
     123     \return ! (\a lhs < \a rhs )
    121124   */ 
    122125  template<typename T1, typename T2>
     
    155158  bool operator==(const Range<T>& lhs, const Range<T>& rhs)
    156159  {
    157     // we are not using std::equal in order to handle ranges of equal length
     160    // we are not using std::equal because we want to handle ranges of
     161    // different length
    158162    T first1(lhs.begin());
    159163    T last1(lhs.end());
     
    166170      ++first2;
    167171    }
     172    // check that ranges are equally long
    168173    return first1==last1 && first2==last2;
    169174  }
Note: See TracChangeset for help on using the changeset viewer.