genetic_algorithms 3.0.0

Library for solving genetic algorithm problems
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

//! Common interface over all search strategy engines.
//! Enables runtime algorithm swapping via `Box<dyn Strategy<U>>`.

use crate::error::GaError;
use crate::traits::ChromosomeT;

/// Common interface over all search strategy engines. Enables runtime algorithm swapping via `Box<dyn Strategy<U>>`.
///
/// # Examples
///
/// ```rust,no_run
/// use genetic_algorithms::traits::Strategy;
/// use genetic_algorithms::chromosomes::Binary;
/// use genetic_algorithms::error::GaError;
///
/// struct MyStrategy;
///
/// impl Strategy<Binary> for MyStrategy {
///     fn run(&mut self) -> Result<(), GaError> { Ok(()) }
///     fn best(&self) -> Option<&Binary> { None }
/// }
/// ```
pub trait Strategy<U: ChromosomeT> {
    /// Execute the search loop. Mutates internal state.
    fn run(&mut self) -> Result<(), GaError>;
    /// Returns the best candidate found, or `None` if `run()` has not been called.
    fn best(&self) -> Option<&U>;
}