ganesh 0.26.0

Minimization and sampling in Rust, simplified
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

use dyn_clone::DynClone;

use crate::traits::{Algorithm, Status, Terminator};
use std::ops::ControlFlow;

/// A trait for abort signals.
/// This trait is used in minimizers to check if the user has requested to abort the calculation.
pub trait AbortSignal: DynClone + Send + Sync {
    /// Return `true` if the user has requested to abort the calculation.
    fn is_aborted(&self) -> bool;
    /// Abort the calculation. Make `is_aborted()` return `true`.
    fn abort(&self);
    /// Reset the abort signal. Make `is_aborted()` return `false`.
    fn reset(&self);
}
dyn_clone::clone_trait_object!(AbortSignal);

impl<T, A, P, S, U, E, C> Terminator<A, P, S, U, E, C> for T
where
    T: AbortSignal,
    A: Algorithm<P, S, U, E, Config = C>,
    S: Status,
{
    fn check_for_termination(
        &mut self,
        _current_step: usize,
        _algorithm: &mut A,
        _problem: &P,
        _status: &mut S,
        _args: &U,
        _config: &C,
    ) -> ControlFlow<()> {
        if self.is_aborted() {
            self.reset();
            return ControlFlow::Break(());
        }
        ControlFlow::Continue(())
    }
}