Struct elasticsearch_dsl::search::queries::params::Decay

pub struct Decay<T: Origin> { /* fields omitted */ }

Decay functions score a document with a function that decays depending on the distance of a numeric field value of the document from a user given origin. This is similar to a range query, but with smooth edges instead of boxes.

To use distance scoring on a query that has numerical fields, the user has to define an origin and a scale for each field. The origin is needed to define the “central point” from which the distance is calculated, and the scale to define the rate of decay.

Implementations

impl<T: Origin> Decay<T>

pub fn new(
    function: DecayFunction,
    field: impl Into<String>,
    origin: T,
    scale: <T as Origin>::Scale
) -> Self

Creates an instance of Decay

• function - Decay function variant
• field - Field to apply function to
• origin - The point of origin used for calculating distance. Must be given as a number for numeric field, date for date fields and geo point for geo fields. Required for geo and numeric field. For date fields the default is now. Date math (for example now-1h) is supported for origin.
• scale - Required for all types. Defines the distance from origin + offset at which the computed score will equal decay parameter. For geo fields: Can be defined as number+unit (1km, 12m,…​). Default unit is meters. For date fields: Can to be defined as a number+unit (“1h”, “10d”,…​). Default unit is milliseconds. For numeric field: Any number.

pub fn offset(self, offset: <T as Origin>::Offset) -> Self

If an offset is defined, the decay function will only compute the decay function for documents with a distance greater than the defined offset.

The default is 0.

pub fn decay(self, decay: f32) -> Self

The decay parameter defines how documents are scored at the distance given at scale. If no decay is defined, documents at the distance scale will be scored 0.5.

Trait Implementations

impl<T: Clone + Origin> Clone for Decay<T>

fn clone(&self) -> Decay<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Origin> Debug for Decay<T>

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

Formats the value using the given formatter.

impl From<Decay<DateTime<Utc>>> for Function

fn from(q: Decay<DateTime<Utc>>) -> Self

Performs the conversion.

impl From<Decay<DateTime<Utc>>> for Option<Function>

fn from(q: Decay<DateTime<Utc>>) -> Self

Performs the conversion.

impl From<Decay<GeoPoint>> for Function

fn from(q: Decay<GeoPoint>) -> Self

Performs the conversion.

impl From<Decay<GeoPoint>> for Option<Function>

fn from(q: Decay<GeoPoint>) -> Self

Performs the conversion.

impl From<Decay<i16>> for Function

fn from(q: Decay<i16>) -> Self

Performs the conversion.

impl From<Decay<i16>> for Option<Function>

fn from(q: Decay<i16>) -> Self

Performs the conversion.

impl From<Decay<i32>> for Function

fn from(q: Decay<i32>) -> Self

Performs the conversion.

impl From<Decay<i32>> for Option<Function>

fn from(q: Decay<i32>) -> Self

Performs the conversion.

impl From<Decay<i64>> for Function

fn from(q: Decay<i64>) -> Self

Performs the conversion.

impl From<Decay<i64>> for Option<Function>

fn from(q: Decay<i64>) -> Self

Performs the conversion.

impl From<Decay<i8>> for Function

fn from(q: Decay<i8>) -> Self

Performs the conversion.

impl From<Decay<i8>> for Option<Function>

fn from(q: Decay<i8>) -> Self

Performs the conversion.

impl From<Decay<u16>> for Function

fn from(q: Decay<u16>) -> Self

Performs the conversion.

impl From<Decay<u16>> for Option<Function>

fn from(q: Decay<u16>) -> Self

Performs the conversion.

impl From<Decay<u32>> for Function

fn from(q: Decay<u32>) -> Self

Performs the conversion.

impl From<Decay<u32>> for Option<Function>

fn from(q: Decay<u32>) -> Self

Performs the conversion.

impl From<Decay<u64>> for Function

fn from(q: Decay<u64>) -> Self

Performs the conversion.

impl From<Decay<u64>> for Option<Function>

fn from(q: Decay<u64>) -> Self

Performs the conversion.

impl From<Decay<u8>> for Function

fn from(q: Decay<u8>) -> Self

Performs the conversion.

impl From<Decay<u8>> for Option<Function>

fn from(q: Decay<u8>) -> Self

Performs the conversion.

impl<T: PartialEq + Origin> PartialEq<Decay<T>> for Decay<T>

fn eq(&self, other: &Decay<T>) -> bool

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

fn ne(&self, other: &Decay<T>) -> bool

This method tests for !=.

impl<T: Origin> Serialize for Decay<T>

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

Serialize this value into the given Serde serializer.

impl<T: Origin> StructuralPartialEq for Decay<T>