iter-solver 0.4.0

A rust crate provide flexible and general iterative algorithm framework.
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

//! Error types.

use core::time::Duration;

use thiserror::Error;

use crate::IterState;

/// Error indicating that the solver reached the maximum iteration.
///
/// This error occurs when the solver exceeds the specified maximum number of iterations
/// without reaching termination condition. It contains both the iteration limit that was
/// reached and the final state the solver had achieved when the limit was exceeded.
#[derive(Clone, Debug, Error)]
#[error("Solver reached the maximum iteration: {max_iteration}.")]
pub struct MaxIterationReached<State: IterState> {
    /// The maximum iteration count that was reached.
    pub max_iteration: u64,
    /// The final state of the solver at the time the iteration limit was reached.
    pub(crate) final_state: State,
}

impl<State: IterState> MaxIterationReached<State> {
    /// Consumes self and returns the final state reached by the solver.
    pub fn into_final_state(self) -> State {
        self.final_state
    }

    /// Returns an immutable reference to the final state reached by the solver.
    pub fn final_state_ref(&self) -> &State {
        &self.final_state
    }

    /// Directly obtains [`IterState::Solution`] from the final state reached by the solver.
    pub fn into_solution(self) -> State::Solution {
        self.final_state.into_sol()
    }
}

/// Error indicating that the solver timed out before completing.
///
/// This error occurs when the solver exceeds the specified time limit without
/// reaching a termination condition. It contains both the timeout duration and
/// the final state the solver had reached when the timeout occurred.
#[derive(Clone, Debug, Error)]
#[error("Solver timeout: {}ms or {}s", timeout.as_millis(), timeout.as_secs_f64())]
pub struct TimeOut<State: IterState> {
    /// The time limit that was reached.
    pub timeout: Duration,
    /// The final state of the solver at the time of timeout.
    pub(crate) final_state: State,
}

impl<State: IterState> TimeOut<State> {
    /// Consumes self and returns the final state reached by the solver.
    pub fn into_final_state(self) -> State {
        self.final_state
    }

    /// Returns an immutable reference to the final state reached by the solver.
    pub fn final_state_ref(&self) -> &State {
        &self.final_state
    }

    /// Directly obtains [`IterState::Solution`] from the final state reached by the solver.
    pub fn into_solution(self) -> State::Solution {
        self.final_state.into_sol()
    }
}