ommx 3.0.0-beta.5

Open Mathematical prograMming eXchange (OMMX)
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use std::ops::Div;

use super::operation::{binary_operation, BinaryOperator};
use super::*;
use crate::CoefficientError;

impl Div<Coefficient> for Function {
    type Output = Result<Self, CoefficientError>;

    fn div(self, rhs: Coefficient) -> Self::Output {
        Ok(binary_operation(
            BinaryOperator::Div,
            self,
            Function::Constant(rhs),
        ))
    }
}

impl Div for Function {
    type Output = Result<Self, CoefficientError>;

    fn div(self, rhs: Self) -> Self::Output {
        Ok(binary_operation(BinaryOperator::Div, self, rhs))
    }
}

impl Div for &Function {
    type Output = Result<Function, CoefficientError>;

    fn div(self, rhs: Self) -> Self::Output {
        self.clone() / rhs.clone()
    }
}

impl Div<Function> for &Function {
    type Output = Result<Function, CoefficientError>;

    fn div(self, rhs: Function) -> Self::Output {
        self.clone() / rhs
    }
}

impl Div<&Function> for Function {
    type Output = Result<Function, CoefficientError>;

    fn div(self, rhs: &Function) -> Self::Output {
        self / rhs.clone()
    }
}

impl Div<&Coefficient> for Function {
    type Output = Result<Self, CoefficientError>;

    fn div(self, rhs: &Coefficient) -> Self::Output {
        self / *rhs
    }
}

impl Div<Coefficient> for &Function {
    type Output = Result<Function, CoefficientError>;

    fn div(self, rhs: Coefficient) -> Self::Output {
        self.clone() / rhs
    }
}

impl Div<&Coefficient> for &Function {
    type Output = Result<Function, CoefficientError>;

    fn div(self, rhs: &Coefficient) -> Self::Output {
        self.clone() / *rhs
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{ATol, Evaluate, FunctionEvaluationError};
    use ::approx::assert_abs_diff_eq;
    use proptest::prelude::*;

    proptest! {
        #[test]
        fn div_ref(a in any::<Function>(), c in any::<Coefficient>()) {
            if let Ok(expected) = a.clone() / c {
                let c_ref = &c;
                assert_abs_diff_eq!((&a / c).unwrap(), expected);
                assert_abs_diff_eq!((a.clone() / c_ref).unwrap(), expected);
                assert_abs_diff_eq!((&a / c_ref).unwrap(), expected);
            }
        }

        #[test]
        fn zero(a in any::<Coefficient>()) {
            let divided = (Function::zero() / a).unwrap();
            prop_assert!(matches!(divided, Function::Expression(_)));
        }
    }

    #[test]
    fn function_division_defers_tolerance_sensitive_zero_classification() {
        let tiny = Coefficient::try_from(f64::from_bits(1)).unwrap();
        let divided = (Function::from(tiny) / tiny).unwrap();
        assert!(matches!(&divided, Function::Expression(_)));

        let error = divided
            .evaluate(
                &crate::v1::State::default(),
                ATol::new(f64::from_bits(1)).unwrap(),
            )
            .unwrap_err();
        assert!(matches!(
            error.downcast_ref::<FunctionEvaluationError>(),
            Some(FunctionEvaluationError::DivisionByZero)
        ));
    }
}