de.lmu.ifi.dbs.elki.utilities.datastructures.heap.IntegerObjectMaxHeap Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elki Show documentation
Show all versions of elki Show documentation
ELKI - Main Module – Open-Source Data-Mining Framework with Index Acceleration
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) 2015
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 .
*/
import java.util.Arrays;
import de.lmu.ifi.dbs.elki.math.MathUtil;
/**
* Binary heap for primitive types.
*
* @author Erich Schubert
* @since 0.6.0
*
* @apiviz.has UnsortedIter
* @param Value type
*/
public class IntegerObjectMaxHeap implements IntegerObjectHeap {
/**
* Base heap.
*/
protected int[] twoheap;
/**
* Base heap values.
*/
protected Object[] twovals;
/**
* Current size of heap.
*/
protected int size;
/**
* Initial size of the 2-ary heap.
*/
private final static int TWO_HEAP_INITIAL_SIZE = (1 << 5) - 1;
/**
* Constructor, with default size.
*/
public IntegerObjectMaxHeap() {
super();
int[] twoheap = new int[TWO_HEAP_INITIAL_SIZE];
Object[] twovals = new Object[TWO_HEAP_INITIAL_SIZE];
this.twoheap = twoheap;
this.twovals = twovals;
}
/**
* Constructor, with given minimum size.
*
* @param minsize Minimum size
*/
public IntegerObjectMaxHeap(int minsize) {
super();
final int size = MathUtil.nextPow2Int(minsize + 1) - 1;
int[] twoheap = new int[size];
Object[] twovals = new Object[size];
this.twoheap = twoheap;
this.twovals = twovals;
}
@Override
public void clear() {
size = 0;
Arrays.fill(twoheap, 0);
Arrays.fill(twovals, null);
}
@Override
public int size() {
return size;
}
@Override
public boolean isEmpty() {
return (size == 0);
}
@Override
public void add(int o, V v) {
final int co = o;
final Object cv = (Object)v;
// System.err.println("Add: " + o);
if (size >= twoheap.length) {
// Grow by one layer.
twoheap = Arrays.copyOf(twoheap, twoheap.length + twoheap.length + 1);
twovals = Arrays.copyOf(twovals, twovals.length + twovals.length + 1);
}
final int twopos = size;
twoheap[twopos] = co;
twovals[twopos] = cv;
++size;
heapifyUp(twopos, co, cv);
}
@Override
public void add(int key, V val, int max) {
if (size < max) {
add(key, val);
} else if (twoheap[0] > key) {
replaceTopElement(key, val);
}
}
@Override
public void replaceTopElement(int reinsert, V val) {
heapifyDown(reinsert, (Object)val);
}
/**
* Heapify-Up method for 2-ary heap.
*
* @param twopos Position in 2-ary heap.
* @param cur Current object
* @param val Current value
*/
private void heapifyUp(int twopos, int cur, Object val) {
while (twopos > 0) {
final int parent = (twopos - 1) >>> 1;
int par = twoheap[parent];
if (cur <= par) {
break;
}
twoheap[twopos] = par;
twovals[twopos] = twovals[parent];
twopos = parent;
}
twoheap[twopos] = cur;
twovals[twopos] = val;
}
@Override
public void poll() {
--size;
// Replacement object:
if (size > 0) {
final int reinsert = twoheap[size];
final Object reinsertv = twovals[size];
twoheap[size] = 0;
twovals[size] = null;
heapifyDown(reinsert, reinsertv);
} else {
twoheap[0] = 0;
twovals[0] = null;
}
}
/**
* Invoke heapify-down for the root object.
*
* @param cur Object to insert.
* @param val Value to reinsert.
*/
private void heapifyDown(int cur, Object val) {
final int stop = size >>> 1;
int twopos = 0;
while (twopos < stop) {
int bestchild = (twopos << 1) + 1;
int best = twoheap[bestchild];
final int right = bestchild + 1;
if (right < size && best < twoheap[right]) {
bestchild = right;
best = twoheap[right];
}
if (cur >= best) {
break;
}
twoheap[twopos] = best;
twovals[twopos] = twovals[bestchild];
twopos = bestchild;
}
twoheap[twopos] = cur;
twovals[twopos] = val;
}
@Override
public int peekKey() {
return twoheap[0];
}
@Override
@SuppressWarnings("unchecked")
public V peekValue() {
return (V)twovals[0];
}
@Override
public String toString() {
StringBuilder buf = new StringBuilder();
buf.append(IntegerObjectMaxHeap.class.getSimpleName()).append(" [");
for (UnsortedIter iter = new UnsortedIter(); iter.valid(); iter.advance()) {
buf.append(iter.getKey()).append(':').append(iter.getValue()).append(',');
}
buf.append(']');
return buf.toString();
}
@Override
public UnsortedIter unsortedIter() {
return new UnsortedIter();
}
/**
* Unsorted iterator - in heap order. Does not poll the heap.
*
* Use this class as follows:
*
*
* {@code
* for (IntegerObjectHeap.UnsortedIter iter = heap.unsortedIter(); iter.valid(); iter.next()) {
* doSomething(iter.get());
* }
* }
*
*
* @author Erich Schubert
*/
private class UnsortedIter implements IntegerObjectHeap.UnsortedIter {
/**
* Iterator position.
*/
protected int pos = 0;
@Override
public boolean valid() {
return pos < size;
}
@Override
public de.lmu.ifi.dbs.elki.utilities.datastructures.iterator.Iter advance() {
pos++;
return this;
}
@Override
public int getKey() {
return twoheap[pos];
}
@SuppressWarnings("unchecked")
@Override
public V getValue() {
return (V)twovals[pos];
}
}
}