Changeset 2263

Timestamp:

May 27, 2010, 12:13:07 AM (13 years ago)

Author:

Peter

Message:

adding a class DataIteratorConcept? for concept data iterator. refs #624

Location:

trunk

Files:

• doc/concepts.doxygen (modified) (1 diff)
• test/concept_test.cc (modified) (1 diff)
• yat/normalizer/Gauss.h (modified) (2 diffs)
• yat/normalizer/qQuantileNormalizer.h (modified) (4 diffs)
• yat/statistics/Histogram.h (modified) (2 diffs)
• yat/statistics/Percentiler.h (modified) (2 diffs)
• yat/statistics/utility.h (modified) (3 diffs)
• yat/utility/concept_check.h (modified) (2 diffs)

trunk/doc/concepts.doxygen

@@ -444 +444 @@
 Examples of concept \ref concept_data_iterator include:
   - theplu::yat::utility::Matrix::iterator,
+  - theplu::yat::utility::MatrixWeighted::iterator,
   - theplu::yat::classifier::MatrixLookup::const_iterator,
   - theplu::yat::classifier::MatrixLookupWeighted::const_iterator

trunk/test/concept_test.cc

@@ -53 +53 @@
   BOOST_CONCEPT_ASSERT((Mutable_Container2D<MatrixWeighted>));
   
-
+  // concept DataIterator
+  using classifier::MatrixLookup;
+  using classifier::MatrixLookupWeighted;
+  BOOST_CONCEPT_ASSERT((DataIteratorConcept<Matrix::iterator>));
+  BOOST_CONCEPT_ASSERT((DataIteratorConcept<MatrixWeighted::iterator>));
+  BOOST_CONCEPT_ASSERT((DataIteratorConcept<MatrixLookup::const_iterator>));
+  BOOST_CONCEPT_ASSERT((DataIteratorConcept<MatrixLookupWeighted::const_iterator>));
 
   return suite.return_value();

trunk/yat/normalizer/Gauss.h

@@ -25 +25 @@
 
 #include "Spearman.h"
+#include "yat/utility/concept_check.h"
 #include "yat/utility/iterator_traits.h"
 
@@ -69 +70 @@
                     RandomAccessIter2 result) const
     {
+      BOOST_CONCEPT_ASSERT((utility::DataIteratorConcept<RandomAccessIter1>));
+      BOOST_CONCEPT_ASSERT((utility::DataIteratorConcept<RandomAccessIter2>));
       BOOST_CONCEPT_ASSERT((boost::RandomAccessIterator<RandomAccessIter1>));
       BOOST_CONCEPT_ASSERT((boost::Mutable_RandomAccessIterator<RandomAccessIter2>));

trunk/yat/normalizer/qQuantileNormalizer.h

@@ -25 +25 @@
 
 #include "yat/regression/CSplineInterpolation.h"
+#include "yat/utility/concept_check.h"
 #include "yat/utility/DataIterator.h"
 #include "yat/utility/DataWeight.h"
@@ -258 +259 @@
     BOOST_CONCEPT_ASSERT((boost::RandomAccessIterator<RandomAccessIterator1>));
     BOOST_CONCEPT_ASSERT((boost::Mutable_RandomAccessIterator<RandomAccessIterator2>));
+    BOOST_CONCEPT_ASSERT((utility::DataIteratorConcept<RandomAccessIterator1>));
+    BOOST_CONCEPT_ASSERT((utility::DataIteratorConcept<RandomAccessIterator2>));
     utility::check_iterator_is_unweighted(first);
     utility::check_iterator_is_unweighted(result);
@@ -317 +320 @@
     BOOST_CONCEPT_ASSERT((boost::RandomAccessIterator<RandomAccessIterator1>));
     BOOST_CONCEPT_ASSERT((boost::Mutable_RandomAccessIterator<RandomAccessIterator2>));
+    BOOST_CONCEPT_ASSERT((utility::DataIterator<RandomAccessIterator1>));
+    BOOST_CONCEPT_ASSERT((utility::DataIterator<RandomAccessIterator2>));
     // copy the weights
     detail::copy_weight_if_weighted(first, last, result);
@@ -381 +386 @@
   {
     BOOST_CONCEPT_ASSERT((boost::ForwardIterator<ForwardIterator>));
+    BOOST_CONCEPT_ASSERT((utility::DataIterator<ForwardIterator>));
     build(first, last, N, 
           typename utility::weighted_iterator_traits<ForwardIterator>::type());

trunk/yat/statistics/Histogram.h

@@ -28 +28 @@
 
 #include "AveragerWeighted.h"
+#include "yat/utility/concept_check.h"
 #include "yat/utility/iterator_traits.h"
 
@@ -222 +223 @@
   {
     BOOST_CONCEPT_ASSERT((boost::ForwardIterator<ForwardIterator>));
+    BOOST_CONCEPT_ASSERT((utility::DataIteratorConcept<ForwardIterator>));
     utility::iterator_traits<ForwardIterator> traits;
     while (first!=last) {

trunk/yat/statistics/Percentiler.h

@@ -24 +24 @@
 */
 
+#include "yat/utility/concept_check.h"
 #include "yat/utility/DataWeight.h"
 #include "yat/utility/iterator_traits.h"
@@ -97 +98 @@
     {
       BOOST_CONCEPT_ASSERT((boost::RandomAccessIterator<RandomAccessIterator>));
+      BOOST_CONCEPT_ASSERT((utility::DataIteratorConcept<RandomAccessIterator>));
       return calculate(first, last, sorted_, 
        typename utility::weighted_iterator_traits<RandomAccessIterator>::type());

trunk/yat/statistics/utility.h

@@ -31 +31 @@
 #include "yat/classifier/DataLookupWeighted1D.h"
 #include "yat/classifier/Target.h"
+#include "yat/utility/concept_check.h"
 #include "yat/utility/deprecate.h"
 #include "yat/utility/iterator_traits.h"
 #include "yat/utility/VectorBase.h"
 #include "yat/utility/yat_assert.h"
+
+#include <boost/concept_check.hpp>
 
 #include <algorithm>
@@ -202 +205 @@
              bool sorted)
   {
+    BOOST_CONCEPT_ASSERT((boost::RandomAccessIterator<RandomAccessIterator>));
+    BOOST_CONCEPT_ASSERT((utility::DataIteratorConcept<RandomAccessIterator>));
     double m = median(first, last, sorted);
     typedef typename std::iterator_traits<RandomAccessIterator>::value_type T;
@@ -232 +237 @@
   {
     BOOST_CONCEPT_ASSERT((boost::RandomAccessIterator<RandomAccessIterator>));
+    BOOST_CONCEPT_ASSERT((utility::DataIteratorConcept<RandomAccessIterator>));
     // range is one value only is a special case
     if (first+1 == last)

trunk/yat/utility/concept_check.h

@@ -22 +22 @@
   along with yat. If not, see <http://www.gnu.org/licenses/>.
 */
+
+#include "iterator_traits.h"
 
 #include <boost/concept_check.hpp>
@@ -136 +138 @@
   };
 
+
+  /**
+     \brief Concept check for \trivial_iterator
+
+     This class is intended to be used in a <a 
+     href="\boost_url/concept_check/using_concept_check.htm">
+     BOOST_CONCEPT_ASSERT </a>
+
+     \code
+     template<class Iterator>
+     void some_function(const Iterator& it)
+     {
+     BOOST_CONCEPT_ASSERT((TrivialIterator<Iterator>));
+     ...
+     }
+     \endcode
+  */
+  template <class T>
+  class TrivialIterator
+    : public boost::Assignable<T>
+    , public boost::EqualityComparable<T>
+    , public boost::DefaultConstructible<T>
+
+  {
+  public:
+    /// iterator_category
+    typedef typename std::iterator_traits<T>::iterator_category iterator_category;
+    /// value_type
+    typedef typename std::iterator_traits<T>::value_type value_type;
+    /// difference_type
+    typedef typename std::iterator_traits<T>::difference_type difference_type;
+    /// pointer
+    typedef typename std::iterator_traits<T>::pointer pointer;
+    /// reference
+    typedef typename std::iterator_traits<T>::reference reference;
+
+    /**
+       \brief function doing the concept test
+     */
+    BOOST_CONCEPT_USAGE(TrivialIterator)
+    {
+      T t;
+      value_ = *t;
+    }
+  private:
+    value_type value_;
+  };
+
+  /**
+     \brief Concept check for \ref concept_data_iterator
+
+     This class is intended to be used in a <a 
+     href="\boost_url/concept_check/using_concept_check.htm">
+     BOOST_CONCEPT_ASSERT </a>
+
+     \code
+     template<class Iterator>
+     void some_function(const Iterator& it)
+     {
+     BOOST_CONCEPT_ASSERT((DataIteratorConcept<Iterator>));
+     ...
+     }
+     \endcode
+  */
+  template <class T>
+  class DataIteratorConcept
+  {
+  public:
+    /// tag
+    typedef typename weighted_iterator_traits<T>::type tag;
+    /// value_type
+    typedef typename std::iterator_traits<T>::value_type value_type;
+
+    /**
+       \brief function doing the concept test
+     */
+    BOOST_CONCEPT_USAGE(DataIteratorConcept)
+    {
+      BOOST_CONCEPT_ASSERT((TrivialIterator<T>));
+      tag t;
+      constraints(t);
+    }
+  private:
+    void constraints(yat::utility::unweighted_iterator_tag t) const
+    { 
+      BOOST_CONCEPT_ASSERT((boost::Convertible<value_type, double>));
+    }
+
+    void constraints(yat::utility::weighted_iterator_tag t) const
+    {
+      BOOST_CONCEPT_ASSERT((boost::Convertible<value_type, DataWeight>));
+    }
+
+  };
+
 }}} // of namespace utility, yat, and theplu
 #endif