#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum SolveStatus {
Converged,
NotConverged,
Breakdown,
}
impl SolveStatus {
#[must_use]
pub fn is_converged(self) -> bool {
self == SolveStatus::Converged
}
}
impl core::fmt::Display for SolveStatus {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
let text = match self {
SolveStatus::Converged => "converged",
SolveStatus::NotConverged => "not converged",
SolveStatus::Breakdown => "breakdown",
};
f.write_str(text)
}
}
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct SolveReport<T> {
pub status: SolveStatus,
pub iterations: usize,
pub residual: T,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn only_converged_is_converged() {
assert!(SolveStatus::Converged.is_converged());
assert!(!SolveStatus::NotConverged.is_converged());
assert!(!SolveStatus::Breakdown.is_converged());
}
}