source: trunk/yat/classifier/KNN_ReciprocalRank.h

Last change on this file was 2986, checked in by Peter, 9 years ago

merge 0.10-stable branch into trunk

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 1.8 KB
Line 
1#ifndef theplu_yat_classifier_knn_reciprocal_rank_h
2#define theplu_yat_classifier_knn_reciprocal_rank_h
3
4// $Id: KNN_ReciprocalRank.h 2986 2013-02-18 08:07:44Z peter $
5
6/*
7  Copyright (C) 2008 Jari Häkkinen, Peter Johansson, Markus Ringnér
8  Copyright (C) 2013 Jari Häkkinen
9
10  This file is part of the yat library, http://dev.thep.lu.se/yat
11
12  The yat library is free software; you can redistribute it and/or
13  modify it under the terms of the GNU General Public License as
14  published by the Free Software Foundation; either version 3 of the
15  License, or (at your option) any later version.
16
17  The yat library is distributed in the hope that it will be useful,
18  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20  General Public License for more details.
21
22  You should have received a copy of the GNU General Public License
23  along with yat. If not, see <http://www.gnu.org/licenses/>.
24*/
25
26#include <cstddef>
27#include <vector>
28
29namespace theplu {
30namespace yat {
31 
32  namespace utility {
33    class VectorBase;
34    class VectorMutable;
35  }
36
37namespace classifier {
38
39  class Target;
40 
41
42  ///
43  /// @brief A model of the concept \ref concept_neighbor_weighting to
44  /// be used with KNN to weight the votes of the k nearest neighbors
45  /// of a sample.
46  ///
47  /// KNN_ReciprocalRank weights the vote of a nearest neighbor with
48  /// its reciprocal rank. The class of the nearest neighbor gets
49  /// the vote 1/1, the class of the second nearest neighbor gets the
50  /// vote 1/2, and so on
51  ///
52  struct KNN_ReciprocalRank
53  {   
54    /**
55       The total vote for each class is calculated and returned in prediction.
56    */
57    void operator()(const utility::VectorBase& distance,
58                    const std::vector<size_t>& k_sorted,
59                    const Target& target, 
60                    utility::VectorMutable& prediction) const;   
61  };
62
63}}} // of namespace classifier, yat, and theplu
64   
65#endif
Note: See TracBrowser for help on using the repository browser.