Enum elasticsearch_dsl::search::queries::params::FieldValueFactorModifier

pub enum FieldValueFactorModifier {
    None,
    Log,
    Log1P,
    Log2P,
    Ln,
    Ln1P,
    Ln2P,
    Square,
    Sqrt,
    Reciprocal,
}

Modifier to apply to the field value

Defaults to none

Variants

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 use log1p 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 use ln1p 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 as 1/x where x is the field’s value

Trait Implementations

impl Clone for FieldValueFactorModifier

fn clone(&self) -> FieldValueFactorModifier

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FieldValueFactorModifier

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for FieldValueFactorModifier

fn cmp(&self, other: &FieldValueFactorModifier) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<FieldValueFactorModifier> for FieldValueFactorModifier

fn eq(&self, other: &FieldValueFactorModifier) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<FieldValueFactorModifier> for FieldValueFactorModifier

fn partial_cmp(&self, other: &FieldValueFactorModifier) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FieldValueFactorModifier

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FieldValueFactorModifier

impl Eq for FieldValueFactorModifier

impl StructuralEq for FieldValueFactorModifier

impl StructuralPartialEq for FieldValueFactorModifier