blob: cdcb7d98ef440df07928330b054cadb96aa794be (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
package de.lmu.ifi.dbs.elki.distance.distanceresultlist;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2012
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import de.lmu.ifi.dbs.elki.database.ids.DBIDRef;
import de.lmu.ifi.dbs.elki.database.ids.DistanceDBIDPair;
import de.lmu.ifi.dbs.elki.distance.distancevalue.Distance;
/**
* Interface for kNN heaps.
*
* To instantiate, use: {@link KNNUtil#newHeap}!
*
* @author Erich Schubert
*
* @apiviz.landmark
*
* @apiviz.uses GenericKNNList - - «serializes to»
* @apiviz.uses DoubleDistanceKNNList - - «serializes to»
* @apiviz.composedOf DistanceDBIDPair
*
* @param <D> Distance function
*/
public interface KNNHeap<D extends Distance<D>> {
/**
* Serialize to a {@link GenericKNNList}. This empties the heap!
*
* @return KNNList with the heaps contents.
*/
KNNResult<D> toKNNList();
/**
* Get the K parameter ("maxsize" internally).
*
* @return K
*/
int getK();
/**
* Get the distance to the k nearest neighbor, or maxdist otherwise.
*
* @return Maximum distance
*/
D getKNNDistance();
/**
* Add a distance-id pair to the heap unless the distance is too large.
*
* Compared to the super.add() method, this often saves the pair construction.
*
* @param distance Distance value
* @param id ID number
*/
void add(D distance, DBIDRef id);
/**
* Current size of heap.
*
* @return Heap size
*/
int size();
/**
* Test if the heap is empty.
*
* @return true when empty.
*/
boolean isEmpty();
/**
* Clear the heap.
*/
void clear();
/**
* Poll the <em>largest</em> element from the heap.
*
* This is in descending order because of the heap structure. For a convenient
* way to serialize the heap into a list that you can iterate in ascending
* order, see {@link #toKNNList()}.
*
* @return largest element
*/
DistanceDBIDPair<D> poll();
/**
* Peek at the <em>largest</em> element in the heap.
*
* @return The current largest element.
*/
DistanceDBIDPair<D> peek();
}
|
