org.deeplearning4j.text.invertedindex

Interface InvertedIndex

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultInvertedIndex, LuceneInvertedIndex

public interface InvertedIndex
extends Serializable

An inverted index for mapping words to documents and documents to words

Method Summary

Modifier and Type	Method and Description
void	addWordsToDoc(int doc, List<VocabWord> words) Adds words to the given document
void	addWordToDoc(int doc, VocabWord word) Add word to a document
Collection<Integer>	allDocs() Returns a list of all documents
List<VocabWord>	document(int index) Returns a list of words for a document
List<Integer>	documents(VocabWord vocabWord) Returns the list of documents a vocab word is in
void	finish() Finishes saving data
int	numDocuments() Returns the number of documents

Method Detail

document

List<VocabWord> document(int index)

Returns a list of words for a document

Parameters:

index -

Returns:

documents

List<Integer> documents(VocabWord vocabWord)

Returns the list of documents a vocab word is in

Parameters:

vocabWord - the vocab word to get documents for

Returns:

the documents for a vocab word

numDocuments

int numDocuments()

Returns the number of documents

Returns:

allDocs

Collection<Integer> allDocs()

Returns a list of all documents

Returns:

the list of all documents

addWordToDoc

void addWordToDoc(int doc,
                  VocabWord word)

Add word to a document

Parameters:

doc - the document to add to

word - the word to add

addWordsToDoc

void addWordsToDoc(int doc,
                   List<VocabWord> words)

Adds words to the given document

Parameters:

doc - the document to add to

words - the words to add

finish

void finish()

Finishes saving data