Struct genetic_algorithm::strategy::hill_climb::HillClimbBuilder

pub struct HillClimbBuilder<G: IncrementalGenotype, F: Fitness<Allele = G::Allele>, SR: HillClimbReporter<Allele = G::Allele>> {
    pub genotype: Option<G>,
    pub variant: Option<HillClimbVariant>,
    pub fitness: Option<F>,
    pub fitness_ordering: FitnessOrdering,
    pub par_fitness: bool,
    pub max_stale_generations: Option<usize>,
    pub target_fitness_score: Option<FitnessValue>,
    pub valid_fitness_score: Option<FitnessValue>,
    pub replace_on_equal_fitness: bool,
    pub reporter: SR,
    pub rng_seed: Option<u64>,
}

The builder for an HillClimb struct.

Fields

genotype: Option<G>

variant: Option<HillClimbVariant>

fitness: Option<F>

fitness_ordering: FitnessOrdering

par_fitness: bool

max_stale_generations: Option<usize>

target_fitness_score: Option<FitnessValue>

valid_fitness_score: Option<FitnessValue>

replace_on_equal_fitness: bool

reporter: SR

rng_seed: Option<u64>

Implementations

impl<G: IncrementalGenotype, F: Fitness<Allele = G::Allele>> Builder<G, F, HillClimbReporterNoop<G::Allele>>

pub fn new() -> Self

impl<G: IncrementalGenotype, F: Fitness<Allele = G::Allele>, SR: HillClimbReporter<Allele = G::Allele>> Builder<G, F, SR>

pub fn build(self) -> Result<HillClimb<G, F, SR>, TryFromBuilderError>

pub fn with_genotype(self, genotype: G) -> Self

pub fn with_variant(self, variant: HillClimbVariant) -> Self

pub fn with_fitness_ordering(self, fitness_ordering: FitnessOrdering) -> Self

pub fn with_par_fitness(self, par_fitness: bool) -> Self

pub fn with_fitness(self, fitness: F) -> Self

pub fn with_max_stale_generations(self, max_stale_generations: usize) -> Self

pub fn with_max_stale_generations_option( self, max_stale_generations_option: Option<usize>, ) -> Self

pub fn with_target_fitness_score( self, target_fitness_score: FitnessValue, ) -> Self

pub fn with_target_fitness_score_option( self, target_fitness_score_option: Option<FitnessValue>, ) -> Self

pub fn with_valid_fitness_score(self, valid_fitness_score: FitnessValue) -> Self

pub fn with_valid_fitness_score_option( self, valid_fitness_score_option: Option<FitnessValue>, ) -> Self

pub fn with_replace_on_equal_fitness( self, replace_on_equal_fitness: bool, ) -> Self

pub fn with_reporter<SR2: HillClimbReporter<Allele = G::Allele>>( self, reporter: SR2, ) -> Builder<G, F, SR2>

pub fn with_rng_seed_from_u64(self, rng_seed: u64) -> Self

pub fn with_rng_seed_from_u64_option(self, rng_seed_option: Option<u64>) -> Self

impl<G: IncrementalGenotype, F: Fitness<Allele = G::Allele>, SR: HillClimbReporter<Allele = G::Allele>> Builder<G, F, SR>

pub fn rng(&self) -> SmallRng

pub fn call(self) -> Result<HillClimb<G, F, SR>, TryFromBuilderError>

pub fn call_repeatedly( self, max_repeats: usize, ) -> Result<HillClimb<G, F, SR>, TryFromBuilderError>

pub fn call_par_repeatedly( self, max_repeats: usize, ) -> Result<HillClimb<G, F, SR>, TryFromBuilderError>

Trait Implementations

impl<G: Clone + IncrementalGenotype, F: Clone + Fitness<Allele = G::Allele>, SR: Clone + HillClimbReporter<Allele = G::Allele>> Clone for Builder<G, F, SR>

fn clone(&self) -> Builder<G, F, SR>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G: Debug + IncrementalGenotype, F: Debug + Fitness<Allele = G::Allele>, SR: Debug + HillClimbReporter<Allele = G::Allele>> Debug for Builder<G, F, SR>

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

Formats the value using the given formatter.

impl<G: IncrementalGenotype, F: Fitness<Allele = G::Allele>> Default for Builder<G, F, HillClimbReporterNoop<G::Allele>>

fn default() -> Self

Returns the “default value” for a type.

impl<G: IncrementalGenotype, F: Fitness<Allele = G::Allele>, SR: HillClimbReporter<Allele = G::Allele>> TryFrom<Builder<G, F, SR>> for HillClimb<G, F, SR>

type Error = TryFromBuilderError

The type returned in the event of a conversion error.

fn try_from(builder: HillClimbBuilder<G, F, SR>) -> Result<Self, Self::Error>

Performs the conversion.