tpt_math_numeric/
report.rs1#[derive(Clone, Copy, Debug, PartialEq, Eq)]
5#[non_exhaustive]
6pub enum SolveStatus {
7 Converged,
9 NotConverged,
11 Breakdown,
13}
14
15impl SolveStatus {
16 #[must_use]
18 pub fn is_converged(self) -> bool {
19 self == SolveStatus::Converged
20 }
21}
22
23impl core::fmt::Display for SolveStatus {
24 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
25 let text = match self {
26 SolveStatus::Converged => "converged",
27 SolveStatus::NotConverged => "not converged",
28 SolveStatus::Breakdown => "breakdown",
29 };
30 f.write_str(text)
31 }
32}
33
34#[derive(Clone, Copy, Debug, PartialEq)]
41pub struct SolveReport<T> {
42 pub status: SolveStatus,
44 pub iterations: usize,
46 pub residual: T,
48}
49
50#[cfg(test)]
51mod tests {
52 use super::*;
53
54 #[test]
55 fn only_converged_is_converged() {
56 assert!(SolveStatus::Converged.is_converged());
57 assert!(!SolveStatus::NotConverged.is_converged());
58 assert!(!SolveStatus::Breakdown.is_converged());
59 }
60}