Uses of Class
org.apache.lucene.search.similarities.Similarity

Packages that use Similarity

Package	Description
org.apache.lucene.index
org.apache.lucene.index.memory
org.apache.lucene.search
org.apache.lucene.search.similarities
org.apache.lucene.search.similarity
org.apache.lucene.search.spans
org.elasticsearch.common.lucene.search
org.elasticsearch.index
org.elasticsearch.index.engine
org.elasticsearch.index.query
org.elasticsearch.index.similarity
org.elasticsearch.search.internal

Uses of Similarity in org.apache.lucene.index

Fields in org.apache.lucene.index declared as Similarity

Modifier and Type	Field	Description
protected Similarity	LiveIndexWriterConfig.similarity	Similarity to use when encoding norms.

Methods in org.apache.lucene.index that return Similarity

Modifier and Type	Method	Description
Similarity	IndexWriterConfig.getSimilarity()
Similarity	LiveIndexWriterConfig.getSimilarity()	Expert: returns the Similarity implementation used by this IndexWriter.

Methods in org.apache.lucene.index with parameters of type Similarity

Modifier and Type	Method	Description
IndexWriterConfig	IndexWriterConfig.setSimilarity(Similarity similarity)	Expert: set the Similarity implementation used by this IndexWriter.

Uses of Similarity in org.apache.lucene.index.memory

Methods in org.apache.lucene.index.memory with parameters of type Similarity

Modifier and Type	Method	Description
void	MemoryIndex.setSimilarity(Similarity similarity)	Set the Similarity to be used for calculating field norms

Uses of Similarity in org.apache.lucene.search

Methods in org.apache.lucene.search that return Similarity

Modifier and Type	Method	Description
static Similarity	IndexSearcher.getDefaultSimilarity()	Expert: returns a default Similarity instance.
Similarity	IndexSearcher.getSimilarity()	Expert: Get the Similarity to use to compute scores.

Methods in org.apache.lucene.search with parameters of type Similarity

Modifier and Type	Method	Description
void	IndexSearcher.setSimilarity(Similarity similarity)	Expert: Set the Similarity implementation used by this IndexSearcher.

Uses of Similarity in org.apache.lucene.search.similarities

Subclasses of Similarity in org.apache.lucene.search.similarities

Modifier and Type	Class	Description
class	BM25Similarity	BM25 Similarity.
class	BooleanSimilarity	Simple similarity that gives terms a score that is equal to their query boost.
class	ClassicSimilarity	Expert: Historical scoring implementation.
class	DFISimilarity	Implements the Divergence from Independence (DFI) model based on Chi-square statistics (i.e., standardized Chi-squared distance from independence in term frequency tf).
class	DFRSimilarity	Implements the divergence from randomness (DFR) framework introduced in Gianni Amati and Cornelis Joost Van Rijsbergen.
class	IBSimilarity	Provides a framework for the family of information-based models, as described in Stéphane Clinchant and Eric Gaussier.
class	LMDirichletSimilarity	Bayesian smoothing using Dirichlet priors.
class	LMJelinekMercerSimilarity	Language model based on the Jelinek-Mercer smoothing method.
class	LMSimilarity	Abstract superclass for language modeling Similarities.
class	MultiSimilarity	Implements the CombSUM method for combining evidence from multiple similarity values described in: Joseph A.
class	PerFieldSimilarityWrapper	Provides the ability to use a different Similarity for different fields.
class	SimilarityBase	A subclass of Similarity that provides a simplified API for its descendants.
class	TFIDFSimilarity	Implementation of Similarity with the Vector Space Model.

Fields in org.apache.lucene.search.similarities declared as Similarity

Modifier and Type	Field	Description
protected Similarity[]	MultiSimilarity.sims	the sub-similarities used to create the combined score

Methods in org.apache.lucene.search.similarities that return Similarity

Modifier and Type	Method	Description
abstract Similarity	PerFieldSimilarityWrapper.get(String name)	Returns a Similarity for scoring a field.

Constructors in org.apache.lucene.search.similarities with parameters of type Similarity

Constructor	Description
MultiSimilarity(Similarity[] sims)	Creates a MultiSimilarity which will sum the scores of the provided sims.

Uses of Similarity in org.apache.lucene.search.similarity

Subclasses of Similarity in org.apache.lucene.search.similarity

Modifier and Type	Class	Description
class	LegacyBM25Similarity	Deprecated. BM25Similarity should be used instead

Uses of Similarity in org.apache.lucene.search.spans

Fields in org.apache.lucene.search.spans declared as Similarity

Modifier and Type	Field	Description
protected Similarity	SpanWeight.similarity

Uses of Similarity in org.elasticsearch.common.lucene.search

Methods in org.elasticsearch.common.lucene.search that return Similarity

Modifier and Type	Method	Description
Similarity	MoreLikeThisQuery.getSimilarity()

Methods in org.elasticsearch.common.lucene.search with parameters of type Similarity

Modifier and Type	Method	Description
void	MoreLikeThisQuery.setSimilarity(Similarity similarity)

Uses of Similarity in org.elasticsearch.index

Method parameters in org.elasticsearch.index with type arguments of type Similarity

Modifier and Type	Method	Description
void	IndexModule.addSimilarity(String name, TriFunction<Settings,Version,ScriptService,Similarity> similarity)	Registers the given Similarity with the given name.

Uses of Similarity in org.elasticsearch.index.engine

Methods in org.elasticsearch.index.engine that return Similarity

Modifier and Type	Method	Description
Similarity	EngineConfig.getSimilarity()	Returns the Similarity used for indexing and searching.

Constructors in org.elasticsearch.index.engine with parameters of type Similarity

Constructor	Description
EngineConfig(ShardId shardId, String allocationId, ThreadPool threadPool, IndexSettings indexSettings, Engine.Warmer warmer, Store store, MergePolicy mergePolicy, Analyzer analyzer, Similarity similarity, CodecService codecService, Engine.EventListener eventListener, QueryCache queryCache, QueryCachingPolicy queryCachingPolicy, TranslogConfig translogConfig, TimeValue flushMergesAfter, List<ReferenceManager.RefreshListener> externalRefreshListener, List<ReferenceManager.RefreshListener> internalRefreshListener, Sort indexSort, CircuitBreakerService circuitBreakerService, LongSupplier globalCheckpointSupplier, Supplier<RetentionLeases> retentionLeasesSupplier, LongSupplier primaryTermSupplier, EngineConfig.TombstoneDocSupplier tombstoneDocSupplier)	Creates a new EngineConfig
Searcher(String source, IndexReader reader, Similarity similarity, QueryCache queryCache, QueryCachingPolicy queryCachingPolicy, Closeable onClose)

Uses of Similarity in org.elasticsearch.index.query

Methods in org.elasticsearch.index.query that return Similarity

Modifier and Type	Method	Description
Similarity	QueryShardContext.getSearchSimilarity()

Uses of Similarity in org.elasticsearch.index.similarity

Subclasses of Similarity in org.elasticsearch.index.similarity

Modifier and Type	Class	Description
class	NonNegativeScoresSimilarity	A Similarity that rejects negative scores.
class	ScriptedSimilarity	A Similarity implementation that allows scores to be scripted.

Fields in org.elasticsearch.index.similarity with type parameters of type Similarity

Modifier and Type	Field	Description
static Map<String,TriFunction<Settings,Version,ScriptService,Similarity>>	SimilarityService.BUILT_IN

Methods in org.elasticsearch.index.similarity that return Similarity

Modifier and Type	Method	Description
Similarity	SimilarityProvider.get()	Return the wrapped Similarity.
Similarity	NonNegativeScoresSimilarity.getDelegate()
Similarity	SimilarityService.similarity(MapperService mapperService)

Constructors in org.elasticsearch.index.similarity with parameters of type Similarity

Constructor	Description
NonNegativeScoresSimilarity(Similarity in)
SimilarityProvider(String name, Similarity similarity)

Constructor parameters in org.elasticsearch.index.similarity with type arguments of type Similarity

Constructor	Description
SimilarityService(IndexSettings indexSettings, ScriptService scriptService, Map<String,TriFunction<Settings,Version,ScriptService,Similarity>> similarities)

Uses of Similarity in org.elasticsearch.search.internal

Constructors in org.elasticsearch.search.internal with parameters of type Similarity

Constructor	Description
ContextIndexSearcher(IndexReader reader, Similarity similarity, QueryCache queryCache, QueryCachingPolicy queryCachingPolicy)