genetic_algorithms 2.2.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
29
30
31
32
33
34
35
36

//! Gene trait definition.
//!
//! The [`GeneT`] trait is the smallest building block of a chromosome. Every
//! gene carries an integer ID (used for allele identity and duplicate
//! detection) and must be cloneable and thread-safe.

/// Trait that every gene type must implement.
///
/// A gene is a single element inside a chromosome's DNA. Implementations
/// must provide [`GeneT::set_id`]; the remaining methods have sensible
/// defaults.
///
/// # Required bounds
///
/// `Default + Clone + Sync + Send` — genes are created in bulk during
/// initialization and shared across threads by rayon.
pub trait GeneT: Default + Clone + Sync + Send {
    /// Creates a new gene using `Default::default()`.
    fn new() -> Self {
        Default::default()
    }
    /// Returns a gene with its ID reset to `-1` (sentinel / unset value).
    fn default(mut self) -> Self {
        self.set_id(-1);
        self
    }
    /// Returns the gene's integer identifier.
    ///
    /// The default implementation returns `0`; override this when your gene
    /// type carries meaningful identity (e.g., allele index).
    fn id(&self) -> i32 {
        0
    }
    /// Sets the gene's integer identifier and returns a mutable reference to `self`.
    fn set_id(&mut self, id: i32) -> &mut Self;
}