Terrier IR Platform
2.2.1
A B C D E F G H I J K L M N O P Q R S T U V W

S

save() - Method in class uk.ac.gla.terrier.applications.desktop.filehandling.AssociationFileOpener
Saves the used file assocciations to a properties file.
save() - Method in interface uk.ac.gla.terrier.applications.desktop.filehandling.FileOpener
Perform any saving to disk of data the implementor may requires.
save() - Method in class uk.ac.gla.terrier.applications.desktop.filehandling.MacOSXFileOpener
Does nothing, not used
save() - Method in class uk.ac.gla.terrier.applications.desktop.filehandling.WindowsFileOpener
Does nothing, not used
schemes() - Method in interface uk.ac.gla.terrier.utility.io.FileSystem
URI schemes supported by this class
schemes() - Method in class uk.ac.gla.terrier.utility.io.HTTPFileSystem
URI schemes supported by this class: http, ftp, https
schemes() - Method in class uk.ac.gla.terrier.utility.io.LocalFileSystem
 
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.B
This method computes the score for the implemented weighting model.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.BasicModel
This method provides the contract for implementing weighting models.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.BM
This method computes the score for the implemented weighting model.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.Br
This method computes the score for the implemented weighting model.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.IF
This method computes the score for the implemented weighting model.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.In
This method computes the score for the implemented weighting model.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.In_exp
This method computes the score for the implemented weighting model.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.P
This method provides the contract for implementing weighting models.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.BB2
This method provides the contract for implementing weighting models.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.BB2
This method provides the contract for implementing weighting models.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.BM25
Uses BM25 to compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.BM25
Uses BM25 to compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.DFR_BM25
Computes the score according to the model DFR_BM25.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.DFR_BM25
Computes the score according to the model DFR_BM25.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.DFRee
Uses DFRee to compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.DFRee
Uses DFRee to compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel
Compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel
Compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.DLH
Uses DLH to compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.DLH
Uses DLH to compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.DLH13
Uses DLH13 to compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.DLH13
Uses DLH13 to compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.Hiemstra_LM
Uses Hiemestra_LM to compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.Hiemstra_LM
Uses Hiemstra_LM to compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.IFB2
Uses IFB2 to compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.IFB2
Uses IFB2 to compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.In_expB2
This method provides the contract for implementing weighting models.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.In_expB2
This method provides the contract for implementing weighting models.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.In_expC2
Computes the score according to the weighting models In_expC2.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.In_expC2
Computes the score according to the weighting models In_expC2.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.InL2
Computes the score according to the model InL2.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.InL2
Computes the score according to the model InL2.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.LemurTF_IDF
Uses LemurTF_IDF to compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.LemurTF_IDF
Uses LemurTF_IDF to compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.PL2
Uses PL2 to compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.PL2
Uses PL2 to compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.Bo1
This method implements the query expansion model.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.Bo1
This method implements the query expansion model.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.Bo2
This method implements the query expansion model.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.Bo2
This method implements the query expansion model.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.KL
This method implements the query expansion model.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.KL
This method implements the query expansion model.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel
This method provides the contract for implementing query expansion models.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel
This method provides the contract for implementing query expansion models.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.TF_IDF
Uses TF_IDF to compute a weight for a term in a document.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.TF_IDF
Uses TF_IDF to compute a weight for a term in a document.
score(double, double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
This method provides the contract for implementing weighting models.
score(double, double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
This method provides the contract for implementing weighting models.
scoreSeenNonQuery(double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.LanguageModel
The method provides the contract for assgining score for a seen non-query term.
scoreSeenNonQuery(double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.PonteCroft
The method assigns score for a seen non-query term.
scoreSeenQuery(double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.LanguageModel
The method provides the contract for assigning score for a seen query term.
scoreSeenQuery(double, double, double, double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.PonteCroft
The method assigns score for a seen query term.
scoreUnseenNonQuery(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.LanguageModel
The method provides the contract for assigning score for a unseen non-query term.
scoreUnseenNonQuery(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.PonteCroft
The method assigns score for a unseen non-query term.
scoreUnseenQuery(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.LanguageModel
The method provides the contract for assigning score for a unseen query term.
scoreUnseenQuery(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.PonteCroft
The method assigns score for a unseen query term.
SearchRequest - Interface in uk.ac.gla.terrier.querying
SearchRequest is the one of two main classes of which are made available to client code by the Terrier framework at retrieval time.
seek(String) - Method in class uk.ac.gla.terrier.structures.DocIndexEncodedHash
 
seek(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndex
Seeks from the document index the i-th entry.
seek(String) - Method in class uk.ac.gla.terrier.structures.DocumentIndex
Seeks the document index entry for the given document number.
seek(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded
Overrides the seek(int docid) method of the DocumentIndex class.
seek(String) - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded
Overrides the seek(String s) method of the super class.
seek(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndexInMemory
This method overrides the seek(int docid) method of DocumentIndex class.
seek(long) - Method in interface uk.ac.gla.terrier.utility.io.RandomDataInput
Seek to specified position in the file
seekEntry(int) - Method in class uk.ac.gla.terrier.structures.BlockLexicon
Seeks the i-th entry of the lexicon.
seekEntry(int) - Method in class uk.ac.gla.terrier.structures.Lexicon
Seeks the i-th entry of the lexicon.
seekEntry(int) - Method in class uk.ac.gla.terrier.structures.UTFBlockLexicon
Seeks the i-th entry of the lexicon.
seekEntry(int) - Method in class uk.ac.gla.terrier.structures.UTFLexicon
Seeks the i-th entry of the lexicon.
setArray(byte[]) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.WritableByteArray
 
setAverageDocumentLength(double) - Method in interface uk.ac.gla.terrier.matching.Model
Set the average document length in the collection.
setAverageDocumentLength(double) - Method in class uk.ac.gla.terrier.matching.models.aftereffect.AfterEffect
Set the average document length, which is used for computing the prior for the first normalisation.
setAverageDocumentLength(double) - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel
Sets the average length of documents in the collection.
setAverageDocumentLength(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.PonteCroft
 
setAverageDocumentLength(double) - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation
Set the average document length in the collection.
setAverageDocumentLength(double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel
Set the average document length.
setAverageDocumentLength(double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Sets the average length of documents in the collection.
setBF(int) - Method in class uk.ac.gla.terrier.structures.BlockLexiconOutputStream
Sets the block frequency for the given term
setBF(int) - Method in class uk.ac.gla.terrier.structures.UTFBlockLexiconOutputStream
Sets the block frequency for the given term
setBos(BitOut) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.RunsMerger
 
setBreakPoint() - Method in class uk.ac.gla.terrier.utility.TerrierTimer
Compute the processing time.
setChild(Query) - Method in class uk.ac.gla.terrier.querying.parser.Query
Sets the subquery object of this query.
setCollectionLength(double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel
Set the collection length.
setControl(String, String) - Method in class uk.ac.gla.terrier.querying.Request
Set a control named to have value Value.
setControl(String, String) - Method in interface uk.ac.gla.terrier.querying.SearchRequest
Set a control named to have value Value.
setControls(Hashtable<String, String>) - Method in class uk.ac.gla.terrier.querying.Request
Use this hashtable to store controls and their values in
setDebug(boolean) - Method in class uk.ac.gla.terrier.applications.desktop.DesktopTerrier
 
setDefaultProperty(String, String) - Static method in class uk.ac.gla.terrier.utility.ApplicationSetup
set a property value only if it has not already been set
setDf(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.PostingInRun
Setter for the document frequency.
setDocF(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.Posting
Set the document frequency the number of documents this term occurs in.
setDocnoEntryLength(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndex
Set the length of docnos in the index file
setDocnoEntryLength(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndexEncoded
Set the length of docnos in the index file
setDocnoEntryLength(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndexInMemory
Set the length of docnos in the index file
setDocnoEntryLength(int) - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream
Set the length of docnos in the index file
setDocs(MemorySBOS) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.Posting
Sets the document data compressed object.
setDocumentFreq(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.WritableByteArray
 
setDocumentFrequency(double) - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel
Sets the document frequency of the term in the collection.
setDocumentFrequency(double) - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation
 
setDocumentFrequency(double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel
Set the document frequency.
setDocumentFrequency(double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Sets the document frequency of the term in the collection.
setEmpty(boolean) - Method in class uk.ac.gla.terrier.querying.Request
force this query to be seen as containing (no) terms.
setEndBitOffset(byte) - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream
Deprecated.  
setEndOffset(long) - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream
Deprecated.  
setExactResultSize(int) - Method in class uk.ac.gla.terrier.matching.CollectionResultSet
Sets the exact size of the result set, that is the number of documents that would be retrieved, if the result set was not truncated.
setExactResultSize(int) - Method in interface uk.ac.gla.terrier.matching.ResultSet
Sets the exact size of the result set, that is the number of documents that contain at least one query term.
setExtension(String) - Method in class uk.ac.gla.terrier.applications.desktop.filehandling.ApplicationSelector
 
setField(String) - Method in class uk.ac.gla.terrier.querying.parser.FieldQuery
Sets the value of the field.
setFieldWeight(double) - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation
This method sets the weight of a field.
setFlush(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedTerm
 
setFolders(List<String>) - Method in class uk.ac.gla.terrier.applications.desktop.IndexFolders
Sets the list of selected folders.
setGlobalConfiguration(Configuration) - Static method in class uk.ac.gla.terrier.utility.io.HadoopPlugin
 
setIgnoreMissingClosingTags(boolean) - Method in class uk.ac.gla.terrier.indexing.TRECFullTokenizer
Sets the value of the ignoreMissingClosingTags.
setIndex(Index) - Method in class uk.ac.gla.terrier.applications.TRECQuerying
Set the index pointer.
setIndex(Index) - Method in class uk.ac.gla.terrier.structures.BlockDirectIndex
let it know which index to use
setIndex(Index) - Method in class uk.ac.gla.terrier.structures.BlockDirectIndexInputStream
let it know which index to use
setIndex(Index) - Method in class uk.ac.gla.terrier.structures.BlockInvertedIndex
let it know which index to use
setIndex(Index) - Method in class uk.ac.gla.terrier.structures.BlockInvertedIndexInputStream
let it know which index to use
setIndex(Index) - Method in class uk.ac.gla.terrier.structures.DocumentIndex
This structure can be configured by the Index object.
setIndex(Index) - Method in class uk.ac.gla.terrier.structures.DocumentIndexInputStream
This structure can be configured by the Index object.
setIndex(Index) - Method in interface uk.ac.gla.terrier.structures.IndexConfigurable
Tell the implementer which Index object it is associated with.
setIndexProperty(String, String) - Method in class uk.ac.gla.terrier.structures.Index
set an arbitrary property in the index
setInput(BufferedReader) - Method in interface uk.ac.gla.terrier.indexing.Tokenizer
Sets the input of the tokenizer
setInput(BufferedReader) - Method in class uk.ac.gla.terrier.indexing.TRECFullTokenizer
Sets the input of the tokenizer.
setKeyFrequency(double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Sets the term's frequency in the query.
setLastTermWritten(String) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.RunsMerger
Setter for the last term written.
setLength(long) - Method in interface uk.ac.gla.terrier.utility.io.RandomDataOutput
 
setMap(String) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedPostingList
 
setMap(String) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedTerm
 
setMapDocs(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapData
 
setMatchingQueryTerms(MatchingQueryTerms) - Method in class uk.ac.gla.terrier.querying.Request
Used by runPreProcessing after the query tree has been aggregated into a list of terms, each containing frequencies.
setMaxTermFrequency(double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel
This method sets the maximum of the term frequency values of query terms.
setModel(Model) - Method in class uk.ac.gla.terrier.matching.LMMatching
Sets the language model used for retrieval.
setModel(Model) - Method in class uk.ac.gla.terrier.matching.Matching
Sets the weihting model used for retrieval.
setNext(LinkedBuffer) - Method in class uk.ac.gla.terrier.compression.LinkedBuffer
Set the next buffer in the list
setNt(int) - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream
Deprecated.  
setNumberOfBits(int) - Method in class uk.ac.gla.terrier.structures.merging.StructureMerger
Sets the number of bits to write or read for binary encoded numbers
setNumberOfDocuments(double) - Method in interface uk.ac.gla.terrier.matching.Model
Set the number of documents in the collection.
setNumberOfDocuments(double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.BasicModel
Sets the number of documents in the collection.
setNumberOfDocuments(double) - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel
Sets the number of documents in the collection.
setNumberOfDocuments(double) - Method in class uk.ac.gla.terrier.matching.models.Idf
 
setNumberOfDocuments(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.LanguageModel
Sets the number of documents in the collection.
setNumberOfDocuments(double) - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation
 
setNumberOfDocuments(long) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel
 
setNumberOfDocuments(double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Sets the number of documents in the collection.
setNumberOfDocumentsAfterFiltering(int) - Method in class uk.ac.gla.terrier.querying.Request
sets the number of documents in the result set, after applying post filters.
setNumberOfDocumentsAfterFiltering(int) - Method in interface uk.ac.gla.terrier.querying.SearchRequest
Sets the number of documents returned for a search request, after applying post filtering
setNumberOfPointers(double) - Method in interface uk.ac.gla.terrier.matching.Model
 
setNumberOfPointers(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.PonteCroft
 
setNumberOfPointers(double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Set the number of pointers in the collection.
setNumberOfTokens(double) - Method in interface uk.ac.gla.terrier.matching.Model
Set the number of tokens in the whole collection.
setNumberOfTokens(double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.BasicModel
Set the number of tokens in the collection.
setNumberOfTokens(double) - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel
Set the number of tokens in the collection.
setNumberOfTokens(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.PonteCroft
 
setNumberOfTokens(double) - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation
Set the number of tokens in the collection.
setNumberOfTokens(double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Set the number of tokens in the collection.
setNumberOfUniqueTerms(double) - Method in interface uk.ac.gla.terrier.matching.Model
Set the number of unique terms in the collection.
setNumberOfUniqueTerms(double) - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel
Set the number of unique terms in the collection.
setNumberOfUniqueTerms(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.PonteCroft
 
setNumberOfUniqueTerms(double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Set the number of unique terms in the collection.
setObject(T) - Method in class uk.ac.gla.terrier.utility.Wrapper
 
setOriginalQuery(String) - Method in class uk.ac.gla.terrier.querying.Request
sets the string of the original query, before applying any pre-processing
setOriginalQuery(String) - Method in interface uk.ac.gla.terrier.querying.SearchRequest
sets the original query, before any preprocessing
setOriginalQueryTerms(MatchingQueryTerms) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms
Set the original query terms.
setOutputFilename(String) - Method in class uk.ac.gla.terrier.structures.merging.StructureMerger
Deprecated.  
setOutputIndex(Index) - Method in class uk.ac.gla.terrier.structures.merging.StructureMerger
Sets the output index.
setParameter(double) - Method in interface uk.ac.gla.terrier.matching.Model
Many models require 1 parameter to be set - this is often dependant on the corpus and the model, so should be set for each Terrier instance.
setParameter(double) - Method in class uk.ac.gla.terrier.matching.models.aftereffect.AfterEffect
 
setParameter(double) - Method in class uk.ac.gla.terrier.matching.models.BM25
Sets the b parameter to BM25 ranking formula
setParameter(double) - Method in class uk.ac.gla.terrier.matching.models.DFRWeightingModel
Set the frequency normalisation parameter.
setParameter(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.LanguageModel
This method is empty.
setParameter(double) - Method in class uk.ac.gla.terrier.matching.models.normalisation.Normalisation
Specify the free parameter of the implemented frequency normalisation method.
setParameter(double) - Method in class uk.ac.gla.terrier.matching.models.TF_IDF
Sets the b parameter to ranking formula
setParameter(double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Sets the c value
setPostingSource(BitIn) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.PostingInRun
Set where the postings should be read from
setProperties(Properties) - Method in class uk.ac.gla.terrier.querying.Manager
Set all these properties.
setProperty(String, String) - Method in class uk.ac.gla.terrier.querying.Manager
Provide a common interface for changing property values.
setProperty(String, String) - Static method in class uk.ac.gla.terrier.utility.ApplicationSetup
Sets a value for the specified property.
setProximityDistance(int) - Method in class uk.ac.gla.terrier.querying.parser.PhraseQuery
Sets the allowed distance, in blocks, between the phrase terms.
setQuery(Query) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms
Allows the manager to set the query that was used to query the system.
setQuery(Query) - Method in class uk.ac.gla.terrier.querying.Request
Set the query to be a parsed Query syntax tree, as generated by the Terrier query parser
setQuery(Query) - Method in interface uk.ac.gla.terrier.querying.SearchRequest
Set the query to be a parsed Query syntax tree, as generated by the Terrier query parser
setQueryExpansionModel(QueryExpansionModel) - Method in class uk.ac.gla.terrier.querying.QueryExpansion
Set the used query expansion model.
setQueryId(String) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms
Sets the query id
setQueryID(String) - Method in class uk.ac.gla.terrier.querying.Request
Set a unique identifier for this query request.
setQueryID(String) - Method in interface uk.ac.gla.terrier.querying.SearchRequest
Set a unique identifier for this query request.
setRemainingTime(double) - Method in class uk.ac.gla.terrier.utility.TerrierTimer
Estimate the remaining time.
setRequired(boolean) - Method in class uk.ac.gla.terrier.querying.parser.RequirementQuery
Sets whether the query is required or not.
setRequired(int) - Method in class uk.ac.gla.terrier.querying.parser.SingleTermQuery
Sets the value of the required switch.
setResultSet(ResultSet) - Method in class uk.ac.gla.terrier.querying.Request
Set the result set returned by this object to be this results.
setResultSize(int) - Method in class uk.ac.gla.terrier.matching.CollectionResultSet
Sets the effective size of the result set, that is the number of documents to be sorted after retrieval.
setResultSize(int) - Method in interface uk.ac.gla.terrier.matching.ResultSet
Sets the effective size of the result set, that is the number of documents to be sorted after retrieval.
setRun(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedPostingList
 
setRunPostingIterator(Iterator<MapEmittedPostingList>) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.HadoopRunIteratorFactory
Update the posting iterator currently being used
setStartedProcessingTime(long) - Method in class uk.ac.gla.terrier.querying.Request
sets the time when the processing of the request started
setStartedProcessingTime(long) - Method in interface uk.ac.gla.terrier.querying.SearchRequest
 
setStatusCode(int) - Method in class uk.ac.gla.terrier.matching.CollectionResultSet
Sets the status code for the current result set.
setStatusCode(int) - Method in interface uk.ac.gla.terrier.matching.ResultSet
Sets the status code.
setTerm(String) - Method in class uk.ac.gla.terrier.querying.parser.SingleTermQuery
Sets the string of the term.
setTerm(String) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.HadoopRunIteratorFactory
Update the term which is currently being processed
setTerm(String) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.PostingInRun
Setter for the term.
setTerm(String) - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream
Deprecated.  
setTermCode(String, int) - Static method in class uk.ac.gla.terrier.utility.TermCodes
For when you manually want to set the term for a given term, and you know that this term and termcodes do NOT exist, then you can use this method.
setTermFrequency(double) - Method in class uk.ac.gla.terrier.matching.models.languagemodel.LanguageModel
Sets the term's frequency in the collection.
setTermFrequency(double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
Sets the term's frequency in the collection.
setTermFrequency(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.WritableByteArray
 
setTermId(int) - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream
Deprecated.  
setTermProperty(String) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms
Adds a term to the query.
setTermProperty(String, double) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms
Adds a term to the query with a given weight.
setTermProperty(String, int) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms
Sets the term integer identifier for the given query term.
setTermProperty(String, TermScoreModifier) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms
Sets a term score modifier for the given query term.
setTermProperty(String, double, TermScoreModifier) - Method in class uk.ac.gla.terrier.matching.MatchingQueryTerms
Sets the weight and a term score modifier for the given query term.
setText(Text) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.MapEmittedTerm
 
setTF(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.Posting
Sets the term frequency in the run.
setTF(int) - Method in class uk.ac.gla.terrier.structures.indexing.singlepass.PostingInRun
Setter for the term frequency.
setTF(int) - Method in class uk.ac.gla.terrier.structures.LexiconOutputStream
Deprecated.  
setTotalDocumentLength(double) - Method in class uk.ac.gla.terrier.matching.models.queryexpansion.QueryExpansionModel
Set the total document length.
setTotalDocumentLength(double) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms
Allows the totalDocumentLength to be set after the fact
setTotalNumber(double) - Method in class uk.ac.gla.terrier.utility.TerrierTimer
Set the overall quantitative workload of the task.
setupFilenames() - Static method in class uk.ac.gla.terrier.utility.ApplicationSetup
Sets up the names of the inverted file, the direct file, the document index file and the lexicon file.
setWeight(double) - Method in class uk.ac.gla.terrier.querying.parser.SingleTermQuery
Sets the weight of the query term.
setWeightExpansion(double) - Method in class uk.ac.gla.terrier.structures.ExpansionTerms.ExpansionTerm
Sets the expansion weight of the term.
SimpleDocumentIndexBuilder - Class in uk.ac.gla.terrier.structures.indexing.singlepass.hadoop
A simple DocumentIndexBuilder.
SimpleDocumentIndexBuilder(Index) - Constructor for class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.SimpleDocumentIndexBuilder
 
SimpleDocumentIndexInputStream - Class in uk.ac.gla.terrier.structures.indexing.singlepass.hadoop
InputStream for a simple DocumentIndex.
SimpleDocumentIndexInputStream(String, String) - Constructor for class uk.ac.gla.terrier.structures.indexing.singlepass.hadoop.SimpleDocumentIndexInputStream
A constructor of a document index input stream from an index path and prefix.
SimpleFileCollection - Class in uk.ac.gla.terrier.indexing
Implements a collection that can read arbitrary files on disk.
SimpleFileCollection(List<String>, boolean) - Constructor for class uk.ac.gla.terrier.indexing.SimpleFileCollection
Constructs an instance of the class with the given list of files.
SimpleFileCollection() - Constructor for class uk.ac.gla.terrier.indexing.SimpleFileCollection
A default constructor that uses the files to be processed by this collection, as specified by the property collection.spec
SimpleFileCollection(String) - Constructor for class uk.ac.gla.terrier.indexing.SimpleFileCollection
Creates an instance of the class.
SimpleMedlineXMLCollection - Class in uk.ac.gla.terrier.indexing
Initial implementation of a class that generates a Collection with Documents from a series of XML files in the Medline format.
SimpleMedlineXMLCollection() - Constructor for class uk.ac.gla.terrier.indexing.SimpleMedlineXMLCollection
The default constructor.
SimpleMedlineXMLCollection(String, String) - Constructor for class uk.ac.gla.terrier.indexing.SimpleMedlineXMLCollection
An alternative constructor.
SimplePostingInRun - Class in uk.ac.gla.terrier.structures.indexing.singlepass
Class holding the information for a posting list read from a previously written run at disk.
SimplePostingInRun() - Constructor for class uk.ac.gla.terrier.structures.indexing.singlepass.SimplePostingInRun
Constructor for the class.
SimpleXMLCollection - Class in uk.ac.gla.terrier.indexing
Initial implementation of a class that generates a Collection with Documents from a series of XML files.
SimpleXMLCollection() - Constructor for class uk.ac.gla.terrier.indexing.SimpleXMLCollection
 
SimpleXMLCollection(String, String) - Constructor for class uk.ac.gla.terrier.indexing.SimpleXMLCollection
 
SingleLineTRECQuery - Class in uk.ac.gla.terrier.structures
This class can be used to extract batch queries from a simpler format than the regular SGML TREC format.
SingleLineTRECQuery() - Constructor for class uk.ac.gla.terrier.structures.SingleLineTRECQuery
Constructor - default
SingleLineTRECQuery(File) - Constructor for class uk.ac.gla.terrier.structures.SingleLineTRECQuery
Reads queries from the specified file
SingleLineTRECQuery(String) - Constructor for class uk.ac.gla.terrier.structures.SingleLineTRECQuery
Reads queries from the specified filename
SingleTermQuery - Class in uk.ac.gla.terrier.querying.parser
Models a query of a single term.
SingleTermQuery() - Constructor for class uk.ac.gla.terrier.querying.parser.SingleTermQuery
An empty default constructor.
SingleTermQuery(String) - Constructor for class uk.ac.gla.terrier.querying.parser.SingleTermQuery
Creates an instance of the class for the given query term.
SingleTermQuery(String, int) - Constructor for class uk.ac.gla.terrier.querying.parser.SingleTermQuery
Creates an instance of the class for the given query term that should be either required or not.
sizeInBytes() - Static method in class uk.ac.gla.terrier.structures.FilePosition
How large is this object when serialized
skip(long) - Method in class uk.ac.gla.terrier.utility.io.CountingInputStream
Calls Skip(long n)
skip(long) - Method in class uk.ac.gla.terrier.utility.LookAheadReader
Skips n characters from the stream.
skip(long) - Method in class uk.ac.gla.terrier.utility.LookAheadStream
Skips n characters from the stream.
skipBits(int) - Method in class uk.ac.gla.terrier.compression.BitFile
Skip a number of bits in the current input stream
skipBits(int) - Method in interface uk.ac.gla.terrier.compression.BitIn
Skip a number of bits while reading the bit file.
skipBits(int) - Method in class uk.ac.gla.terrier.compression.BitInputStream
Skip a number of bits in the current input stream
skipBits(int) - Method in class uk.ac.gla.terrier.compression.OldBitFile
Skip a number of bits in the current input stream
skipBits(int) - Method in class uk.ac.gla.terrier.compression.OldBitInputStream
Skip a number of bits in the current input stream
SkipTermPipeline - Class in uk.ac.gla.terrier.terms
Class that identified tokens which should not be passed down the entire term pipeline, and instead passed onto a specified stage instead.
SkipTermPipeline(TermPipeline, TermPipeline) - Constructor for class uk.ac.gla.terrier.terms.SkipTermPipeline
Instantiate this object, using properties to define tokens.
SkipTermPipeline(TermPipeline, TermPipeline, String[]) - Constructor for class uk.ac.gla.terrier.terms.SkipTermPipeline
Instantiate this object.
SnowballStemmer - Class in uk.ac.gla.terrier.terms
 
sort(int[], int[]) - Static method in class uk.ac.gla.terrier.sorting.SortAscendingPairedVectors
Sorts the two vectors with respect to the ascending order of the first one.
sort(int[], int[], int[], int[]) - Static method in class uk.ac.gla.terrier.sorting.SortAscendingQuadrupleVectors
Sorts the four vectors with respect to the ascending order of the first one.
sort(int[], int[], int[], int[], int[]) - Static method in class uk.ac.gla.terrier.sorting.SortAscendingQuintupleVectors
Sorts the five vectors with respect to the ascending order of the first one.
sort(int[], int[], int[]) - Static method in class uk.ac.gla.terrier.sorting.SortAscendingTripleVectors
Sorts the three vectors with respect to the ascending order of the first one.
sort(int[], int[][]) - Static method in class uk.ac.gla.terrier.sorting.SortAscendingVectors
Sort the vectors contained in u with respect to the ascending order of the vector a.
sort(int[], int[]) - Static method in class uk.ac.gla.terrier.sorting.SortDescendingPairedVectors
Sorts the three vectors with respect to the descending order of the first one.
sort2(int[], int[]) - Static method in class uk.ac.gla.terrier.sorting.SortAscendingVectors
Sorts the two vectors with respect to the ascending order of the first one.
SortAscendingPairedVectors - Class in uk.ac.gla.terrier.sorting
This class sorts a pair of arrays, where the corresponding entries are related.
SortAscendingPairedVectors() - Constructor for class uk.ac.gla.terrier.sorting.SortAscendingPairedVectors
 
SortAscendingQuadrupleVectors - Class in uk.ac.gla.terrier.sorting
This class sorts four arrays, where the corresponding entries are related.
SortAscendingQuadrupleVectors() - Constructor for class uk.ac.gla.terrier.sorting.SortAscendingQuadrupleVectors
 
SortAscendingQuintupleVectors - Class in uk.ac.gla.terrier.sorting
This class sorts five arrays, where the corresponding entries are related.
SortAscendingQuintupleVectors() - Constructor for class uk.ac.gla.terrier.sorting.SortAscendingQuintupleVectors
 
SortAscendingTripleVectors - Class in uk.ac.gla.terrier.sorting
This class sorts five arrays, where the corresponding entries are related.
SortAscendingTripleVectors() - Constructor for class uk.ac.gla.terrier.sorting.SortAscendingTripleVectors
 
SortAscendingVectors - Class in uk.ac.gla.terrier.sorting
This class sorts one or more arrays, based on sorting a key array, ie where the corresponding entries are related.
SortAscendingVectors() - Constructor for class uk.ac.gla.terrier.sorting.SortAscendingVectors
 
SortDescendingPairedVectors - Class in uk.ac.gla.terrier.sorting
This class sorts a pair of arrays, where the corresponding entries are related.
SortDescendingPairedVectors() - Constructor for class uk.ac.gla.terrier.sorting.SortDescendingPairedVectors
 
SpanishSnowballStemmer - Class in uk.ac.gla.terrier.terms
Spanish stemmer implmented by Snowball.
SpanishSnowballStemmer(TermPipeline) - Constructor for class uk.ac.gla.terrier.terms.SpanishSnowballStemmer
 
standardDeviation(double[]) - Static method in class uk.ac.gla.terrier.utility.StaTools
The standard deviation of an array of double values.
start() - Method in class uk.ac.gla.terrier.utility.TerrierTimer
Start the timer.
startBitOffset - Variable in class uk.ac.gla.terrier.structures.LexiconEntry
the start bit offset of the entry in the inverted index
startOffset - Variable in class uk.ac.gla.terrier.structures.LexiconEntry
the start offset of the entry in the inverted index
startReduce(LinkedList<MapData>) - Method in class uk.ac.gla.terrier.indexing.hadoop.Hadoop_BasicSinglePassIndexer
Merge the postings for the current term, converts the document ID's in the postings to be relative to one another using the run number, number of documents covered in each run, the flush number for that run and the number of documents flushed.
STAT - Static variable in interface uk.ac.gla.terrier.utility.Files.FSCapability
FS can determine properties of a file or directory
StaTools - Class in uk.ac.gla.terrier.utility
This class implements a series of basic statistical functions.
StaTools() - Constructor for class uk.ac.gla.terrier.utility.StaTools
 
stdErrorOfTheMean(double[]) - Static method in class uk.ac.gla.terrier.utility.StaTools
This method returns the standard error of the mean for an array of data.
stem(String) - Method in class uk.ac.gla.terrier.terms.PorterStemmer
Returns the stem of a given term
stem(String) - Method in class uk.ac.gla.terrier.terms.SnowballStemmer
Stems the given term and returns the stem
stem(String) - Method in class uk.ac.gla.terrier.terms.WeakPorterStemmer
Returns the stem of a given term, after applying the first step of Porter's stemming algorithm.
stirlingPower(double, double) - Method in class uk.ac.gla.terrier.matching.models.basicmodel.BasicModel
This method provides the contract for implementing the Stirling formula for the power series.
stirlingPower(double, double) - Method in class uk.ac.gla.terrier.matching.models.WeightingModel
This method provides the contract for implementing the Stirling formula for the power series.
stirlingPower(double, double) - Static method in class uk.ac.gla.terrier.utility.StaTools
This method provides the contract for implementing the Stirling formula for the power series.
Stopwords - Class in uk.ac.gla.terrier.terms
Implements stopword removal, as a TermPipeline object.
Stopwords(TermPipeline) - Constructor for class uk.ac.gla.terrier.terms.Stopwords
Makes a new stopword termpipeline object.
Stopwords(TermPipeline, String) - Constructor for class uk.ac.gla.terrier.terms.Stopwords
Makes a new stopword term pipeline object.
Stopwords(TermPipeline, String[]) - Constructor for class uk.ac.gla.terrier.terms.Stopwords
Makes a new stopword term pipeline object.
storeToStream(LexiconOutputStream) - Method in class uk.ac.gla.terrier.structures.indexing.BlockLexiconMap
Stores the lexicon map to a lexicon stream as a sequence of entries.
storeToStream(LexiconOutputStream) - Method in class uk.ac.gla.terrier.structures.indexing.LexiconMap
Stores the lexicon tree to a lexicon stream as a sequence of entries.
STRING_BYTE_LENGTH - Static variable in class uk.ac.gla.terrier.utility.ApplicationSetup
The number of bytes used to store a term.
StringComparator - Class in uk.ac.gla.terrier.utility
Compares two strings which may have fixed length fields separated with a non word character (eg a dash), and a last field which corresponds to an integer.
StringComparator() - Constructor for class uk.ac.gla.terrier.utility.StringComparator
 
StringTools - Class in uk.ac.gla.terrier.utility
This class implements useful string functions
StringTools() - Constructor for class uk.ac.gla.terrier.utility.StringTools
 
StructureMerger - Class in uk.ac.gla.terrier.structures.merging
This class merges the structures created by Terrier, so that we use fewer and larger inverted and direct files.
StructureMerger(Index, Index, Index) - Constructor for class uk.ac.gla.terrier.structures.merging.StructureMerger
 
StructureMerger(String, String) - Constructor for class uk.ac.gla.terrier.structures.merging.StructureMerger
Deprecated.  
subtract(LexiconEntry) - Method in class uk.ac.gla.terrier.structures.LexiconEntry
alter this lexicon entry to subtract another lexicon entry
sum(int[]) - Static method in class uk.ac.gla.terrier.utility.StaTools
The sum of an array of integers.
SwedishSnowballStemmer - Class in uk.ac.gla.terrier.terms
Swedish stemmer implmented by Snowball.
SwedishSnowballStemmer(TermPipeline) - Constructor for class uk.ac.gla.terrier.terms.SwedishSnowballStemmer
 

Terrier IR Platform
2.2.1
A B C D E F G H I J K L M N O P Q R S T U V W
Terrier Information Retrieval Platform 2.2.1. Copyright 2004-2008 University of Glasgow