Ignore:
Timestamp:
Jan 15, 2009, 10:15:26 PM (12 years ago)
Author:
Jari Häkkinen
Message:

Fixes #476. Improved estimate() doc and added test on estimate() return value.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/utility/WeNNI.h

    r1725 r1726  
    6262          const unsigned int neighbours);
    6363
    64     ///
    65     /// Perform WeNNI on data in \a matrix with continuous uncertainty
    66     /// weights in \a weight using \a neighbours for the new impute
    67     /// value.
    68     ///
     64    /**
     65       \brief Function doing WeNNI imputation.
     66
     67       Perform WeNNI on data in \a matrix with continuous uncertainty
     68       weights in \a weight using \a neighbours for the new impute
     69       value.
     70
     71       The return value can be used as an indication of how well the
     72       imputation worked. The return value should be zero if proper
     73       pre-processing of data is done. An example of bad data is a
     74       matrix with a column of zero weights, another is a
     75       corresponding situation with a row with all weights zero.
     76
     77       \return The number of rows that have at least one value not
     78       imputed.
     79    */
    6980    unsigned int estimate(void);
    7081
Note: See TracChangeset for help on using the changeset viewer.