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

Packages that use Similarity
Package | Description
--- | ---
org.apache.lucene.index | Code to maintain and access indices.
org.apache.lucene.search | Code to search indices.
org.apache.lucene.search.payloads | The payloads package provides Query mechanisms for finding and using payloads.
org.apache.lucene.search.similarities | This package contains the various ranking models that can be used in Lucene.
org.apache.lucene.search.spans | The calculus of spans.

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

Fields in org.apache.lucene.index declared as Similarity
Modifier and Type | Field and Description
--- | ---
`protected Similarity` | LiveIndexWriterConfig.`similarity` `Similarity` to use when encoding norms.

Methods in org.apache.lucene.index that return Similarity
Modifier and Type | Method and Description
--- | ---
`Similarity` | LiveIndexWriterConfig.`getSimilarity()` Expert: returns the `Similarity` implementation used by this `IndexWriter`.
`Similarity` | IndexWriterConfig.`getSimilarity()`

Methods in org.apache.lucene.index with parameters of type Similarity
Modifier and Type | Method and Description
--- | ---
`IndexWriterConfig` | IndexWriterConfig.`setSimilarity(Similarity similarity)` Expert: set the `Similarity` implementation used by this IndexWriter.

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

Fields in org.apache.lucene.search declared as Similarity
Modifier and Type | Field and Description
--- | ---
`protected Similarity` | BooleanQuery.BooleanWeight.`similarity` The Similarity implementation.

Methods in org.apache.lucene.search that return Similarity
Modifier and Type | Method and Description
--- | ---
`static Similarity` | IndexSearcher.`getDefaultSimilarity()` Expert: returns a default Similarity instance.
`Similarity` | IndexSearcher.`getSimilarity()`

Methods in org.apache.lucene.search with parameters of type Similarity
Modifier and Type | Method and Description
--- | ---
`void` | IndexSearcher.`setSimilarity(Similarity similarity)` Expert: Set the Similarity implementation used by this IndexSearcher.

### Uses of Similarity in org.apache.lucene.search.payloads

Methods in org.apache.lucene.search.payloads with parameters of type Similarity
Modifier and Type | Method and Description
--- | ---
`protected void` | PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer.`processPayload(Similarity similarity)`

Constructors in org.apache.lucene.search.payloads with parameters of type Similarity
Constructor and Description
`PayloadNearQuery.PayloadNearSpanScorer(Spans spans, Weight weight, Similarity similarity, Similarity.SloppySimScorer docScorer)`

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

Subclasses of Similarity in org.apache.lucene.search.similarities
Modifier and Type | Class and Description
--- | ---
`class` | `BM25Similarity` BM25 Similarity.
`class` | `DefaultSimilarity` Expert: Default scoring implementation.
`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 and 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 and 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 and Description
`MultiSimilarity(Similarity[] sims)` Creates a MultiSimilarity which will sum the scores of the provided `sims`.

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

Fields in org.apache.lucene.search.spans declared as Similarity
Modifier and Type | Field and Description
--- | ---
`protected Similarity` | SpanWeight.`similarity`