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/kNNI.h

    r1487 r1726  
    5757         const unsigned int neighbours);
    5858
    59     ///
    60     /// Perform kNNI on data in \a matrix with binary uncertainty
    61     /// weights in \a weight using \a neighbours for the new impute
    62     /// value.
    63     ///
     59    /**
     60       \brief Function doing kNNI imputation.
     61
     62       Perform kNNI on data in \a matrix with binary uncertainty
     63       weights in \a weight using \a neighbours for the new impute
     64       value.
     65
     66       The return value can be used as an indication of how well the
     67       imputation worked. The return value should be zero if proper
     68       pre-processing of data is done. An example of bad data is a
     69       matrix with a column of zero weights, another is a
     70       corresponding situation with a row with all weights zero.
     71
     72       \return The number of rows that have at least one value not
     73       imputed.
     74    */
    6475    unsigned int estimate(void);
    6576
Note: See TracChangeset for help on using the changeset viewer.