Changeset 1717 for trunk/yat/normalizer/Spearman.h

Timestamp:

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

Author:

Peter

Message:

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

File:

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

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)