The FieldSortedHitQueue type exposes the following members.

Constructors

  NameDescription
Public methodFieldSortedHitQueue
Creates a hit queue sorted by the given list of fields.

Methods

  NameDescription
Public methodAdd
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.)
Public methodAdjustTop 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
            pq.top().change();
            pq.adjustTop();
            
instead of
            o = pq.pop();
            o.change();
            pq.push(o);
            
(Inherited from PriorityQueue.)
Public methodClear
Removes all entries from the PriorityQueue.
(Inherited from PriorityQueue.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetMaxScore
returns the maximum score encountered by elements inserted via insert()
Protected methodGetSentinelObject
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.
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.
(Inherited from PriorityQueue.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInitialize
Subclass constructors must call this.
(Inherited from PriorityQueue.)
Public methodInsert(Object) Obsolete. (Overrides PriorityQueue..::..Insert(Object).)
Public methodInsert(FieldDoc)
Public methodInsertWithOverflow (Overrides PriorityQueue..::..InsertWithOverflow(Object).)
Public methodLessThan
Returns whether
CopyC#
a
is less relevant than
CopyC#
b
.
(Overrides PriorityQueue..::..LessThan(Object, Object).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPop
Removes and returns the least element of the PriorityQueue in log(size) time.
(Inherited from PriorityQueue.)
Public methodPut 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.)
Public methodSize
Returns the number of elements currently stored in the PriorityQueue.
(Inherited from PriorityQueue.)
Public methodTop
Returns the least element of the PriorityQueue in constant time.
(Inherited from PriorityQueue.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodUpdateTop
Should 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.updateTop();
            
instead of
            o = pq.pop();
            o.change();
            pq.push(o);
            
(Inherited from PriorityQueue.)

Fields

  NameDescription
Protected fieldcomparators
Stores a comparator corresponding to each field being sorted by
Protected fieldfields
Stores the sort criteria being used.
Protected fieldheap (Inherited from PriorityQueue.)
Protected fieldmaxscore
Stores the maximum score value encountered, needed for normalizing.

See Also