## Uses of Class
org.apache.lucene.search.DocIdSetIterator

Packages that use DocIdSetIterator
org.apache.lucene.index: Code to maintain and access indices.
org.apache.lucene.search: Code to search indices.
org.apache.lucene.search.spans: The calculus of spans.
org.apache.lucene.util: Some utility classes.
org.apache.lucene.util.bkd: Block KD-tree, implementing the generic spatial data structure described in this paper.

### Uses of DocIdSetIterator in org.apache.lucene.index

Subclasses of DocIdSetIterator in org.apache.lucene.index
`class` `BinaryDocValues` A per-document numeric value.
`class` `FilterBinaryDocValues` Delegates all methods to a wrapped `BinaryDocValues`.
`static class` `FilterLeafReader.FilterPostingsEnum` Base class for filtering `PostingsEnum` implementations.
`class` `FilterNumericDocValues` Delegates all methods to a wrapped `NumericDocValues`.
`class` `FilterSortedDocValues` Delegates all methods to a wrapped `SortedDocValues`.
`class` `FilterSortedNumericDocValues` Delegates all methods to a wrapped `SortedNumericDocValues`.
`class` `FilterSortedSetDocValues` Delegates all methods to a wrapped `SortedSetDocValues`.
`class` `ImpactsEnum` Extension of `PostingsEnum` which also provides information about upcoming impacts.
`static class` `MultiDocValues.MultiSortedDocValues` Implements SortedDocValues over n subs, using an OrdinalMap
`static class` `MultiDocValues.MultiSortedSetDocValues` Implements MultiSortedSetDocValues over n subs, using an OrdinalMap
`class` `MultiPostingsEnum` Exposes `PostingsEnum`, merged from `PostingsEnum` API of sub-segments.
`class` `NumericDocValues` A per-document numeric value.
`class` `PostingsEnum` Iterates through the postings.
`class` `SlowImpactsEnum` `ImpactsEnum` that doesn't index impacts but implements the API in a legal way.
`class` `SortedDocValues` A per-document byte[] with presorted values.
`class` `SortedNumericDocValues` A list of per-document numeric values, sorted according to `Long.compare(long, long)`.
`class` `SortedSetDocValues` A multi-valued version of `SortedDocValues`.

Methods in org.apache.lucene.index with parameters of type DocIdSetIterator
`default void` PointValues.IntersectVisitor.`visit(DocIdSetIterator iterator, byte[] packedValue)` Similar to `PointValues.IntersectVisitor.visit(int, byte[])` but in this case the packedValue can have more than one docID associated to it.

### Uses of DocIdSetIterator in org.apache.lucene.search

Subclasses of DocIdSetIterator in org.apache.lucene.search
`class` `BlockMaxDISI` `DocIdSetIterator` that skips non-competitive docs by checking the max score of the provided `Scorer` for the current block.
`class` `ConjunctionDISI` A conjunction of DocIdSetIterators.
`class` `DisjunctionDISIApproximation` A `DocIdSetIterator` which is a disjunction of the approximations of the provided iterators.
`class` `FilteredDocIdSetIterator` Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator.
`class` `ImpactsDISI` `DocIdSetIterator` that skips non-competitive docs thanks to the indexed impacts.

Fields in org.apache.lucene.search declared as DocIdSetIterator
`protected DocIdSetIterator` FilteredDocIdSetIterator.`_innerIter`
`DocIdSetIterator` DisiWrapper.`approximation`
`protected DocIdSetIterator` TwoPhaseIterator.`approximation`
`DocIdSetIterator` DisiWrapper.`iterator`

Methods in org.apache.lucene.search that return DocIdSetIterator
`static DocIdSetIterator` DocIdSetIterator.`all(int maxDoc)` A `DocIdSetIterator` that matches all documents up to `maxDoc - 1`.
`DocIdSetIterator` TwoPhaseIterator.`approximation()` Return an approximation.
`static DocIdSetIterator` TwoPhaseIterator.`asDocIdSetIterator(TwoPhaseIterator twoPhaseIterator)` Return a `DocIdSetIterator` view of the provided `TwoPhaseIterator`.
`static DocIdSetIterator` DocIdSetIterator.`empty()` An empty `DocIdSetIterator` instance
`DocIdSetIterator` FilteredDocIdSetIterator.`getDelegate()` Return the wrapped `DocIdSetIterator`.
`static DocIdSetIterator` DocValuesFieldExistsQuery.`getDocValuesDocIdSetIterator(String field, LeafReader reader)` Returns a `DocIdSetIterator` from the given field or null if the field doesn't exist in the reader or if the reader has no doc values for the field.
`static DocIdSetIterator` ConjunctionDISI.`intersectIterators(List<DocIdSetIterator> iterators)` Create a conjunction over the provided DocIdSetIterators.
`static DocIdSetIterator` ConjunctionDISI.`intersectScorers(Collection<Scorer> scorers)` Create a conjunction over the provided `Scorer`s.
`static DocIdSetIterator` ConjunctionDISI.`intersectSpans(List<Spans> spanList)` Create a conjunction over the provided `Spans`.
`abstract DocIdSetIterator` Scorer.`iterator()` Return a `DocIdSetIterator` over matching documents.
`DocIdSetIterator` FilterScorer.`iterator()`
`abstract DocIdSetIterator` DocIdSet.`iterator()` Provides a `DocIdSetIterator` to access the set.
`DocIdSetIterator` ConstantScoreScorer.`iterator()`
`static DocIdSetIterator` DocIdSetIterator.`range(int minDoc, int maxDoc)` A `DocIdSetIterator` that matches a range documents from minDocID (inclusive) to maxDocID (exclusive).

Methods in org.apache.lucene.search with parameters of type DocIdSetIterator
`static TwoPhaseIterator` TwoPhaseIterator.`unwrap(DocIdSetIterator iterator)` If the given `DocIdSetIterator` has been created with `TwoPhaseIterator.asDocIdSetIterator(org.apache.lucene.search.TwoPhaseIterator)`, then this will return the wrapped `TwoPhaseIterator`.

Method parameters in org.apache.lucene.search with type arguments of type DocIdSetIterator
`static DocIdSetIterator` ConjunctionDISI.`intersectIterators(List<DocIdSetIterator> iterators)` Create a conjunction over the provided DocIdSetIterators.

Constructors in org.apache.lucene.search with parameters of type DocIdSetIterator
Constructor and Description
`BlockMaxDISI(DocIdSetIterator iterator, Scorer scorer)`
`ConstantScoreScorer(Weight weight, float score, ScoreMode scoreMode, DocIdSetIterator disi)` Constructor based on a `DocIdSetIterator` which will be used to drive iteration.
`FilteredDocIdSetIterator(DocIdSetIterator innerIter)` Constructor.
`ImpactsDISI(DocIdSetIterator in, ImpactsSource impactsSource, Similarity.SimScorer scorer)` Sole constructor.
`TwoPhaseIterator(DocIdSetIterator approximation)` Takes the approximation to be returned by `TwoPhaseIterator.approximation`.

### Uses of DocIdSetIterator in org.apache.lucene.search.spans

Subclasses of DocIdSetIterator in org.apache.lucene.search.spans
`class` `FilterSpans` A `Spans` implementation wrapping another spans instance, allowing to filter spans matches easily by implementing `FilterSpans.accept(org.apache.lucene.search.spans.Spans)`
`class` `NearSpansOrdered` A Spans that is formed from the ordered subspans of a SpanNearQuery where the subspans do not overlap and have a maximum slop between them.
`class` `NearSpansUnordered` Similar to `NearSpansOrdered`, but for the unordered case.
`class` `Spans` Iterates through combinations of start/end positions per-doc.
`class` `TermSpans` Expert: Public for extension only.

Methods in org.apache.lucene.search.spans that return DocIdSetIterator
`DocIdSetIterator` SpanScorer.`iterator()`

### Uses of DocIdSetIterator in org.apache.lucene.util

Subclasses of DocIdSetIterator in org.apache.lucene.util
`class` `BitSetIterator` A `DocIdSetIterator` which iterates over set bits in a bit set.

Methods in org.apache.lucene.util that return DocIdSetIterator
`DocIdSetIterator` NotDocIdSet.`iterator()`
`DocIdSetIterator` RoaringDocIdSet.`iterator()`
`DocIdSetIterator` BitDocIdSet.`iterator()`

Methods in org.apache.lucene.util with parameters of type DocIdSetIterator
`RoaringDocIdSet.Builder` RoaringDocIdSet.Builder.`add(DocIdSetIterator disi)` Add the content of the provided `DocIdSetIterator`.
`void` DocIdSetBuilder.`add(DocIdSetIterator iter)` Add the content of the provided `DocIdSetIterator` to this builder.
`protected void` BitSet.`checkUnpositioned(DocIdSetIterator iter)` Assert that the current doc is -1.
`static FixedBitSet` BitSetIterator.`getFixedBitSetOrNull(DocIdSetIterator iterator)` If the provided iterator wraps a `FixedBitSet`, returns it, otherwise returns null.
`static SparseFixedBitSet` BitSetIterator.`getSparseFixedBitSetOrNull(DocIdSetIterator iterator)` If the provided iterator wraps a `SparseFixedBitSet`, returns it, otherwise returns null.
`static BitSet` BitSet.`of(DocIdSetIterator it, int maxDoc)` Build a `BitSet` from the content of the provided `DocIdSetIterator`.
`void` FixedBitSet.`or(DocIdSetIterator iter)`
`void` SparseFixedBitSet.`or(DocIdSetIterator it)`
`void` BitSet.`or(DocIdSetIterator iter)` Does in-place OR of the bits provided by the iterator.
`void` FixedBitSet.`xor(DocIdSetIterator iter)` Does in-place XOR of the bits provided by the iterator.

### Uses of DocIdSetIterator in org.apache.lucene.util.bkd

Subclasses of DocIdSetIterator in org.apache.lucene.util.bkd
`protected static class` `BKDReader.BKDReaderDocIDSetIterator` Reusable `DocIdSetIterator` to handle low cardinality leaves.