Apache Lucene.Net 2.4.0 Class Library API

PriorityQueue Members

PriorityQueue overview

Public Instance Methods

AdjustTopShould be called when the object at top changes values. Still log(n) worst case, but it's at least twice as fast to
 { pq.top().change(); pq.adjustTop(); } 
instead of
 { o = pq.pop(); o.change(); pq.push(o); } 
ClearRemoves all entries from the PriorityQueue.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
Insert Adds element to the PriorityQueue in log(size) time if either the PriorityQueue is not full, or not lessThan(element, top()).
InsertWithOverflow insertWithOverflow() is the same as insert() except its return value: it returns the object (if any) that was dropped off the heap because it was full. This can be the given parameter (in case it is smaller than the full heap's minimum, and couldn't be added), or another object that was previously the smallest value in the heap and now has been replaced by a larger one, or null if the queue wasn't yet full with maxSize elements.
LessThanDetermines the ordering of objects in this priority queue. Subclasses must define this one method.
PopRemoves and returns the least element of the PriorityQueue in log(size) time.
Put Adds an object to a PriorityQueue in log(size) time. If one tries to add more objects than maxSize from initialize a RuntimeException (ArrayIndexOutOfBound) is thrown.
SizeReturns the number of elements currently stored in the PriorityQueue.
TopReturns the least element of the PriorityQueue in constant time.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Constructors

PriorityQueue Constructor Initializes a new instance of the PriorityQueue class.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
InitializeSubclass constructors must call this.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

Protected Internal Instance Fields

heap 

See Also

PriorityQueue Class | Lucene.Net.Util Namespace