blob: 3235926beabc0d36bcfb587dc0b640a02c2a51e0 (
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
114
115
116
117
118
119
120
121
122
|
package de.lmu.ifi.dbs.elki.utilities.datastructures.heap;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2013
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.utilities.datastructures.iterator.Iter;
/**
* Basic in-memory heap for int values.
*
* @author Erich Schubert
*
* @apiviz.has UnsortedIter
*/
public interface IntegerHeap {
/**
* Add a key-value pair to the heap
*
* @param key Key
*/
void add(int key);
/**
* Add a key-value pair to the heap, except if the new element is larger than
* the top, and we are at design size (overflow)
*
* @param key Key
* @param max Maximum size of heap
*/
void add(int key, int max);
/**
* Combined operation that removes the top element, and inserts a new element
* instead.
*
* @param e New element to insert
* @return Previous top element of the heap
*/
int replaceTopElement(int e);
/**
* Get the current top key
*
* @return Top key
*/
int peek();
/**
* Remove the first element
*
* @return Top element
*/
int poll();
/**
* Delete all elements from the heap.
*/
void clear();
/**
* Query the size
*
* @return Size
*/
public int size();
/**
* Is the heap empty?
*
* @return {@code true} when the size is 0.
*/
public boolean isEmpty();
/**
* Get an unsorted iterator to inspect the heap.
*
* @return Iterator
*/
UnsortedIter unsortedIter();
/**
* Unsorted iterator - in heap order. Does not poll the heap.
*
* <pre>
* {@code
* for (IntegerHeap.UnsortedIter iter = heap.unsortedIter(); iter.valid(); iter.next()) {
* doSomething(iter.get());
* }
* }
* </pre>
*
* @author Erich Schubert
*/
public static interface UnsortedIter extends Iter {
/**
* Get the iterators current object.
*
* @return Current object
*/
int get();
}
}
|
