The FieldSortedHitQueue type exposes the following members.
Constructors
Name | Description | |
---|---|---|
FieldSortedHitQueue | Creates a hit queue sorted by the given list of fields. |
Methods
Name | Description | |
---|---|---|
Add | Adds an Object to a PriorityQueue in log(size) time. If one tries to add
more objects than maxSize from initialize an
{@link ArrayIndexOutOfBoundsException} is thrown.
(Inherited from PriorityQueue.) | |
AdjustTop | Obsolete. Should be called when the Object at top changes values. Still log(n) worst
case, but it's at least twice as fast to
(Inherited from PriorityQueue.)pq.top().change(); pq.adjustTop();instead of o = pq.pop(); o.change(); pq.push(o); | |
Clear | Removes all entries from the PriorityQueue. (Inherited from PriorityQueue.) | |
Equals | (Inherited from Object.) | |
Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetMaxScore | returns the maximum score encountered by elements inserted via insert() | |
GetSentinelObject | This method can be overridden by extending classes to return a sentinel
object which will be used by {@link #Initialize(int)} to fill the queue, so
that the code which uses that queue can always assume it's full and only
change the top without attempting to insert any new object. (Inherited from PriorityQueue.)Those sentinel values should always compare worse than any non-sentinel value (i.e., {@link #LessThan(Object, Object)} should always favor the non-sentinel values). By default, this method returns false, which means the queue will not be filled with sentinel values. Otherwise, the value returned will be used to pre-populate the queue. Adds sentinel values to the queue. If this method is extended to return a non-null value, then the following usage pattern is recommended: // extends getSentinelObject() to return a non-null value. PriorityQueue pq = new MyQueue(numHits); // save the 'top' element, which is guaranteed to not be null. MyObject pqTop = (MyObject) pq.top(); <...> // now in order to add a new element, which is 'better' than top (after // you've verified it is better), it is as simple as: pqTop.change(). pqTop = pq.updateTop();NOTE: if this method returns a non-null value, it will be called by {@link #Initialize(int)} {@link #Size()} times, relying on a new object to be returned and will not check if it's null again. Therefore you should ensure any call to this method creates a new instance and behaves consistently, e.g., it cannot return null if it previously returned non-null. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Initialize | Subclass constructors must call this. (Inherited from PriorityQueue.) | |
Insert(Object) | Obsolete. (Overrides PriorityQueue..::..Insert(Object).) | |
Insert(FieldDoc) | ||
InsertWithOverflow | (Overrides PriorityQueue..::..InsertWithOverflow(Object).) | |
LessThan | Returns whether (Overrides PriorityQueue..::..LessThan(Object, Object).)CopyC# a CopyC# b | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Pop | Removes and returns the least element of the PriorityQueue in log(size)
time.
(Inherited from PriorityQueue.) | |
Put | Obsolete. 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.
(Inherited from PriorityQueue.) | |
Size | Returns the number of elements currently stored in the PriorityQueue. (Inherited from PriorityQueue.) | |
Top | Returns the least element of the PriorityQueue in constant time. (Inherited from PriorityQueue.) | |
ToString | (Inherited from Object.) | |
UpdateTop | Should be called when the Object at top changes values. Still log(n) worst
case, but it's at least twice as fast to
(Inherited from PriorityQueue.)pq.top().change(); pq.updateTop();instead of o = pq.pop(); o.change(); pq.push(o); |
Fields
Name | Description | |
---|---|---|
comparators | Stores a comparator corresponding to each field being sorted by | |
fields | Stores the sort criteria being used. | |
heap | (Inherited from PriorityQueue.) | |
maxscore | Stores the maximum score value encountered, needed for normalizing. |