fitme 1.1.0

CLI curve fitting tool. Parameterise an equation from a CSV dataset.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

//! Mathematical expression parsing and evaluation.

use super::*;
use data::{DataRow, Headers};

pub mod v1;

/// Parse and solve a mathematical expression.
pub trait Equation: Sized {
    /// Parse a text expression into an expression.
    fn parse(expr: &str, columns: &Headers) -> Result<Self>;

    /// The number of free parameters.
    fn params_len(&self) -> usize;

    /// Evaluate the expression with the given set of parameters and a single data row.
    fn solve(&self, params: &[f64], row: DataRow) -> Option<f64>;

    /// Fetch the string form of the expression, if it exists.
    fn expr(&self) -> Option<String>;

    /// Extract out the parameter names.
    fn params(&self) -> Vec<String>;

    /// Extract out the variable names.
    fn vars(&self) -> Vec<String>;
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn distinct_params_and_vars() {
        fn test<E: Equation>() {
            let e = E::parse("x * x + d + d", &Headers::from_iter(["d"])).unwrap();

            assert_eq!(e.params(), vec!["x".to_string()]);
            assert_eq!(e.vars(), vec!["d".to_string()]);
        }

        test::<v1::Eq>();
    }
}