org.jenetics

Class Phenotype<G extends Gene<?,G>,C extends Comparable<? super C>>

java.lang.Object

org.jenetics.Phenotype<G,C>

All Implemented Interfaces:

Serializable, Comparable<Phenotype<G,C>>, Runnable, Verifiable

public final class Phenotype<G extends Gene<?,G>,C extends Comparable<? super C>>
extends Object
implements Comparable<Phenotype<G,C>>, Verifiable, Serializable, Runnable

The Phenotype consists of a Genotype plus a fitness Function, where the fitness Function represents the environment where the Genotype lives. This class implements the Comparable interface, to define a natural order between two Phenotypes. The natural order of the Phenotypes is defined by its fitness value (given by the fitness Function. The Phenotype is immutable and therefore can't be changed after creation.

Since:

1.0

Version:

2.0 — $Date: 2014-12-28 $

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(Phenotype<G,C> pt)
boolean	equals(Object obj)
Phenotype<G,C>	evaluate() Evaluates the (raw) fitness values and caches it so the fitness calculation is performed only once.
long	getAge(long currentGeneration) Return the age of this phenotype depending on the given current generation.
C	getFitness() Return the fitness value of this Phenotype.
Function<? super Genotype<G>,? extends C>	getFitnessFunction() Return the fitness function used by this phenotype to calculate the (raw) fitness value.
Function<? super C,? extends C>	getFitnessScaler() Return the fitness scaler used by this phenotype to scale the raw fitness.
long	getGeneration() Return the generation this Phenotype was created.
Genotype<G>	getGenotype() This method returns a copy of the Genotype, to guarantee a immutable class.
C	getRawFitness() Return the raw fitness (before scaling) of the phenotype.
int	hashCode()
boolean	isValid() Test whether this phenotype is valid.
Phenotype<G,C>	newInstance(long generation, Function<? super Genotype<G>,? extends C> function) Return a new phenotype with the the genotype of this and with new fitness function and generation.
Phenotype<G,C>	newInstance(long generation, Function<? super Genotype<G>,? extends C> function, Function<? super C,? extends C> scaler) Return a new phenotype with the the genotype of this and with new fitness function, fitness scaler and generation.
static <G extends Gene<?,G>,C extends Comparable<? super C>> Phenotype<G,C>	of(Genotype<G> genotype, long generation, Function<? super Genotype<G>,? extends C> function, Function<? super C,? extends C> scaler) Create a new phenotype from the given arguments.
static <G extends Gene<?,G>,C extends Comparable<? super C>> Phenotype<G,C>	of(Genotype<G> genotype, long generation, Function<? super Genotype<G>,C> function) The Genotype is copied to guarantee an immutable class.
void	run() This method simply calls the evaluate() method.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getGenotype

public Genotype<G> getGenotype()

This method returns a copy of the Genotype, to guarantee a immutable class.

Returns:

the cloned Genotype of this Phenotype.

Throws:

NullPointerException - if one of the arguments is null.

evaluate

public Phenotype<G,C> evaluate()

Evaluates the (raw) fitness values and caches it so the fitness calculation is performed only once.

Returns:

this phenotype, for method chaining.

run

public void run()

This method simply calls the evaluate() method. The purpose of this method is to have a simple way for concurrent fitness calculation for expensive fitness values.

Specified by:

run in interface Runnable

getFitnessFunction

public Function<? super Genotype<G>,? extends C> getFitnessFunction()

Return the fitness function used by this phenotype to calculate the (raw) fitness value.

Returns:

the fitness function.

getFitnessScaler

public Function<? super C,? extends C> getFitnessScaler()

Return the fitness scaler used by this phenotype to scale the raw fitness.

Returns:

the fitness scaler.

getFitness

public C getFitness()

Return the fitness value of this Phenotype.

Returns:

The fitness value of this Phenotype.

getRawFitness

public C getRawFitness()

Return the raw fitness (before scaling) of the phenotype.

Returns:

The raw fitness (before scaling) of the phenotype.

getGeneration

public long getGeneration()

Return the generation this Phenotype was created.

Returns:

The generation this Phenotype was created.

getAge

public long getAge(long currentGeneration)

Return the age of this phenotype depending on the given current generation.

Parameters:

currentGeneration - the current generation evaluated by the GA.

Returns:

the age of this phenotype: currentGeneration - this.getGeneration().

isValid

public boolean isValid()

Test whether this phenotype is valid. The phenotype is valid if its Genotype is valid.

Specified by:

isValid in interface Verifiable

Returns:

true if this phenotype is valid, false otherwise.

compareTo

public int compareTo(Phenotype<G,C> pt)

Specified by:

compareTo in interface Comparable<Phenotype<G extends Gene<?,G>,C extends Comparable<? super C>>>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

newInstance

public Phenotype<G,C> newInstance(long generation,
                                  Function<? super Genotype<G>,? extends C> function,
                                  Function<? super C,? extends C> scaler)

Return a new phenotype with the the genotype of this and with new fitness function, fitness scaler and generation.

Parameters:

generation - the generation of the new phenotype.

function - the (new) fitness scaler of the created phenotype.

scaler - the (new) fitness scaler of the created phenotype

Returns:

a new phenotype with the given values.

Throws:

NullPointerException - if one of the values is null.

IllegalArgumentException - if the given generation is < 0.

newInstance

public Phenotype<G,C> newInstance(long generation,
                                  Function<? super Genotype<G>,? extends C> function)

Return a new phenotype with the the genotype of this and with new fitness function and generation.

Parameters:

generation - the generation of the new phenotype.

function - the (new) fitness scaler of the created phenotype.

Returns:

a new phenotype with the given values.

Throws:

NullPointerException - if one of the values is null.

IllegalArgumentException - if the given generation is < 0.

of

public static <G extends Gene<?,G>,C extends Comparable<? super C>> Phenotype<G,C> of(Genotype<G> genotype,
                                                                                      long generation,
                                                                                      Function<? super Genotype<G>,C> function)

The Genotype is copied to guarantee an immutable class. Only the age of the Phenotype can be incremented.

Type Parameters:

G - the gene type of the chromosome

C - the fitness value type

Parameters:

genotype - the genotype of this phenotype.

generation - the current generation of the generated phenotype.

function - the fitness function of this phenotype.

Returns:

a new phenotype from the given parameters

Throws:

NullPointerException - if one of the arguments is null.

IllegalArgumentException - if the given generation is < 0.

of

public static <G extends Gene<?,G>,C extends Comparable<? super C>> Phenotype<G,C> of(Genotype<G> genotype,
                                                                                      long generation,
                                                                                      Function<? super Genotype<G>,? extends C> function,
                                                                                      Function<? super C,? extends C> scaler)

Create a new phenotype from the given arguments.

Type Parameters:

G - the gene type of the chromosome

C - the fitness value type

Parameters:

genotype - the genotype of this phenotype.

generation - the current generation of the generated phenotype.

function - the fitness function of this phenotype.

scaler - the fitness scaler.

Returns:

a new phenotype object

Throws:

NullPointerException - if one of the arguments is null.

IllegalArgumentException - if the given generation is < 0.