Package org.opensearch.script

Class ScoreScriptUtils

java.lang.Object

org.opensearch.script.ScoreScriptUtils

public final class ScoreScriptUtils
extends Object

Utilities for scoring scripts

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ScoreScriptUtils.DecayDateExp	Exponential date decay
static final class	ScoreScriptUtils.DecayDateGauss	Gaussian date decay
static final class	ScoreScriptUtils.DecayDateLinear	Linear date decay
static final class	ScoreScriptUtils.DecayGeoExp	Exponential geo decay
static final class	ScoreScriptUtils.DecayGeoGauss	Gaussian geo decay
static final class	ScoreScriptUtils.DecayGeoLinear	**** Decay functions on geo field
static final class	ScoreScriptUtils.DecayNumericExp	Exponential numeric decay
static final class	ScoreScriptUtils.DecayNumericGauss	Gaussian numeric decay
static final class	ScoreScriptUtils.DecayNumericLinear	Linear numeric decay
static final class	ScoreScriptUtils.RandomScoreDoc	random score based on the internal Lucene document Ids
static final class	ScoreScriptUtils.RandomScoreField	random score based on the documents' values of the given field

Constructor Summary

Constructors

Constructor	Description
ScoreScriptUtils()

Method Summary

Modifier and Type	Method	Description
static double	saturation(double value, double k)	STATIC FUNCTIONS that can be used by users for score calculations
static double	sigmoid(double value, double k, double a)	Calculate a sigmoid of value with scaling parameters k and a

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScoreScriptUtils

public ScoreScriptUtils()

Method Details

saturation

public static double saturation(double value,
 double k)

STATIC FUNCTIONS that can be used by users for score calculations

sigmoid

public static double sigmoid(double value,
 double k,
 double a)

Calculate a sigmoid of value with scaling parameters k and a