Struct FloatGene 

pub struct FloatGene<F: Float> { /* private fields */ }

Minimum and maximum values for the FloatGene allele. This should be large enough to cover most practical use cases but small enough to avoid overflow or underflow issues in calculations. 1e18 = 1 quintillion A Gene that represents a floating point number. The allele is the in the case of the FloatGene a f32. The min and max values default to [MIN] and [MAX] respectively. The min and max values are used to generate a random number between the min and max values, which is the allele of the FloatGene. The upper_bound and lower_bound are used to set the bounds of the FloatGene when it is used in a BoundGene context (crossover or mutation). The upper_bound and lower_bound default to [MAX] and [MIN] respectively.

Example

use radiate_core::*;

// Create a new FloatGene with a min value of 0 and a max value of 1 meaning the
// allele will be a random number between 0 and 1.
// The upper_bound and lower_bound are set to 0 and 1 respectively.
let gene = FloatGene::from(0_f32..1_f32);

// Create a new FloatGene with a min of 0 and a max of 1 and set the upper_bound
// and lower_bound to 0 and 100 respectively.
let gene = FloatGene::from((0_f32..1_f32, 0_f32..100_f32));

Implementations

impl<F: Float> FloatGene<F>

pub fn new(allele: F, value_range: Range<F>, bounds: Range<F>) -> Self

Creates a new FloatGene with the given allele, value_range, and bounds.

Trait Implementations

impl<F: Float> Add for FloatGene<F>

type Output = FloatGene<F>

The resulting type after applying the + operator.

fn add(self, other: FloatGene<F>) -> FloatGene<F>

Performs the + operation.

impl<F: Float> ArithmeticGene for FloatGene<F>

fn mean(&self, other: &FloatGene<F>) -> FloatGene<F>

impl<F: Float> BoundedGene for FloatGene<F>

fn min(&self) -> &Self::Allele

fn max(&self) -> &Self::Allele

fn bounds(&self) -> (&Self::Allele, &Self::Allele)

impl<F: Clone + Float> Clone for FloatGene<F>

fn clone(&self) -> FloatGene<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Float> Debug for FloatGene<F>

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

Formats the value using the given formatter.

impl<F: Float> Default for FloatGene<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float> Display for FloatGene<F>

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

Formats the value using the given formatter.

impl<F: Float> Div for FloatGene<F>

type Output = FloatGene<F>

The resulting type after applying the / operator.

fn div(self, other: FloatGene<F>) -> FloatGene<F>

Performs the / operation.

impl<F: Float> From<(Range<F>, Range<F>)> for FloatGene<F>

fn from((value_range, bounds): (Range<F>, Range<F>)) -> Self

Converts to this type from the input type.

impl<F: Float> From<F> for FloatGene<F>

fn from(allele: F) -> Self

Converts to this type from the input type.

impl<F: Float> From<FloatGene<F>> for FloatChromosome<F>

fn from(gene: FloatGene<F>) -> Self

Converts to this type from the input type.

impl<F: Float> From<Range<F>> for FloatGene<F>

fn from(range: Range<F>) -> Self

Converts to this type from the input type.

impl<F: Float> FromIterator<FloatGene<F>> for FloatChromosome<F>

fn from_iter<I: IntoIterator<Item = FloatGene<F>>>(iter: I) -> Self

Creates a value from an iterator.

impl<F: Float> Gene for FloatGene<F>

type Allele = F

fn allele(&self) -> &F

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

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

Get a mutable reference to the allele of the Gene.

fn new_instance(&self) -> FloatGene<F>

Create a new instance of the Gene.

fn with_allele(&self, allele: &F) -> FloatGene<F>

Create a new Gene with the given allele.

impl<F: Float> Mul for FloatGene<F>

type Output = FloatGene<F>

The resulting type after applying the * operator.

fn mul(self, other: FloatGene<F>) -> FloatGene<F>

Performs the * operation.

impl<F: PartialEq + Float> PartialEq for FloatGene<F>

fn eq(&self, other: &FloatGene<F>) -> 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<F: Float> Sub for FloatGene<F>

type Output = FloatGene<F>

The resulting type after applying the - operator.

fn sub(self, other: FloatGene<F>) -> FloatGene<F>

Performs the - operation.

impl<F: Float> Valid for FloatGene<F>

Implement the Valid trait for the FloatGene.

The is_valid method checks if the allele of the FloatGene is between the min and max values. The GeneticEngine will check the validity of the Chromosome and Phenotype and remove any invalid individuals from the population, replacing them with new individuals at the given generation.

fn is_valid(&self) -> bool

impl<F: Float> StructuralPartialEq for FloatGene<F>