Enum Class FieldValueFactorModifier
java.lang.Object
java.lang.Enum<FieldValueFactorModifier>
co.elastic.clients.elasticsearch._types.query_dsl.FieldValueFactorModifier
- All Implemented Interfaces:
JsonEnum
,JsonpSerializable
,Serializable
,Comparable<FieldValueFactorModifier>
,Constable
@JsonpDeserializable
public enum FieldValueFactorModifier
extends Enum<FieldValueFactorModifier>
implements JsonEnum
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum
JsonEnum.Deserializer<T extends JsonEnum>
-
Enum Constant Summary
Enum ConstantDescriptionTake the natural logarithm of the field value.Add 1 to the field value and take the natural logarithm.Add 2 to the field value and take the natural logarithm.Take the common logarithm of the field value.Add 1 to the field value and take the common logarithm.Add 2 to the field value and take the common logarithm.Do not apply any multiplier to the field value.Reciprocate the field value, same as1/x
wherex
is the field’s value.Take the square root of the field value.Square the field value (multiply it by itself). -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic FieldValueFactorModifier
Returns the enum constant of this class with the specified name.static FieldValueFactorModifier[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
None
Do not apply any multiplier to the field value. -
Log
Take the common logarithm of the field value. Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to uselog1p
instead. -
Log1p
Add 1 to the field value and take the common logarithm. -
Log2p
Add 2 to the field value and take the common logarithm. -
Ln
Take the natural logarithm of the field value. Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to useln1p
instead. -
Ln1p
Add 1 to the field value and take the natural logarithm. -
Ln2p
Add 2 to the field value and take the natural logarithm. -
Square
Square the field value (multiply it by itself). -
Sqrt
Take the square root of the field value. -
Reciprocal
Reciprocate the field value, same as1/x
wherex
is the field’s value.
-
-
Field Details
-
_DESERIALIZER
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
jsonValue
-