Struct ferrilab::CurveFit

pub struct CurveFit<F: Fn(&f64, &[f64]) -> f64> { /* private fields */ }

Object to create a CurveFit with all required parameters.

Implementations

impl<F: Fn(&f64, &[f64]) -> f64> CurveFit<F>

pub fn new( model: F, x_values: impl Into<Vec<f64>>, y_values: impl Into<Vec<f64>> ) -> Self

Constructs a new CurveFit with some default values that can be changed.

pub fn initial_point(self, initial_point: impl Into<Vec<f64>>) -> Self

Initial points required for calculating the curve fit.

pub fn y_error(self, yerr: Vec<f64>) -> Self

If passed, calculates the weigthed curve fit considaring the y error.

pub fn max_iterations(self, max_iterations: impl Into<Option<usize>>) -> Self

In case you want the curve fit algorithm to stop at some point, by default None.

pub fn initial_zeros(self, number_of_components: usize) -> Self

Set initial points to zero.

pub fn initial_ones(self, number_of_components: usize) -> Self

Set initial points to one.

pub fn tolerance(self, tol: impl Into<f64>) -> Self

Custom precision on the curve fit, by default 1e-6.

pub fn initial_simplex_scale(self, scale: impl Into<f64>) -> Self

Generates n+1 points using the initial one for calculating the curve fit, by default 0.5. If the scale is a lot smaller than the expected value of the coeficients it may result in errors in the fit.

pub fn fit(&self) -> Vec<Measure>

Takes the arbitrary function and aproximates to the curve using every parameter established.

pub fn r_value(&self) -> f64

Trait Implementations

impl<F: Clone + Fn(&f64, &[f64]) -> f64> Clone for CurveFit<F>

fn clone(&self) -> CurveFit<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Fn(&f64, &[f64]) -> f64> Debug for CurveFit<F>

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

Formats the value using the given formatter.