SHOGUN  6.1.3
KNNHeap.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) The Shogun Machine Learning Toolbox
3  * Written (w) 2014 Parijat Mazumdar
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * The views and conclusions contained in the software and documentation are those
27  * of the authors and should not be interpreted as representing official policies,
28  * either expressed or implied, of the Shogun Development Team.
29  */
30 
31 #ifndef _KNNHEAP_H__
32 #define _KNNHEAP_H__
33 
34 #include <shogun/lib/config.h>
35 
36 #include <shogun/lib/SGVector.h>
37 
38 namespace shogun
39 {
40 
47 class CKNNHeap
48 {
49 public:
54  CKNNHeap(int32_t k=1);
55 
57  ~CKNNHeap() { };
58 
64  void push(index_t index, float64_t dist);
65 
70  float64_t get_max_dist() { return m_dists[0]; }
71 
76  index_t get_max_index() { return m_inds[0]; }
77 
83 
89 
90 private:
92  SGVector<float64_t> m_dists;
93 
95  SGVector<index_t> m_inds;
96 
98  int32_t m_capacity;
99 
101  bool m_sorted;
102 };
103 }
104 #endif /* KNNHEAP */
void push(index_t index, float64_t dist)
Definition: KNNHeap.cpp:51
SGVector< index_t > get_indices()
Definition: KNNHeap.cpp:123
int32_t index_t
Definition: common.h:72
double float64_t
Definition: common.h:60
CKNNHeap(int32_t k=1)
Definition: KNNHeap.cpp:37
index_t get_max_index()
Definition: KNNHeap.h:76
all of classes and functions are contained in the shogun namespace
Definition: class_list.h:18
SGVector< float64_t > get_dists()
Definition: KNNHeap.cpp:100
float64_t get_max_dist()
Definition: KNNHeap.h:70
This class implements a specialized version of max heap structure. This heap specializes in storing t...
Definition: KNNHeap.h:47

SHOGUN Machine Learning Toolbox - Documentation