Changeset 1726 for trunk/yat/utility/kNNI.h

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:

• trunk/yat/utility/kNNI.h (modified) (1 diff)

trunk/yat/utility/kNNI.h

@@ -57 +57 @@
          const unsigned int neighbours);
 
-    ///
-    /// Perform kNNI on data in \a matrix with binary uncertainty
-    /// weights in \a weight using \a neighbours for the new impute
-    /// value.
-    ///
+    /**
+       \brief Function doing kNNI imputation.
+
+       Perform kNNI on data in \a matrix with binary uncertainty
+       weights in \a weight using \a neighbours for the new impute
+       value.
+
+       The return value can be used as an indication of how well the
+       imputation worked. The return value should be zero if proper
+       pre-processing of data is done. An example of bad data is a
+       matrix with a column of zero weights, another is a
+       corresponding situation with a row with all weights zero.
+
+       \return The number of rows that have at least one value not
+       imputed.
+    */
     unsigned int estimate(void);