Changeset 2415

Timestamp:

Jan 22, 2011, 7:01:31 AM (12 years ago)

Author:

Peter

Message:

improve Centralizer docs. fixes #652

File:

• trunk/yat/normalizer/Centralizer.h (modified) (3 diffs)

trunk/yat/normalizer/Centralizer.h

@@ -6 +6 @@
 /*
   Copyright (C) 2008 Jari Häkkinen, Peter Johansson
-  Copyright (C) 2009, 2010 Peter Johansson
+  Copyright (C) 2009, 2010, 2011 Peter Johansson
 
   This file is part of the yat library, http://dev.thep.lu.se/yat
@@ -43 +43 @@
      \brief Centralize a range
 
-     The center is calculated and then that value is subtracted from
-     each element. By default the center is defined as the arithmetic
-     mean, but this can be changed by providing a suitable
-     UnaryFunction.
+     The class centralizes a range <tt> [first, last) </tt> in two
+     steps. First, the center value is calculaterd using the functor
+     \c UnaryFunction to calculate the center. Second, the center
+     value is subtracted from each element in range <tt> [first, last)
+     </tt>. \c UnaryFunction must be a functor that has an operator:
 
-     Type Requirements:
-     - InputIterator must be an \input_iterator
-     - ForwardIterator must be a mutable \forward_iterator
+     \code 
+     return_type operator()(InputIterator, InputIterator) const
+     \endcode 
+
+     where \c return_type must be convertible to \c value_type of \c
+     InputIterator. By default the center value is calculated as the
+     arithmetic mean via class statistics::Average, but this can be
+     changed using an alternative functor such as
+     statistics::Percentiler.
 
      \since New in yat 0.5
@@ -82 +89 @@
        same. 
 
+       Type Requirements:
+       - InputIterator must be an \input_iterator
+       - ForwardIterator must be a mutable \forward_iterator
+
        \see std::transform
      */