Struct PolynomialCurveFit 

pub struct PolynomialCurveFit { /* private fields */ }

A polynomial fit of the enclosing target (y) against the chosen independent variable (x).

Implementations

impl PolynomialCurveFit

pub fn builder() -> Builder<IndependentVariableStage>

Returns a new builder.

impl PolynomialCurveFit

pub fn new( independent_variable: CurveFitVariable, degree: IntegerConstant, ) -> PolynomialCurveFit

Constructs a new instance of the type.

pub fn independent_variable(&self) -> &CurveFitVariable

The x axis the target is fit against — either relative sample time or another series.

pub fn degree(&self) -> &IntegerConstant

The highest allowable degree of the fit polynomial.

pub fn intercept(&self) -> Option<&DoubleConstant>

The y-value at the point x (or t) = 0. If omitted, the y-intercept will also be fit to the data.

Trait Implementations

impl Clone for PolynomialCurveFit

fn clone(&self) -> PolynomialCurveFit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolynomialCurveFit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PolynomialCurveFit

fn deserialize<__D>( __deserializer: __D, ) -> Result<PolynomialCurveFit, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PolynomialCurveFit

impl From<PolynomialCurveFit> for Builder<Complete>

fn from(v: PolynomialCurveFit) -> Builder<Complete>

Converts to this type from the input type.

impl Hash for PolynomialCurveFit

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

where H: Hasher,

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 PolynomialCurveFit

fn cmp(&self, other: &PolynomialCurveFit) -> 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 PolynomialCurveFit

fn eq(&self, other: &PolynomialCurveFit) -> 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 PartialOrd for PolynomialCurveFit

fn partial_cmp(&self, other: &PolynomialCurveFit) -> 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 PolynomialCurveFit

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

where __S: Serializer,

Serialize this value into the given Serde serializer.