evolve 0.2.0

A generic, composable genetic algorithm framework for 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

/// All the context needed by genetic operators during execution.
///
/// Bundles references to the fitness evaluator, random number generator, and
/// fitness comparator so operators can evaluate new individuals, generate
/// random values, and compare fitness without owning these resources.
///
/// # Examples
///
/// ```
/// use evolve::core::context::Context;
/// use evolve::fitness::Maximize;
///
/// let fitness_fn = |g: &[u8; 2]| g[0] as u16 + g[1] as u16;
/// let mut rng = rand::rng();
/// # #[cfg(not(feature = "parallel"))]
/// let ctx = Context::new(&fitness_fn, &mut rng, &Maximize);
/// # #[cfg(feature = "parallel")]
/// # let runtime = pooled::Runtime::new(1);
/// # #[cfg(feature = "parallel")]
/// # let ctx = Context::new(&fitness_fn, &mut rng, &Maximize, &runtime);
/// ```
pub struct Context<'a, Fe, R, C> {
    fitness: &'a Fe,
    rng: &'a mut R,
    comparator: &'a C,
    #[cfg(feature = "parallel")]
    runtime: &'a pooled::Runtime,
}

impl<'a, Fe, R, C> Context<'a, Fe, R, C> {
    /// Create a new `Context`.
    #[cfg(not(feature = "parallel"))]
    pub fn new(fitness: &'a Fe, rng: &'a mut R, comparator: &'a C) -> Self {
        Self {
            fitness,
            rng,
            comparator,
        }
    }

    /// Create a new `Context` with a thread pool runtime for parallel operations.
    #[cfg(feature = "parallel")]
    pub fn new(
        fitness: &'a Fe,
        rng: &'a mut R,
        comparator: &'a C,
        runtime: &'a pooled::Runtime,
    ) -> Self {
        Self {
            fitness,
            rng,
            comparator,
            runtime,
        }
    }

    /// Get the `FitnessEvaluator`.
    pub fn fitness_evaluator(&self) -> &Fe {
        self.fitness
    }

    /// Get the `Rng` object.
    pub fn rng(&mut self) -> &mut R {
        self.rng
    }

    /// Get the goal for the problem.
    pub fn comparator(&self) -> &C {
        self.comparator
    }

    /// Get the thread pool for parallel operations.
    #[cfg(feature = "parallel")]
    pub fn pool(&self) -> pooled::map::MapPool<'_> {
        self.runtime.map_pool()
    }

    /// Get the runtime for parallel operations.
    #[cfg(feature = "parallel")]
    pub fn runtime(&self) -> &pooled::Runtime {
        self.runtime
    }
}