source: trunk/yat/utility/WeNNI.h @ 1486

Last change on this file since 1486 was 1486, checked in by Jari Häkkinen, 13 years ago

Addresses #436.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.1 KB
Line 
1#ifndef _theplu_yat_utility_wenni_
2#define _theplu_yat_utility_wenni_
3
4// $Id: WeNNI.h 1486 2008-09-09 21:17:19Z jari $
5
6/*
7  Copyright (C) 2004 Jari Häkkinen
8  Copyright (C) 2005 Jari Häkkinen, Peter Johansson
9  Copyright (C) 2006 Jari Häkkinen
10  Copyright (C) 2007 Jari Häkkinen, Peter Johansson
11  Copyright (C) 2008 Peter Johansson
12
13  This file is part of the yat library, http://dev.thep.lu.se/yat
14
15  The yat library is free software; you can redistribute it
16  and/or modify it under the terms of the GNU General Public License
17  as published by the Free Software Foundation; either version 3 of
18  the License, or (at your option) any later version.
19
20  The yat library is distributed in the hope that it will be
21  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
22  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
23  General Public License for more details.
24
25  You should have received a copy of the GNU General Public License
26  along with this program; if not, write to the Free Software
27  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
28  02111-1307, USA.
29*/
30
31#include "NNI.h"
32#include "Matrix.h"
33
34#include <iostream>
35
36namespace theplu {
37namespace yat {
38namespace utility {
39
40  ///
41  /// @brief Weighted Nearest Neighbour Imputation
42  ///
43  /// WeNNI is a continuous weights generalization of the (binary
44  /// weights) kNNI algorithm presented by Troyanskaya et al. A
45  /// reference to this paper is found in the NNI document referred to
46  /// in the NNI class documentation. The NNI document also describes
47  /// WeNNI in depth.
48  ///
49  /// @see NNI and kNNI
50  ///
51  class WeNNI : public NNI
52  {
53  public:
54    ///
55    /// Constructor
56    ///
57    WeNNI(const utility::Matrix& matrix,const utility::Matrix& weight,
58          const unsigned int neighbours);
59
60    ///
61    /// Perform WeNNI on data in \a matrix with continuous uncertainty
62    /// weights in \a weight using \a neighbours for the new impute
63    /// value.
64    ///
65    unsigned int estimate(void);
66
67    ///
68    /// @return A const reference to imputed_data_raw.
69    ///
70    const utility::Matrix& imputed_data_raw(void) const 
71    { return imputed_data_raw_; }
72
73
74  private:
75
76    utility::Matrix imputed_data_raw_;
77  };
78
79}}} // of namespace utility, yat, and theplu
80
81#endif
Note: See TracBrowser for help on using the repository browser.