parametrizer 1.2.0

A simple, safe crate for parsing properly-formatted math strings representing parametric functions into Rust functions.
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

use rand::Rng;
use crate::Number;
use super::Term;

///A term which computes a random value each time it is called
pub struct RandomTerm<T: Number>
{

    min: Box<dyn Term<T> + Send + Sync>,
    max: Box<dyn Term<T> + Send + Sync>

}

impl<T: Number> RandomTerm<T>
{

    ///A term which randomly generates values between the given min and max terms
    ///
    /// # Examples
    ///
    /// ```
    /// use crate::parametrizer::term::randomterm::RandomTerm;
    /// use crate::parametrizer::term::variableterm::VariableTerm;
    /// use crate::parametrizer::term::constantterm::ConstantTerm;
    /// use crate::parametrizer::term::Term;
    ///
    /// let const1 = ConstantTerm::new(6);
    /// let const2 = ConstantTerm::new(10);
    /// let const3 = ConstantTerm::new(2.5);
    /// let variable = VariableTerm::new();
    ///
    /// let rand1 = RandomTerm::new(Box::new(const1), Box::new(const2));
    /// let rand2 = RandomTerm::new(Box::new(const3), Box::new(variable));
    ///
    /// assert!(rand1.evaluate(2) < 10);
    /// assert!(rand1.evaluate(9) >= 6);
    /// assert!(rand2.evaluate(3.0) >= 2.5);
    /// assert!(rand2.evaluate(15.0) < 15.0);
    /// ```
    pub fn new(min: Box<dyn Term<T> + Send + Sync>, max: Box<dyn Term<T> + Send + Sync>) -> RandomTerm<T>
    {

        return RandomTerm {min, max};

    }

}

impl<T: Number> Term<T> for RandomTerm<T>
{

    ///Generates a random value between the min and max terms
    ///
    /// # Panics
    /// Panics if min is not less than max
    fn evaluate(&self, t: T) -> T
    {

        let mut rng = rand::thread_rng();

        let minimum = self.min.evaluate(t).to_f64().expect("Unable to convert generic type to f64 for random generation.");
        let maximum = self.max.evaluate(t).to_f64().expect("Unable to convert generic type to f64 for random generation.");

        if minimum >= maximum
        {

            panic!("Minimum is not smaller than maximum when attempting to generate a random value in parametrized RandomTerm.");

        }

        let random = rng.gen_range(minimum..maximum);

        return T::from_f64(random).expect("Unable to convert f64 to generic type after random generation.");

    }

}