edu.stanford.nlp.util

Class BoundedPriorityQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.TreeSet<E>

edu.stanford.nlp.util.BoundedPriorityQueue<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.NavigableSet<E>, java.util.Set<E>, java.util.SortedSet<E>

public class BoundedPriorityQueue<E>
extends java.util.TreeSet<E>

A priority queue that has a fixed bounded size. Notice that this class is implemented using a sorted set, which requires consistency between euqals() and compareTo() method. It decides whether two objects are equal based on their compareTo value; in other words, if two objects have the same priority, only one will be stored.

Author:

Mengqiu Wang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BoundedPriorityQueue(int maxSize)
BoundedPriorityQueue(int maxSize, java.util.Comparator<E> comparator)

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
void	clear()

Methods inherited from class java.util.TreeSet

addAll, ceiling, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, spliterator, subSet, subSet, tailSet, tailSet

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

BoundedPriorityQueue

public BoundedPriorityQueue(int maxSize)

BoundedPriorityQueue

public BoundedPriorityQueue(int maxSize,
                            java.util.Comparator<E> comparator)

Method Detail

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>

Overrides:

clear in class java.util.TreeSet<E>

add

public boolean add(E e)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Set<E>

Overrides:

add in class java.util.TreeSet<E>

Returns:

true if element was successfully added, false otherwise