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

    r1487 r1726  
    9090    virtual ~NNI(void) {};
    9191
    92     ///
    93     /// Function doing the imputation.
    94     ///
    95     /// @return number of rows not imputed
    96     ///
     92    /**
     93       \brief Function doing the imputation.
     94
     95       The return value can be used as an indication of how well the
     96       imputation worked. The return value should be zero if proper
     97       pre-processing of data is done. An example of bad data is a
     98       matrix with a column of zero weights, another is a
     99       corresponding situation with a row with all weights zero.
     100
     101       \return The number of rows that have at least one value not
     102       imputed.
     103    */
    97104    virtual unsigned int estimate(void)=0;
    98105
Note: See TracChangeset for help on using the changeset viewer.