Changeset 2141

Timestamp:

Jan 12, 2010, 11:03:32 PM (12 years ago)

Author:

Peter

Message:

adding concept Data Iterator. fixes #514

Location:

trunk

Files:

• doc/concepts.doxygen (modified) (3 diffs)
• yat/normalizer/qQuantileNormalizer.h (modified) (3 diffs)
• yat/statistics/utility.h (modified) (2 diffs)

trunk/doc/concepts.doxygen

@@ -2 +2 @@
 //
 // Copyright (C) 2008 Jari Häkkinen, Peter Johansson, Markus Ringnér
-// Copyright (C) 2009 Peter Johansson
+// Copyright (C) 2009, 2010 Peter Johansson
 //
 // This file is part of the yat library, http://dev.thep.lu.se/yat
@@ -26 +26 @@
 
 - \subpage concept_container_2d
+- \subpage concept_data_iterator
 - \subpage concept_distance
 - \subpage concept_mutable_container_2d
@@ -426 +427 @@
 
 */
+
+/**
+\page concept_data_iterator Data Iterator
+
+\section Description
+
+\ref concept_data_iterator is an iterator that comes in two shapes: 
+
+  - it is either a \ref concept_weighted_iterator with value type
+convertible to theplu::yat::utility::DataWeight
+  - it is an unweighted iterator with value type
+convertible to \c double.
+
+\section Implementations
+
+Examples of concept \ref concept_data_iterator include:
+  - theplu::yat::utility::Matrix::iterator,
+  - theplu::yat::classifier::MatrixLookup::const_iterator,
+  - theplu::yat::classifier::MatrixLookupWeighted::const_iterator
+*/

trunk/yat/normalizer/qQuantileNormalizer.h

@@ -4 +4 @@
 /*
   Copyright (C) 2009 Jari Häkkinen, Peter Johansson
+  Copyright (C) 2010 Peter Johansson
 
   This file is part of the yat library, http://dev.thep.lu.se/yat
@@ -106 +107 @@
        \b Type \b Requirements:
        - \c ForwardIterator is a model of \forward_iterator.
-       - \c ForwardIterator is either a \ref concept_weighted_iterator
-         or unweighted with value type convertible to \c double.
-
+       - \c ForwardIterator is a \ref concept_data_iterator
     */
     template<typename ForwardIterator>
@@ -130 +129 @@
        \b Type Requirements:
        - \c RandomAccessIterator1 is a model of \random_access_iterator
-       - \c RandomAccessIterator1 is either a \ref
-         concept_weighted_iterator or unweighted with value type
-         convertible to \c double.
+       - \c RandomAccessIterator1 is a \ref concept_data_iterator
        - \c RandomAccessIterator1's value type is convertible to
          \c RandomAccessIterator2's value type

trunk/yat/statistics/utility.h

@@ -9 +9 @@
   Copyright (C) 2006 Jari Häkkinen, Peter Johansson, Markus Ringnér
   Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
-  Copyright (C) 2009 Peter Johansson
+  Copyright (C) 2009, 2010 Peter Johansson
 
   This file is part of the yat library, http://dev.thep.lu.se/yat
@@ -120 +120 @@
   /// can be const_iterators.
   ///
-  /// Requirements: \c T should either be unweighted with value type
-  /// convertible to \c double or \c T should be weighted with value
-  /// type convertible to utility::DataWeight
+  /// Requirements: \c T should be a \ref concept_data_iterator
   ///
   /// @return median of range