Package com.mongodb.client.model

Enum Class ScoreNormalization

java.lang.Object

java.lang.Enum<ScoreNormalization>

com.mongodb.client.model.ScoreNormalization

All Implemented Interfaces:

Serializable, Comparable<ScoreNormalization>, java.lang.constant.Constable

public enum ScoreNormalization
extends Enum<ScoreNormalization>

Normalization methods for the $score and $scoreFusion pipeline stages.

Since:

5.10

MongoDB documentation

$score

$scoreFusion

Since server release

8.2

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MIN_MAX_SCALER	Normalizes the score to the range [0, 1] by applying min-max scaling.
NONE	No normalization is applied.
SIGMOID	Normalizes the score to the range (0, 1) by applying the sigmoid function.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the value as expected by the server.
static ScoreNormalization	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScoreNormalization[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final ScoreNormalization NONE

No normalization is applied.

SIGMOID

public static final ScoreNormalization SIGMOID

Normalizes the score to the range (0, 1) by applying the sigmoid function.

MIN_MAX_SCALER

public static final ScoreNormalization MIN_MAX_SCALER

Normalizes the score to the range [0, 1] by applying min-max scaling.

Method Details

values

public static ScoreNormalization[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScoreNormalization valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Returns the value as expected by the server.

Returns:

the server value