Struct BitGene 

pub struct BitGene { /* private fields */ }

A gene that represents a single bit. The allele is a bool that is randomly assigned. The allele is either true or false. This is the simplest form of a gene and in traditional genetic algorithms is the gene that is used to represent the individuals.

Example

use radiate_core::*;

// Craete a new BitGene from the allele `true`.
let gene: BitGene = true.into();

// Create a new BitGene with a random allele.
let gene = BitGene::new();

// Get the allele (bool) of the BitGene.
let allele = gene.allele();

// Create a new BitGene from the allele.
let gene = gene.with_allele(allele);

Implementations

impl BitGene

pub fn new() -> BitGene

Create a new BitGene with a random allele.

Trait Implementations

impl Clone for BitGene

fn clone(&self) -> BitGene

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BitGene

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for BitGene

fn default() -> BitGene

Returns the “default value” for a type.

impl Display for BitGene

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<BitGene> for BitChromosome

fn from(gene: BitGene) -> BitChromosome

Converts to this type from the input type.

impl From<bool> for BitGene

fn from(allele: bool) -> BitGene

Converts to this type from the input type.

impl FromIterator<BitGene> for BitChromosome

fn from_iter<I>(iter: I) -> BitChromosome

where I: IntoIterator<Item = BitGene>,

Creates a value from an iterator.

impl Gene for BitGene

Implement the Gene trait for the BitGene. This allows the BitGene to be used in a Chromosome - specifically the BitChromosome, thus allowing the BitGene to be used in the GeneticEngine.

type Allele = bool

fn allele(&self) -> &bool

Get the allele of the Gene. This is the value that the Gene represents or “expresses”.

fn allele_mut(&mut self) -> &mut bool

Get a mutable reference to the allele of the Gene.

fn new_instance(&self) -> BitGene

Create a new instance of the Gene.

fn with_allele(&self, allele: &bool) -> BitGene

Create a new Gene with the given allele.

impl PartialEq for BitGene

fn eq(&self, other: &BitGene) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Valid for BitGene

Because a BitGene is either true or false it is always valid.

fn is_valid(&self) -> bool

impl StructuralPartialEq for BitGene