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/Spearman.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
     
    3939     \brief Replace elements with normalized rank
    4040
     41     Each element x is replaced by \f$ \frac{\sum I(x_i-x) w_i}{\sum
     42     w_i} \f$ where \f$ I(x) = 1 \f$ for \f$ x>0 \f$, \f$I(x) = 0.5
     43     \f$ for \f$ x=0 \f$, and \f$ I(x) = 0 \f$ for \f$ x<0 \f$.
     44
    4145     \since New in yat 0.5
    4246   */
     
    5357       permissible for the iterators \a first and \a result to be the
    5458       same.
    55 
    56        Each element x is replaced by \f$ \frac{\sum I(x_i-x)
    57        w_i}{\sum w_i} \f$ where I(x) = 1 for x>0, I(x) = 0.5 for x=0,
    58        and I(x) = 0 for x<0.
    5959
    6060       \return result + (last-first)
Note: See TracChangeset for help on using the changeset viewer.