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 .
*/
import java.util.Comparator;
/**
* Heap class that is bounded in size from the top. It will keep the bottom
* {@code k} Elements only.
*
* @author Erich Schubert
*
* @param Element type. Should be {@link Comparable} or a {@link Comparator}
* needs to be given.
*/
public class TopBoundedHeap extends Heap {
/**
* Maximum size.
*/
protected int maxsize;
/**
* Constructor with maximum size only.
*
* @param maxsize Maximum size
*/
public TopBoundedHeap(int maxsize) {
this(maxsize, null);
}
/**
* Constructor with maximum size and {@link Comparator}.
*
* @param maxsize Maximum size
* @param comparator Comparator
*/
public TopBoundedHeap(int maxsize, Comparator super E> comparator) {
super(maxsize + 1, comparator);
this.maxsize = maxsize;
assert (maxsize > 0);
}
@Override
public void add(E e) {
if (super.size() < maxsize) {
// Just offer.
super.add(e);
return;
}
// Peek at the top element, return if we are worse.
final int comp;
if (comparator == null) {
@SuppressWarnings("unchecked")
Comparable