argmin 0.11.0

Numerical optimization in pure 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
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131

// Copyright 2018-2024 argmin developers
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

#[cfg(feature = "serde1")]
use serde::{Deserialize, Serialize};

/// Status of optimization execution
#[derive(Debug, Clone, Eq, PartialEq, Hash, Default)]
#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]
pub enum TerminationStatus {
    /// Execution is terminated
    Terminated(TerminationReason),
    /// Execution is running
    #[default]
    NotTerminated,
}

impl TerminationStatus {
    /// Returns `true` if a solver terminated and `false` otherwise.
    ///
    /// # Example
    ///
    /// ```
    /// use argmin::core::{TerminationStatus, TerminationReason};
    ///
    /// assert!(TerminationStatus::Terminated(TerminationReason::MaxItersReached).terminated());
    /// assert!(TerminationStatus::Terminated(TerminationReason::TargetCostReached).terminated());
    /// assert!(TerminationStatus::Terminated(TerminationReason::SolverConverged).terminated());
    /// assert!(TerminationStatus::Terminated(TerminationReason::Interrupt).terminated());
    /// assert!(TerminationStatus::Terminated(TerminationReason::Timeout).terminated());
    /// assert!(TerminationStatus::Terminated(TerminationReason::SolverExit("Exit reason".to_string())).terminated());
    /// ```
    pub fn terminated(&self) -> bool {
        matches!(self, TerminationStatus::Terminated(_))
    }
}

impl std::fmt::Display for TerminationStatus {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            TerminationStatus::Terminated(reason) => f.write_str(reason.text()),
            TerminationStatus::NotTerminated => f.write_str("Running"),
        }
    }
}

/// Reasons for optimization algorithms to stop
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
#[cfg_attr(feature = "serde1", derive(Serialize, Deserialize))]
pub enum TerminationReason {
    /// Reached maximum number of iterations
    MaxItersReached,
    /// Reached target cost function value
    TargetCostReached,
    /// Algorithm manually interrupted with SIGINT (Ctrl+C), SIGTERM or SIGHUP
    Interrupt,
    /// Converged
    SolverConverged,
    /// Timeout reached
    Timeout,
    /// Solver exit with given reason
    SolverExit(String),
}

impl TerminationReason {
    /// Returns a textual representation of what happened.
    ///
    /// # Example
    ///
    /// ```
    /// use argmin::core::TerminationReason;
    ///
    /// assert_eq!(
    ///     TerminationReason::MaxItersReached.text(),
    ///     "Maximum number of iterations reached"
    /// );
    /// assert_eq!(
    ///     TerminationReason::TargetCostReached.text(),
    ///     "Target cost value reached"
    /// );
    /// assert_eq!(
    ///     TerminationReason::Interrupt.text(),
    ///     "Interrupt"
    /// );
    /// assert_eq!(
    ///     TerminationReason::SolverConverged.text(),
    ///     "Solver converged"
    /// );
    /// assert_eq!(
    ///     TerminationReason::Timeout.text(),
    ///     "Timeout reached"
    /// );
    /// assert_eq!(
    ///     TerminationReason::SolverExit("Aborted".to_string()).text(),
    ///     "Aborted"
    /// );
    /// ```
    pub fn text(&self) -> &str {
        match self {
            TerminationReason::MaxItersReached => "Maximum number of iterations reached",
            TerminationReason::TargetCostReached => "Target cost value reached",
            TerminationReason::Interrupt => "Interrupt",
            TerminationReason::SolverConverged => "Solver converged",
            TerminationReason::Timeout => "Timeout reached",
            TerminationReason::SolverExit(reason) => reason.as_ref(),
        }
    }
}

impl std::fmt::Display for TerminationReason {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{}", self.text())
    }
}

impl Default for TerminationReason {
    fn default() -> Self {
        TerminationReason::SolverExit("Undefined".to_string())
    }
}

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

    send_sync_test!(termination_reason, TerminationReason);
}