Struct DecayParamsExpression 

pub struct DecayParamsExpression {
    pub x: Option<Box<Expression>>,
    pub target: Option<Box<Expression>>,
    pub scale: Option<f32>,
    pub midpoint: Option<f32>,
}

Fields

x: Option<Box<Expression>>

The variable to decay

target: Option<Box<Expression>>

The target value to start decaying from. Defaults to 0.

scale: Option<f32>

The scale factor of the decay, in terms of x. Defaults to 1.0. Must be a non-zero positive number.

midpoint: Option<f32>

The midpoint of the decay. Should be between 0 and 1. Defaults to 0.5. Output will be this value when |x - target| == scale.

Implementations

impl DecayParamsExpression

pub fn scale(&self) -> f32

Returns the value of scale, or the default value if scale is unset.

pub fn midpoint(&self) -> f32

Returns the value of midpoint, or the default value if midpoint is unset.

Trait Implementations

impl Clone for DecayParamsExpression

fn clone(&self) -> DecayParamsExpression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecayParamsExpression

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

Formats the value using the given formatter.

impl Default for DecayParamsExpression

fn default() -> Self

Returns the “default value” for a type.

impl From<DecayParamsExpressionBuilder> for DecayParamsExpression

fn from(value: DecayParamsExpressionBuilder) -> Self

Converts to this type from the input type.

impl Message for DecayParamsExpression

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DecayParamsExpression

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DecayParamsExpression