Lucene.Net.Util.SortedVIntList Class Reference

Stores and iterate on sorted integers in compressed form in RAM.
The code for compressing the differences between ascending integers was borrowed from Lucene.Net.Store.IndexInput and Lucene.Net.Store.IndexOutput.NOTE: this class assumes the stored integers are doc Ids (hence why it extends DocIdSet). Therefore its Iterator() assumes DocIdSetIterator.NO_MORE_DOCS can be used as sentinel. If you intent to use this value, then make sure it's not used during search flow. More...

Inherits DocIdSet.

Public Member Functions
	SortedVIntList (params int[] sortedInts)
	Create a SortedVIntList from all elements of an array of integers.
	SortedVIntList (int[] sortedInts, int inputSize)
	Create a SortedVIntList from an array of integers.
	SortedVIntList (System.Collections.BitArray bits)
	Create a SortedVIntList from a BitSet.
	SortedVIntList (OpenBitSet bits)
	Create a SortedVIntList from an OpenBitSet.
	SortedVIntList (DocIdSetIterator docIdSetIterator)
	Create a SortedVIntList.
override DocIdSetIterator	Iterator ()

Properties
virtual int	Size [get]
	The total number of sorted integers.
virtual int	ByteSize [get]
	The size of the byte array storing the compressed sorted integers.
override bool	IsCacheable [get]
	This DocIdSet implementation is cacheable.

Detailed Description

Stores and iterate on sorted integers in compressed form in RAM.
The code for compressing the differences between ascending integers was borrowed from Lucene.Net.Store.IndexInput and Lucene.Net.Store.IndexOutput.

NOTE: this class assumes the stored integers are doc Ids (hence why it extends DocIdSet). Therefore its Iterator() assumes DocIdSetIterator.NO_MORE_DOCS can be used as sentinel. If you intent to use this value, then make sure it's not used during search flow.

Definition at line 35 of file SortedVIntList.cs.

Constructor & Destructor Documentation

Lucene.Net.Util.SortedVIntList.SortedVIntList

(

params int[]

sortedInts

)

Create a SortedVIntList from all elements of an array of integers.

Parameters

sortedInts

A sorted array of non negative integers.

Definition at line 119 of file SortedVIntList.cs.

Lucene.Net.Util.SortedVIntList.SortedVIntList	(	int[]	sortedInts,
		int	inputSize
	)

Create a SortedVIntList from an array of integers.

Parameters

sortedInts	An array of sorted non negative integers.
inputSize	The number of integers to be used from the array.

Definition at line 128 of file SortedVIntList.cs.

Lucene.Net.Util.SortedVIntList.SortedVIntList

(

System.Collections.BitArray

bits

)

Create a SortedVIntList from a BitSet.

Parameters

bits	A bit set representing a set of integers.

Definition at line 141 of file SortedVIntList.cs.

Lucene.Net.Util.SortedVIntList.SortedVIntList

(

OpenBitSet

bits

)

Create a SortedVIntList from an OpenBitSet.

Parameters

bits	A bit set representing a set of integers.

Definition at line 156 of file SortedVIntList.cs.

Lucene.Net.Util.SortedVIntList.SortedVIntList

(

DocIdSetIterator

docIdSetIterator

)

Create a SortedVIntList.

Parameters

docIdSetIterator

An iterator providing document numbers as a set of integers. This DocIdSetIterator is iterated completely when this constructor is called and it must provide the integers in non decreasing order.

Definition at line 174 of file SortedVIntList.cs.

Member Function Documentation

override DocIdSetIterator Lucene.Net.Util.SortedVIntList.Iterator

(

)

Returns

An iterator over the sorted integers.

Definition at line 284 of file SortedVIntList.cs.

Property Documentation

virtual int Lucene.Net.Util.SortedVIntList.ByteSize

get

The size of the byte array storing the compressed sorted integers.

Definition at line 272 of file SortedVIntList.cs.

override bool Lucene.Net.Util.SortedVIntList.IsCacheable

get

This DocIdSet implementation is cacheable.

Definition at line 278 of file SortedVIntList.cs.

virtual int Lucene.Net.Util.SortedVIntList.Size

get

The total number of sorted integers.

Definition at line 266 of file SortedVIntList.cs.

---

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

• core/Util/SortedVIntList.cs