Struct CustomCurveFit 

pub struct CustomCurveFit { /* private fields */ }

Implementations

impl CustomCurveFit

pub fn builder() -> Builder<FormulaStage>

Returns a new builder.

impl CustomCurveFit

pub fn new(formula: StringConstant) -> Self

Constructs a new instance of the type.

pub fn formula(&self) -> &StringConstant

A mathematical expression in terms of variable and parameter names, e.g. a * x + b * sin(x). Variable names must match keys in the variables map; parameter names must match keys in the parameters map.

pub fn variables(&self) -> &BTreeMap<LocalVariableName, CurveFitVariable>

Named input series referenced in the formula. Keys must match the variable names used in the formula expression.

pub fn parameters(&self) -> &BTreeMap<String, DoubleConstant>

Named fitting parameters and their initial guesses. Keys must match the parameter names used in the formula expression; values are the starting points passed to the optimizer. The target the curve is fit against is the y of the enclosing curve fit (the timeSeries series values, or the scatter y series).

Trait Implementations

impl Clone for CustomCurveFit

fn clone(&self) -> CustomCurveFit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomCurveFit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomCurveFit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CustomCurveFit

impl From<CustomCurveFit> for Builder<Complete>

fn from(v: CustomCurveFit) -> Self

Converts to this type from the input type.

impl Hash for CustomCurveFit

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CustomCurveFit

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CustomCurveFit

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CustomCurveFit

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for CustomCurveFit

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

where __S: Serializer,

Serialize this value into the given Serde serializer.