GaussDecayFunction (Atlassian Confluence 8.5.7 API)

java.lang.Object
- com.atlassian.confluence.search.v2.score.GaussDecayFunction

All Implemented Interfaces:

ComposableScoreFunction, ScoreFunction
```
public class GaussDecayFunction
extends Object
implements ComposableScoreFunction
```
A gaussian decay function. The further the values are from an origin + offset, the lower the score.
Important attributes to note:
- Value is between 0 and 1.
- When absolute distance from origin is less than or equal to offset, the value is 1.
- When absolute distance from origin and offset is equal to scale, the value is equal to decay.
- Curve is shaped like a gaussian bell-curve distribution.
Useful for applying multiplicative decay, based on recency of modification.
See Elasticsearch supported decay functions for the formula being used.
Since:

7.0

See Also:

DecayParameters, ExpDecayFunction

- Constructor Summary
  
  Constructors
  Constructor Description
  
  GaussDecayFunction(FieldValueSource source, DecayParameters parameters)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  DecayParameters getParameters()
  
  FieldValueSource getSource()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GaussDecayFunction

public GaussDecayFunction(FieldValueSource source,
                          DecayParameters parameters)

Method Detail

getSource
```
public FieldValueSource getSource()
```

getParameters

public DecayParameters getParameters()