resopt 0.3.0

Declarative constrained residual optimization in Rust
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

/// Solve diagnostics intended for expert users.
#[derive(Debug, Clone, PartialEq)]
pub struct SolveDiagnostics {
    iterations: usize,
    termination_reason: String,
    solve_time_seconds: f64,
    max_constraint_violation: Option<f64>,
}

impl SolveDiagnostics {
    pub fn new(
        iterations: usize,
        termination_reason: String,
        solve_time_seconds: f64,
        max_constraint_violation: Option<f64>,
    ) -> Self {
        Self {
            iterations,
            termination_reason,
            solve_time_seconds,
            max_constraint_violation,
        }
    }

    pub fn iterations(&self) -> usize {
        self.iterations
    }

    pub fn termination_reason(&self) -> &str {
        &self.termination_reason
    }

    pub fn solve_time_seconds(&self) -> f64 {
        self.solve_time_seconds
    }

    pub fn max_constraint_violation(&self) -> Option<f64> {
        self.max_constraint_violation
    }
}

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

    #[test]
    fn accessors() {
        let d = SolveDiagnostics::new(42, "converged".into(), 0.5, Some(1e-10));
        assert_eq!(d.iterations(), 42);
        assert_eq!(d.termination_reason(), "converged");
        assert!((d.solve_time_seconds() - 0.5).abs() < f64::EPSILON);
        assert!((d.max_constraint_violation().unwrap() - 1e-10).abs() < f64::EPSILON);
    }

    #[test]
    fn no_violation() {
        let d = SolveDiagnostics::new(0, "n/a".into(), 0.0, None);
        assert!(d.max_constraint_violation().is_none());
    }

    #[test]
    fn clone_and_eq() {
        let a = SolveDiagnostics::new(1, "done".into(), 0.01, None);
        assert_eq!(a, a.clone());
    }
}