Apache Lucene.Net 2.4.0 Class Library API

ScorerDocQueue Methods

The methods of the ScorerDocQueue class are listed below. For a complete list of ScorerDocQueue class members, see the ScorerDocQueue Members topic.

Public Instance Methods

AdjustTopShould be called when the scorer at top changes doc() value. 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 ScorerDocQueue.
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 a Scorer to the ScorerDocQueue in log(size) time if either the ScorerDocQueue is not full, or not lessThan(scorer, top()).
PopRemoves and returns the least scorer of the ScorerDocQueue in log(size) time. Should not be used when the queue is empty.
Put Adds a Scorer to a ScorerDocQueue in log(size) time. If one tries to add more Scorers than maxSize a SystemException (ArrayIndexOutOfBound) is thrown.
SizeReturns the number of scorers currently stored in the ScorerDocQueue.
TopReturns the least Scorer of the ScorerDocQueue in constant time. Should not be used when the queue is empty.
TopDocReturns document number of the least Scorer of the ScorerDocQueue in constant time. Should not be used when the queue is empty.
TopNextAndAdjustElsePop 
TopScore 
TopSkipToAndAdjustElsePop 
ToString (inherited from Object)Returns a String that represents the current Object.

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.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

ScorerDocQueue Class | Lucene.Net.Util Namespace