tepichord/GEMLA
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Adding doc comments for genetic_state

Browse source
This commit is contained in:
vandomej 2021-08-17 21:12:24 -07:00
parent b59ded5f5f
commit 01b0afc20b
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
gemla/src/bracket/genetic_state.rs
View file

@ -1,11 +1,23 @@
//! An enum used to control the state of a [`GeneticNode`]
//!
//! [`GeneticNode`]: crate::bracket::genetic_node
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
/// An enum used to control the state of a [`GeneticNode`]
///
/// [`GeneticNode`]: crate::bracket::genetic_node
#[derive(Clone, Debug, Serialize, Deserialize, Copy)] #[derive(Clone, Debug, Serialize, Deserialize, Copy)]
#[serde(tag = "enumType", content = "enumContent")] #[serde(tag = "enumType", content = "enumContent")]
pub enum GeneticState { pub enum GeneticState {
/// The node and it's data have not finished initializing
Initialize, Initialize,
/// The node is currently simulating a round against target data to determine the fitness of the population
Simulate, Simulate,
/// The node is currently selecting members of the population that scored well and reducing the total population size
Score, Score,
/// The node is currently mutating members of it's population and breeding new members
Mutate, Mutate,
/// The node has finished processing for a given number of iterations
Finish, Finish,
} }