source: trunk/yat/utility/kNNI.h @ 1707

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

Addresses #436. GPL license copy reference should also be updated.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 1.9 KB
Line 
1#ifndef _theplu_yat_utility_knni_
2#define _theplu_yat_utility_knni_
3
4// $Id: kNNI.h 1487 2008-09-10 08:41:36Z 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 and/or
16  modify it under the terms of the GNU General Public License as
17  published by the Free Software Foundation; either version 3 of the
18  License, or (at your option) any later version.
19
20  The yat library is distributed in the hope that it will be useful,
21  but WITHOUT ANY WARRANTY; without even the implied warranty of
22  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 yat. If not, see <http://www.gnu.org/licenses/>.
27*/
28
29#include "NNI.h"
30
31#include <iostream>
32#include <vector>
33
34namespace theplu {
35namespace yat {
36namespace utility {
37
38  ///
39  /// @brief kNNimpute
40  ///
41  /// kNNI is the binary weight implementation of NNI. This follows
42  /// the work done by Troyanskaya et al. cited in the NNI document
43  /// referred to in the NNI class documentation.
44  ///
45  /// This is a special case of the WeNNI, but is maintained since it
46  /// is faster than the more general WeNNI.
47  ///
48  /// @see NNI and WeNNI
49  ///
50  class kNNI : public NNI
51  {
52  public:
53    ///
54    /// Constructor
55    ///
56    kNNI(const utility::Matrix& matrix,const utility::Matrix& weight,
57         const unsigned int neighbours);
58
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    ///
64    unsigned int estimate(void);
65
66  private:
67    std::vector<size_t> mv_rows_; // index to rows that have values to estimate
68  };
69
70}}} // of namespace utility, yat, and theplu
71
72#endif
Note: See TracBrowser for help on using the repository browser.