Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Spatial.Util.FixedBitSet.FixedBitSetIterator Class Reference

A FixedBitSet Iterator implementation More...

Inherits Lucene.Net.Search.DocIdSetIterator.

Public Member Functions

 FixedBitSetIterator (FixedBitSet bitset)
 
override int DocID ()
 Returns the following:


 
override int NextDoc ()
 Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.

 
override int Advance (int target)
 Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or NO_MORE_DOCS if there are no more docs in the set. Behaves as if written:
 

Additional Inherited Members

- Static Public Attributes inherited from Lucene.Net.Search.DocIdSetIterator
static readonly int NO_MORE_DOCS = System.Int32.MaxValue
 When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator.
 

Detailed Description

A FixedBitSet Iterator implementation

Definition at line 419 of file FixedBitSet.cs.

Constructor & Destructor Documentation

Lucene.Net.Spatial.Util.FixedBitSet.FixedBitSetIterator.FixedBitSetIterator ( FixedBitSet  bitset)

Definition at line 424 of file FixedBitSet.cs.

Member Function Documentation

override int Lucene.Net.Spatial.Util.FixedBitSet.FixedBitSetIterator.Advance ( int  target)
virtual

Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or NO_MORE_DOCS if there are no more docs in the set. Behaves as if written:

int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }

Some implementations are considerably more efficient than that.

NOTE: certain implemenations may return a different value (each time) if called several times in a row with the same target.

NOTE: this method may be called with NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

<since>2.9</since>

Implements Lucene.Net.Search.DocIdSetIterator.

Definition at line 444 of file FixedBitSet.cs.

override int Lucene.Net.Spatial.Util.FixedBitSet.FixedBitSetIterator.DocID ( )
virtual

Returns the following:

Implements Lucene.Net.Search.DocIdSetIterator.

Definition at line 429 of file FixedBitSet.cs.

override int Lucene.Net.Spatial.Util.FixedBitSet.FixedBitSetIterator.NextDoc ( )
virtual

Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.

Implements Lucene.Net.Search.DocIdSetIterator.

Definition at line 434 of file FixedBitSet.cs.


The documentation for this class was generated from the following file: