Struct DecayParamsExpressionBuilder 

pub struct DecayParamsExpressionBuilder { /* private fields */ }

Builder for the DecayParamsExpression struct, which represents parameters for decay functions.

Decay functions (exponential, Gaussian, linear) are used in scoring to create a decay effect based on distance from a target value.

Implementations

impl DecayParamsExpressionBuilder

pub fn new<E: Into<Expression>>(x: E) -> Self

Creates a new DecayParamsExpressionBuilder with the variable to decay. This is the only required parameter.

pub fn x<E: Into<Expression>>(self, x: E) -> Self

Sets the variable to decay. This is the value that will be compared to the target.

pub fn target<E: Into<Expression>>(self, target: E) -> Self

Sets the target value to start decaying from. Defaults to 0 if not specified. The decay is at its maximum (1.0) when x equals the target.

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

Sets the scale factor of the decay, in terms of x. Defaults to 1.0 if not specified. Must be a non-zero positive number. This controls how quickly the function decays away from the target value.

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

Sets the midpoint of the decay. Defaults to 0.5 if not specified. The output will be this value when the distance between x and target equals the scale.

impl DecayParamsExpressionBuilder

pub fn build(self) -> DecayParamsExpression

Builds the DecayParamsExpression from this builder.

Trait Implementations

impl Clone for DecayParamsExpressionBuilder

fn clone(&self) -> DecayParamsExpressionBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<DecayParamsExpressionBuilder> for DecayParamsExpression

fn from(value: DecayParamsExpressionBuilder) -> Self

Converts to this type from the input type.