Changeset 1717

Timestamp:

Jan 13, 2009, 11:32:00 PM (14 years ago)

Author:

Peter

Message:

improved(?) docs. Moved some docs from operator() to class docs.

Location:

trunk/yat/normalizer

Files:

• Centralizer.h (modified) (3 diffs)
• Gauss.h (modified) (3 diffs)
• Spearman.h (modified) (3 diffs)
• Zscore.h (modified) (3 diffs)

trunk/yat/normalizer/Centralizer.h

@@ -5 +5 @@
 
 /*
-  Copyright (C) 2008 Peter Johansson
+  Copyright (C) 2008, 2009 Peter Johansson
 
   This file is part of the yat library, http://dev.thep.lu.se/yat
@@ -52 +52 @@
        \brief default constructor
 
-       Creates a UnaryFunction using default constructor.
+       Internal UnaryFunction is created using its default
+       constructor.
      */
     Centralizer(void){}
@@ -70 +71 @@
        It is possible to centralize a range "in place"; it is
        permissible for the iterators \a first and \a result to be the
-       same. \see std::transform
+       same. 
+
+       \see std::transform
 
        \return result + (last-first)

trunk/yat/normalizer/Gauss.h

@@ -5 +5 @@
 
 /*
-  Copyright (C) 2008 Peter Johansson
+  Copyright (C) 2008, 2009 Peter Johansson
 
   This file is part of the yat library, http://dev.thep.lu.se/yat
@@ -35 +35 @@
      \brief Gaussian Normalizer
 
+     After normalization the range will follow a standard Gaussian
+     distribution (mean zero and unity variance).
+     
+     The range is first rank normalized using Spearman, after which
+     each element is between 0 and unity. Second each element is
+     replaced by inverse cumulative standard Gaussian distribution.
+     
      \since New in yat 0.5
    */
@@ -44 +51 @@
        permissible for the iterators \a first and \a result to be the
        same.
-
-       The range is first rank normalized using Spearman, after which
-       each element is between 0 and unity. Second each element is
-       replaced by inverse cumulative standard Gaussian distribution.
-       
-       After normalization the range will follow a standard Gaussian
-       distribution (mean zero and unity variance).
 
        \see gsl_cdf_ugaussian_Pinv

trunk/yat/normalizer/Spearman.h

@@ -5 +5 @@
 
 /*
-  Copyright (C) 2008 Peter Johansson
+  Copyright (C) 2008, 2009 Peter Johansson
 
   This file is part of the yat library, http://dev.thep.lu.se/yat
@@ -39 +39 @@
      \brief Replace elements with normalized rank
 
+     Each element x is replaced by \f$ \frac{\sum I(x_i-x) w_i}{\sum
+     w_i} \f$ where \f$ I(x) = 1 \f$ for \f$ x>0 \f$, \f$I(x) = 0.5
+     \f$ for \f$ x=0 \f$, and \f$ I(x) = 0 \f$ for \f$ x<0 \f$.
+
      \since New in yat 0.5
    */
@@ -53 +57 @@
        permissible for the iterators \a first and \a result to be the
        same.
-
-       Each element x is replaced by \f$ \frac{\sum I(x_i-x)
-       w_i}{\sum w_i} \f$ where I(x) = 1 for x>0, I(x) = 0.5 for x=0,
-       and I(x) = 0 for x<0.
 
        \return result + (last-first)

trunk/yat/normalizer/Zscore.h

@@ -5 +5 @@
 
 /*
-  Copyright (C) 2008 Peter Johansson
+  Copyright (C) 2008, 2009 Peter Johansson
 
   This file is part of the yat library, http://dev.thep.lu.se/yat
@@ -35 +35 @@
      \brief Zero mean and unity variance
 
-     Create a range that has zero mean and unity variance
+     Shift and scale the values in a range as: \f$ y_i =
+     \frac{x_i-m}{s} \f$ where \a m is the mean and \a s is the
+     standard deviation. After normalization, the range will have zero
+     mean and unity variance.
 
      \since New in yat 0.5
@@ -44 +47 @@
     /**
        The element in range [result, result + (last-first)) is
-       calculated as result[i] = (first[i] - m) / std where m and std
+       calculated as result[i] = (first[i] - m) / s where m and std
        are the mean and standard deviation, respectively, of the range
        [first, last).