RankFeatureQueryBuilder.ScoreFunction.Saturation (mapper-extras 1.3.11 API)

java.lang.Object
- org.opensearch.index.query.RankFeatureQueryBuilder.ScoreFunction
- - org.opensearch.index.query.RankFeatureQueryBuilder.ScoreFunction.Saturation

Enclosing class:

RankFeatureQueryBuilder.ScoreFunction
```
public static class RankFeatureQueryBuilder.ScoreFunction.Saturation
extends RankFeatureQueryBuilder.ScoreFunction
```
A scoring function that scores documents as S / (S + pivot) where S is the value of the static feature.

- Nested Class Summary
  - Nested classes/interfaces inherited from class org.opensearch.index.query.RankFeatureQueryBuilder.ScoreFunction
    RankFeatureQueryBuilder.ScoreFunction.Linear, RankFeatureQueryBuilder.ScoreFunction.Log, RankFeatureQueryBuilder.ScoreFunction.Saturation, RankFeatureQueryBuilder.ScoreFunction.Sigmoid
- Constructor Summary
  
  Constructors
  Constructor Description
  
  Saturation()
  Constructor with a default pivot, computed as the geometric average of all feature values in the index.
  
  Saturation(float pivot)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  boolean equals(java.lang.Object obj)
  
  int hashCode()
  - Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Saturation
```
public Saturation()
```
    Constructor with a default pivot, computed as the geometric average of all feature values in the index.
  - Saturation
```
public Saturation(float pivot)
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object