Package net.bmahe.genetics4j.core.spec

Class ImmutableEAConfigurationBulkAsync<T extends Comparable<T>>

java.lang.Object

net.bmahe.genetics4j.core.spec.AbstractEAConfiguration<T>

net.bmahe.genetics4j.core.spec.EAConfigurationBulkAsync<T>

net.bmahe.genetics4j.core.spec.ImmutableEAConfigurationBulkAsync<T>

@Generated(from="EAConfigurationBulkAsync",
           generator="Immutables")
@Generated("org.immutables.processor.ProxyProcessor")
public final class ImmutableEAConfigurationBulkAsync<T extends Comparable<T>>
extends EAConfigurationBulkAsync<T>

Immutable implementation of EAConfigurationBulkAsync.

Use the builder to create immutable instances: new EAConfigurationBulkAsync.Builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableEAConfigurationBulkAsync.Builder<T extends Comparable<T>>	Builds instances of type ImmutableEAConfigurationBulkAsync.
private final class	ImmutableEAConfigurationBulkAsync.InitShim

Field Summary

Fields

Modifier and Type	Field	Description
private final List<ChromosomeSpec>	chromosomeSpecs
private final CombinationPolicy	combinationPolicy
private final FitnessBulkAsync<T>	fitness
private final GenotypeCombinator	genotypeCombinator
private final Supplier<Genotype>	genotypeGenerator
private ImmutableEAConfigurationBulkAsync<T>.InitShim	initShim
private final List<MutationPolicy>	mutationPolicies
private final double	offspringGeneratedRatio
private final Optimization	optimization
private final SelectionPolicy	parentSelectionPolicy
private final Function<Population<T>,Population<T>>	postEvaluationProcessor
private final ReplacementStrategy	replacementStrategy
private final Collection<Genotype>	seedPopulation
private static final byte	STAGE_INITIALIZED
private static final byte	STAGE_INITIALIZING
private static final byte	STAGE_UNINITIALIZED
private final Termination<T>	termination

Fields inherited from class net.bmahe.genetics4j.core.spec.AbstractEAConfiguration

DEFAULT_OFFSPRING_RATIO, DEFAULT_OPTIMIZATION

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImmutableEAConfigurationBulkAsync(List<ChromosomeSpec> chromosomeSpecs, SelectionPolicy parentSelectionPolicy, CombinationPolicy combinationPolicy, List<MutationPolicy> mutationPolicies, ReplacementStrategy replacementStrategy, Function<Population<T>,Population<T>> postEvaluationProcessor, Termination<T> termination, Supplier<Genotype> genotypeGenerator, Collection<Genotype> seedPopulation, GenotypeCombinator genotypeCombinator, double offspringGeneratedRatio, Optimization optimization, FitnessBulkAsync<T> fitness)
private	ImmutableEAConfigurationBulkAsync(ImmutableEAConfigurationBulkAsync.Builder<T> builder)

Method Summary

Modifier and Type	Method	Description
List<ChromosomeSpec>	chromosomeSpecs()	Genotype of the population
CombinationPolicy	combinationPolicy()	Defines the policy to generate new offsprings from two parents
static <T extends Comparable<T>> ImmutableEAConfigurationBulkAsync<T>	copyOf(EAConfigurationBulkAsync<T> instance)	Creates an immutable copy of a EAConfigurationBulkAsync value.
private static <T> List<T>	createSafeList(Iterable<? extends T> iterable, boolean checkNulls, boolean skipNulls)
private static <T> List<T>	createUnmodifiableList(boolean clone, List<? extends T> list)
boolean	equals(Object another)	This instance is equal to all instances of ImmutableEAConfigurationBulkAsync that have equal attribute values.
private boolean	equalsByValue(ImmutableEAConfigurationBulkAsync<?> another)
FitnessBulkAsync<T>	fitness()	Defines how should individuals' fitness be assessed
GenotypeCombinator	genotypeCombinator()	Defines how to combine the offspring chromosomes generated
Optional<Supplier<Genotype>>	genotypeGenerator()	Defines how to generate individuals
int	hashCode()	Computes a hash code from attributes: chromosomeSpecs, parentSelectionPolicy, combinationPolicy, mutationPolicies, replacementStrategy, postEvaluationProcessor, termination, genotypeGenerator, seedPopulation, genotypeCombinator, offspringGeneratedRatio, optimization, fitness.
List<MutationPolicy>	mutationPolicies()	Defines what mutations to be performed on the offsprings
double	offspringGeneratedRatio()	Defines how many children will be generated at each iteration.
Optimization	optimization()	Defines the optimization goal, whether we want to maximize the fitness or minimize it
SelectionPolicy	parentSelectionPolicy()	Defines the policy to select the parents.
Optional<Function<Population<T>,Population<T>>>	postEvaluationProcessor()	Post-processing of a population after it got evaluated
ReplacementStrategy	replacementStrategy()	Defines the replacement strategy
Collection<Genotype>	seedPopulation()	Seed the initial population with specific individuals
Termination<T>	termination()	Defines termination condition
String	toString()	Prints the immutable value EAConfigurationBulkAsync with attribute values.
private static <T extends Comparable<T>> ImmutableEAConfigurationBulkAsync<T>	validate(ImmutableEAConfigurationBulkAsync<T> instance)
final ImmutableEAConfigurationBulkAsync<T>	withChromosomeSpecs(Iterable<? extends ChromosomeSpec> elements)	Copy the current immutable object with elements that replace the content of chromosomeSpecs.
final ImmutableEAConfigurationBulkAsync<T>	withChromosomeSpecs(ChromosomeSpec... elements)	Copy the current immutable object with elements that replace the content of chromosomeSpecs.
final ImmutableEAConfigurationBulkAsync<T>	withCombinationPolicy(CombinationPolicy value)	Copy the current immutable object by setting a value for the combinationPolicy attribute.
final ImmutableEAConfigurationBulkAsync<T>	withFitness(FitnessBulkAsync<T> value)	Copy the current immutable object by setting a value for the fitness attribute.
final ImmutableEAConfigurationBulkAsync<T>	withGenotypeCombinator(GenotypeCombinator value)	Copy the current immutable object by setting a value for the genotypeCombinator attribute.
final ImmutableEAConfigurationBulkAsync<T>	withGenotypeGenerator(Supplier<Genotype> value)	Copy the current immutable object by setting a present value for the optional genotypeGenerator attribute.
final ImmutableEAConfigurationBulkAsync<T>	withGenotypeGenerator(Optional<? extends Supplier<Genotype>> optional)	Copy the current immutable object by setting an optional value for the genotypeGenerator attribute.
final ImmutableEAConfigurationBulkAsync<T>	withMutationPolicies(Iterable<? extends MutationPolicy> elements)	Copy the current immutable object with elements that replace the content of mutationPolicies.
final ImmutableEAConfigurationBulkAsync<T>	withMutationPolicies(MutationPolicy... elements)	Copy the current immutable object with elements that replace the content of mutationPolicies.
final ImmutableEAConfigurationBulkAsync<T>	withOffspringGeneratedRatio(double value)	Copy the current immutable object by setting a value for the offspringGeneratedRatio attribute.
final ImmutableEAConfigurationBulkAsync<T>	withOptimization(Optimization value)	Copy the current immutable object by setting a value for the optimization attribute.
final ImmutableEAConfigurationBulkAsync<T>	withParentSelectionPolicy(SelectionPolicy value)	Copy the current immutable object by setting a value for the parentSelectionPolicy attribute.
final ImmutableEAConfigurationBulkAsync<T>	withPostEvaluationProcessor(Function<Population<T>,Population<T>> value)	Copy the current immutable object by setting a present value for the optional postEvaluationProcessor attribute.
final ImmutableEAConfigurationBulkAsync<T>	withPostEvaluationProcessor(Optional<? extends Function<Population<T>,Population<T>>> optional)	Copy the current immutable object by setting an optional value for the postEvaluationProcessor attribute.
final ImmutableEAConfigurationBulkAsync<T>	withReplacementStrategy(ReplacementStrategy value)	Copy the current immutable object by setting a value for the replacementStrategy attribute.
final ImmutableEAConfigurationBulkAsync<T>	withSeedPopulation(Collection<Genotype> value)	Copy the current immutable object by setting a value for the seedPopulation attribute.
final ImmutableEAConfigurationBulkAsync<T>	withTermination(Termination<T> value)	Copy the current immutable object by setting a value for the termination attribute.

Methods inherited from class net.bmahe.genetics4j.core.spec.AbstractEAConfiguration

check, fitnessComparator, getChromosomeSpec, numChromosomes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

chromosomeSpecs

private final List<ChromosomeSpec> chromosomeSpecs

parentSelectionPolicy

private final SelectionPolicy parentSelectionPolicy

combinationPolicy

private final CombinationPolicy combinationPolicy

mutationPolicies

private final List<MutationPolicy> mutationPolicies

replacementStrategy

private final ReplacementStrategy replacementStrategy

postEvaluationProcessor

private final Function<Population<T extends Comparable<T>>,Population<T extends Comparable<T>>> postEvaluationProcessor

termination

private final Termination<T extends Comparable<T>> termination

genotypeGenerator

private final Supplier<Genotype> genotypeGenerator

seedPopulation

private final Collection<Genotype> seedPopulation

genotypeCombinator

private final GenotypeCombinator genotypeCombinator

offspringGeneratedRatio

private final double offspringGeneratedRatio

optimization

private final Optimization optimization

fitness

private final FitnessBulkAsync<T extends Comparable<T>> fitness

STAGE_INITIALIZING

private static final byte STAGE_INITIALIZING

See Also:

• Constant Field Values

STAGE_UNINITIALIZED

private static final byte STAGE_UNINITIALIZED

See Also:

• Constant Field Values

STAGE_INITIALIZED

private static final byte STAGE_INITIALIZED

See Also:

• Constant Field Values

initShim

private transient volatile ImmutableEAConfigurationBulkAsync<T extends Comparable<T>>.InitShim initShim

Constructor Details

ImmutableEAConfigurationBulkAsync

private ImmutableEAConfigurationBulkAsync(ImmutableEAConfigurationBulkAsync.Builder<T> builder)

ImmutableEAConfigurationBulkAsync

private ImmutableEAConfigurationBulkAsync(List<ChromosomeSpec> chromosomeSpecs,
 SelectionPolicy parentSelectionPolicy,
 CombinationPolicy combinationPolicy,
 List<MutationPolicy> mutationPolicies,
 ReplacementStrategy replacementStrategy,
 Function<Population<T>,Population<T>> postEvaluationProcessor,
 Termination<T> termination,
 Supplier<Genotype> genotypeGenerator,
 Collection<Genotype> seedPopulation,
 GenotypeCombinator genotypeCombinator,
 double offspringGeneratedRatio,
 Optimization optimization,
 FitnessBulkAsync<T> fitness)

Method Details

chromosomeSpecs

public List<ChromosomeSpec> chromosomeSpecs()

Genotype of the population

Specified by:

chromosomeSpecs in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

parentSelectionPolicy

public SelectionPolicy parentSelectionPolicy()

Defines the policy to select the parents. The selected parents will be used for generating the new offsprings

Specified by:

parentSelectionPolicy in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

combinationPolicy

public CombinationPolicy combinationPolicy()

Defines the policy to generate new offsprings from two parents

Specified by:

combinationPolicy in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

mutationPolicies

public List<MutationPolicy> mutationPolicies()

Defines what mutations to be performed on the offsprings

Specified by:

mutationPolicies in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

replacementStrategy

public ReplacementStrategy replacementStrategy()

Defines the replacement strategy

The replacement strategy is what will determine the next population based on the generated and mutated offsprings along with the current population

If not specified, the default replacement strategy will be to use Elitism with tournament selection of 3 individuals for both offsprings and survivors. The default offspring ratio is

invalid reference

Elitism#DEFAULT_OFFSPRING_RATIO

Overrides:

replacementStrategy in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

postEvaluationProcessor

public Optional<Function<Population<T>,Population<T>>> postEvaluationProcessor()

Post-processing of a population after it got evaluated

This gives the opportunity to filter out, repair or rescore individuals

Specified by:

postEvaluationProcessor in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

Population to be used by the remaining evolution process

termination

public Termination<T> termination()

Defines termination condition

Specified by:

termination in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

genotypeGenerator

public Optional<Supplier<Genotype>> genotypeGenerator()

Defines how to generate individuals

If not specified, the system will rely on the chromosome factories

Specified by:

genotypeGenerator in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

seedPopulation

public Collection<Genotype> seedPopulation()

Seed the initial population with specific individuals

Overrides:

seedPopulation in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

genotypeCombinator

public GenotypeCombinator genotypeCombinator()

Defines how to combine the offspring chromosomes generated

Combination of individuals is done on a per chromosome basis. This means some parents may generate a different number of children for each chromosome. This method will therefore define how to take all these generated chromosomes and combine them into offspring individuals

The current default implementation is to generate as many individual as there are combinations of generated chromosomes

Overrides:

genotypeCombinator in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

offspringGeneratedRatio

public double offspringGeneratedRatio()

Defines how many children will be generated at each iteration. Value must be between 0 and 1 (inclusive) and represents a fraction of the population size

Overrides:

offspringGeneratedRatio in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

optimization

public Optimization optimization()

Defines the optimization goal, whether we want to maximize the fitness or minimize it

Overrides:

optimization in class AbstractEAConfiguration<T extends Comparable<T>>

Returns:

fitness

public FitnessBulkAsync<T> fitness()

Defines how should individuals' fitness be assessed

Specified by:

fitness in class EAConfigurationBulkAsync<T extends Comparable<T>>

Returns:

withChromosomeSpecs

public final ImmutableEAConfigurationBulkAsync<T> withChromosomeSpecs(ChromosomeSpec... elements)

Copy the current immutable object with elements that replace the content of chromosomeSpecs.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withChromosomeSpecs

public final ImmutableEAConfigurationBulkAsync<T> withChromosomeSpecs(Iterable<? extends ChromosomeSpec> elements)

Copy the current immutable object with elements that replace the content of chromosomeSpecs. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of chromosomeSpecs elements to set

Returns:

A modified copy or this if not changed

withParentSelectionPolicy

public final ImmutableEAConfigurationBulkAsync<T> withParentSelectionPolicy(SelectionPolicy value)

Copy the current immutable object by setting a value for the parentSelectionPolicy attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for parentSelectionPolicy

Returns:

A modified copy or the this object

withCombinationPolicy

public final ImmutableEAConfigurationBulkAsync<T> withCombinationPolicy(CombinationPolicy value)

Copy the current immutable object by setting a value for the combinationPolicy attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for combinationPolicy

Returns:

A modified copy or the this object

withMutationPolicies

public final ImmutableEAConfigurationBulkAsync<T> withMutationPolicies(MutationPolicy... elements)

Copy the current immutable object with elements that replace the content of mutationPolicies.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withMutationPolicies

public final ImmutableEAConfigurationBulkAsync<T> withMutationPolicies(Iterable<? extends MutationPolicy> elements)

Copy the current immutable object with elements that replace the content of mutationPolicies. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of mutationPolicies elements to set

Returns:

A modified copy or this if not changed

withReplacementStrategy

public final ImmutableEAConfigurationBulkAsync<T> withReplacementStrategy(ReplacementStrategy value)

Copy the current immutable object by setting a value for the replacementStrategy attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for replacementStrategy

Returns:

A modified copy or the this object

withPostEvaluationProcessor

public final ImmutableEAConfigurationBulkAsync<T> withPostEvaluationProcessor(Function<Population<T>,Population<T>> value)

Copy the current immutable object by setting a present value for the optional postEvaluationProcessor attribute.

Parameters:

value - The value for postEvaluationProcessor

Returns:

A modified copy or this if not changed

withPostEvaluationProcessor

public final ImmutableEAConfigurationBulkAsync<T> withPostEvaluationProcessor(Optional<? extends Function<Population<T>,Population<T>>> optional)

Copy the current immutable object by setting an optional value for the postEvaluationProcessor attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - An optional value for postEvaluationProcessor

Returns:

A modified copy or this if not changed

withTermination

public final ImmutableEAConfigurationBulkAsync<T> withTermination(Termination<T> value)

Copy the current immutable object by setting a value for the termination attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for termination

Returns:

A modified copy or the this object

withGenotypeGenerator

public final ImmutableEAConfigurationBulkAsync<T> withGenotypeGenerator(Supplier<Genotype> value)

Copy the current immutable object by setting a present value for the optional genotypeGenerator attribute.

Parameters:

value - The value for genotypeGenerator

Returns:

A modified copy or this if not changed

withGenotypeGenerator

public final ImmutableEAConfigurationBulkAsync<T> withGenotypeGenerator(Optional<? extends Supplier<Genotype>> optional)

Copy the current immutable object by setting an optional value for the genotypeGenerator attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.

Parameters:

optional - An optional value for genotypeGenerator

Returns:

A modified copy or this if not changed

withSeedPopulation

public final ImmutableEAConfigurationBulkAsync<T> withSeedPopulation(Collection<Genotype> value)

Copy the current immutable object by setting a value for the seedPopulation attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for seedPopulation

Returns:

A modified copy or the this object

withGenotypeCombinator

public final ImmutableEAConfigurationBulkAsync<T> withGenotypeCombinator(GenotypeCombinator value)

Copy the current immutable object by setting a value for the genotypeCombinator attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for genotypeCombinator

Returns:

A modified copy or the this object

withOffspringGeneratedRatio

public final ImmutableEAConfigurationBulkAsync<T> withOffspringGeneratedRatio(double value)

Copy the current immutable object by setting a value for the offspringGeneratedRatio attribute. A value strict bits equality used to prevent copying of the same value by returning this.

Parameters:

value - A new value for offspringGeneratedRatio

Returns:

A modified copy or the this object

withOptimization

public final ImmutableEAConfigurationBulkAsync<T> withOptimization(Optimization value)

Copy the current immutable object by setting a value for the optimization attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for optimization

Returns:

A modified copy or the this object

withFitness

public final ImmutableEAConfigurationBulkAsync<T> withFitness(FitnessBulkAsync<T> value)

Copy the current immutable object by setting a value for the fitness attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for fitness

Returns:

A modified copy or the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableEAConfigurationBulkAsync that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

equalsByValue

private boolean equalsByValue(ImmutableEAConfigurationBulkAsync<?> another)

hashCode

public int hashCode()

Computes a hash code from attributes: chromosomeSpecs, parentSelectionPolicy, combinationPolicy, mutationPolicies, replacementStrategy, postEvaluationProcessor, termination, genotypeGenerator, seedPopulation, genotypeCombinator, offspringGeneratedRatio, optimization, fitness.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value EAConfigurationBulkAsync with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

validate

private static <T extends Comparable<T>>
ImmutableEAConfigurationBulkAsync<T> validate(ImmutableEAConfigurationBulkAsync<T> instance)

copyOf

public static <T extends Comparable<T>>
ImmutableEAConfigurationBulkAsync<T> copyOf(EAConfigurationBulkAsync<T> instance)

Creates an immutable copy of a EAConfigurationBulkAsync value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Type Parameters:

T - generic parameter T

Parameters:

instance - The instance to copy

Returns:

A copied immutable EAConfigurationBulkAsync instance

createSafeList

private static <T> List<T> createSafeList(Iterable<? extends T> iterable,
 boolean checkNulls,
 boolean skipNulls)

createUnmodifiableList

private static <T> List<T> createUnmodifiableList(boolean clone,
 List<? extends T> list)