Changeset 1717 for trunk/yat/normalizer/Zscore.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/Zscore.h (modified) (3 diffs)

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).