Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/normalizer/Zscore.h

    r1575 r1717  
    55
    66/*
    7   Copyright (C) 2008 Peter Johansson
     7  Copyright (C) 2008, 2009 Peter Johansson
    88
    99  This file is part of the yat library, http://dev.thep.lu.se/yat
     
    3535     \brief Zero mean and unity variance
    3636
    37      Create a range that has zero mean and unity variance
     37     Shift and scale the values in a range as: \f$ y_i =
     38     \frac{x_i-m}{s} \f$ where \a m is the mean and \a s is the
     39     standard deviation. After normalization, the range will have zero
     40     mean and unity variance.
    3841
    3942     \since New in yat 0.5
     
    4447    /**
    4548       The element in range [result, result + (last-first)) is
    46        calculated as result[i] = (first[i] - m) / std where m and std
     49       calculated as result[i] = (first[i] - m) / s where m and std
    4750       are the mean and standard deviation, respectively, of the range
    4851       [first, last).
Note: See TracChangeset for help on using the changeset viewer.