org.terrier.structures.bit

Class InvertedIndex

java.lang.Object

org.terrier.structures.bit.BitPostingIndex

org.terrier.structures.bit.InvertedIndex

All Implemented Interfaces:

Closeable, AutoCloseable, PostingIndex<BitIndexPointer>

Direct Known Subclasses:

BlockInvertedIndex

Deprecated.

public class InvertedIndex
extends BitPostingIndex

This class implements the inverted index for performing retrieval, with field information optionally.

Author:

Douglas Johnson, Vassilis Plachouras, Craig Macdonald

Nested Class Summary

Nested classes/interfaces inherited from interface org.terrier.structures.PostingIndex

PostingIndex.DocidSpecificDocumentIndex

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentIndex	doi Deprecated.
static double	FIELD_LOAD_FACTOR Deprecated. This is used during retrieval for a rough guess sizing of the temporaryTerms arraylist in getDocuments() - retrieval with Fields.
protected static org.apache.log4j.Logger	logger Deprecated. The logger used for the Lexicon
static double	NORMAL_LOAD_FACTOR Deprecated. This is used during retrieval for a rough guess sizing of the temporaryTerms arraylist in getDocuments().

Fields inherited from class org.terrier.structures.bit.BitPostingIndex

fieldCount, file, index, postingConstructor, postingImplementation

Constructor Summary

Constructors

Constructor and Description
InvertedIndex(IndexOnDisk index, String structureName) Deprecated. Construct an instance of the class with
InvertedIndex(IndexOnDisk index, String structureName, DocumentIndex _doi) Deprecated. Construct an instance of the class with
InvertedIndex(IndexOnDisk index, String structureName, DocumentIndex _doi, Class<? extends IterablePosting> postingClass) Deprecated. Construct an instance of the class with

Method Summary

Methods

Modifier and Type	Method and Description
BitInSeekable[]	getBitFiles() Deprecated. Get the BitFiles
int[][]	getDocuments(BitIndexPointer pointer) Deprecated. Get the documents for for the posting list using the pointer given
int[][]	getDocuments(LexiconEntry le) Deprecated. Get the documents for the specified term (lexicon entry for the term)
IterablePosting	getPostings(Pointer pointer) Deprecated. Get the posting given a pointer
void	print() Deprecated. Print out the Inverted Index

Methods inherited from class org.terrier.structures.bit.BitPostingIndex

close, setPostingImplementation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final org.apache.log4j.Logger logger

Deprecated.

The logger used for the Lexicon

NORMAL_LOAD_FACTOR

public static final double NORMAL_LOAD_FACTOR

Deprecated.

This is used during retrieval for a rough guess sizing of the temporaryTerms arraylist in getDocuments(). The higher this value, the less chance that the arraylist will have to be grown (growing is expensive), however more memory may be used unnecessarily.

See Also:

Constant Field Values

FIELD_LOAD_FACTOR

public static final double FIELD_LOAD_FACTOR

Deprecated.

This is used during retrieval for a rough guess sizing of the temporaryTerms arraylist in getDocuments() - retrieval with Fields. The higher this value, the less chance that the arraylist will have to be grown (growing is expensive), however more memory may be used unnecessarily.

See Also:

Constant Field Values

doi

protected DocumentIndex doi

Deprecated.

Constructor Detail

InvertedIndex

public InvertedIndex(IndexOnDisk index,
             String structureName)
              throws IOException

Deprecated.

Construct an instance of the class with

Parameters:

index -

structureName -

Throws:

IOException

InvertedIndex

public InvertedIndex(IndexOnDisk index,
             String structureName,
             DocumentIndex _doi)
              throws IOException

Deprecated.

Construct an instance of the class with

Parameters:

index -

structureName -

_doi -

Throws:

IOException

InvertedIndex

public InvertedIndex(IndexOnDisk index,
             String structureName,
             DocumentIndex _doi,
             Class<? extends IterablePosting> postingClass)
              throws IOException

Deprecated.

Construct an instance of the class with

Parameters:

index -

structureName -

_doi -

postingClass -

Throws:

IOException

Method Detail

getBitFiles

public BitInSeekable[] getBitFiles()

Deprecated.

Get the BitFiles

print

public void print()

Deprecated.

Print out the Inverted Index

getPostings

public IterablePosting getPostings(Pointer pointer)
                            throws IOException

Deprecated.

Description copied from class: BitPostingIndex

Get the posting given a pointer

Specified by:

getPostings in interface PostingIndex<BitIndexPointer>

Overrides:

getPostings in class BitPostingIndex

Throws:

IOException

getDocuments

public int[][] getDocuments(LexiconEntry le)

Deprecated.

Get the documents for the specified term (lexicon entry for the term)

getDocuments

public int[][] getDocuments(BitIndexPointer pointer)

Deprecated.

Get the documents for for the posting list using the pointer given