ec.simple
Class SimpleFitness

java.lang.Object
  extended by ec.Fitness
      extended by ec.simple.SimpleFitness
All Implemented Interfaces:
Prototype, Setup, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
SimpleBoundedFitness

public class SimpleFitness
extends Fitness

A simple default fitness, consisting of a single floating-point value where fitness A is superior to fitness B if and only if A > B. Fitness values may range from (-infinity,infinity) exclusive -- that is, you may not have infinite fitnesses.

Some kinds of selection methods require a more stringent definition of fitness. For example, FitProportionateSelection requires that fitnesses be non-negative (since it must place them into a proportionate distribution). You may wish to restrict yourself to values in [0,1] or [0,infinity) in such cases.

Default Base
simple.fitness

Version:
1.0
Author:
Sean Luke
See Also:
Serialized Form

Field Summary
protected  float fitness
           
protected  boolean isIdeal
           
 
Fields inherited from class ec.Fitness
FITNESS_PREAMBLE, P_FITNESS
 
Constructor Summary
SimpleFitness()
           
 
Method Summary
 boolean betterThan(Fitness _fitness)
          Should return true if this fitness is clearly better than _fitness; You may assume that _fitness is of the same class as yourself.
 Parameter defaultBase()
          Returns the default base for this prototype.
 boolean equivalentTo(Fitness _fitness)
          Should return true if this fitness is in the same equivalence class as _fitness, that is, neither is clearly better or worse than the other.
 float fitness()
          Should return an absolute fitness value ranging from negative infinity to infinity, NOT inclusive (thus infinity, negative infinity, and NaN are NOT valid fitness values).
 java.lang.String fitnessToString()
          Print to a string the fitness in a fashion intended to be parsed in again via readFitness(...).
 java.lang.String fitnessToStringForHumans()
          Print to a string the fitness in a fashion readable by humans, and not intended to be parsed in again.
 boolean isIdealFitness()
          Should return true if this is a good enough fitness to end the run
 void readFitness(EvolutionState state, java.io.DataInput dataInput)
          Reads the binary form of an individual from a DataInput.
 void readFitness(EvolutionState state, java.io.LineNumberReader reader)
          Presently does not decode the fact that the fitness is ideal or not
 void setFitness(EvolutionState state, float _f)
          Deprecated.  
 void setFitness(EvolutionState state, float _f, boolean _isIdeal)
           
 void setup(EvolutionState state, Parameter base)
          Sets up the object by reading it from the parameters stored in state, built off of the parameter base base.
 void writeFitness(EvolutionState state, java.io.DataOutput dataOutput)
          Writes the binary form of an individual out to a DataOutput.
 
Methods inherited from class ec.Fitness
clone, printFitness, printFitness, printFitnessForHumans
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fitness

protected float fitness

isIdeal

protected boolean isIdeal
Constructor Detail

SimpleFitness

public SimpleFitness()
Method Detail

defaultBase

public Parameter defaultBase()
Description copied from interface: Prototype
Returns the default base for this prototype. This should generally be implemented by building off of the static base() method on the DefaultsForm object for the prototype's package. This should be callable during setup(...).


setFitness

public void setFitness(EvolutionState state,
                       float _f)
Deprecated. 

Deprecated -- now redefined to set the fitness but ALWAYS say that it's not ideal. If you need to specify that it's ideal, you should use the new function setFitness(final EvolutionState state, float _f, boolean _isIdeal).


setFitness

public void setFitness(EvolutionState state,
                       float _f,
                       boolean _isIdeal)

fitness

public float fitness()
Description copied from class: Fitness
Should return an absolute fitness value ranging from negative infinity to infinity, NOT inclusive (thus infinity, negative infinity, and NaN are NOT valid fitness values). This should be interpreted as: negative infinity is worse than the WORST possible fitness, and positive infinity is better than the IDEAL fitness.

You are free to restrict this range any way you like: for example, your fitness values might fall in the range [-5.32, 2.3]

Selection methods relying on fitness proportionate information will assume the fitness is non-negative and should throw an error if it is not. Thus if you plan on using FitProportionateSelection, BestSelection, or GreedyOverselection, for example, your fitnesses should assume that 0 is the worst fitness and positive fitness are better. If you're using other selection methods (Tournament selection, various ES selection procedures, etc.) your fitness values can be anything.

Similarly, if you're writing a selection method and it needs positive fitnesses, you should check for negative values and issue an error; and if your selection method doesn't need an absolute fitness value, it should use the equivalentTo() and betterThan() methods instead.

If your fitness scheme does not use a metric quantifiable to a single positive value (for example, MultiObjectiveFitness), you should perform some reasonable translation.

Specified by:
fitness in class Fitness

setup

public void setup(EvolutionState state,
                  Parameter base)
Description copied from interface: Prototype
Sets up the object by reading it from the parameters stored in state, built off of the parameter base base. If an ancestor implements this method, be sure to call super.setup(state,base); before you do anything else.

For prototypes, setup(...) is typically called once for the prototype instance; cloned instances do not receive the setup(...) call. setup(...) may be called more than once; the only guarantee is that it will get called at least once on an instance or some "parent" object from which it was ultimately cloned.

Specified by:
setup in interface Prototype
Specified by:
setup in interface Setup
Overrides:
setup in class Fitness

isIdealFitness

public boolean isIdealFitness()
Description copied from class: Fitness
Should return true if this is a good enough fitness to end the run

Specified by:
isIdealFitness in class Fitness

equivalentTo

public boolean equivalentTo(Fitness _fitness)
Description copied from class: Fitness
Should return true if this fitness is in the same equivalence class as _fitness, that is, neither is clearly better or worse than the other. You may assume that _fitness is of the same class as yourself. For any two fitnesses fit1 and fit2 of the same class, it must be the case that fit1.equivalentTo(fit2) == fit2.equivalentTo(fit1), and that only one of fit1.betterThan(fit2), fit1.equivalentTo(fit2), and fit2.betterThan(fit1) can be true.

Specified by:
equivalentTo in class Fitness

betterThan

public boolean betterThan(Fitness _fitness)
Description copied from class: Fitness
Should return true if this fitness is clearly better than _fitness; You may assume that _fitness is of the same class as yourself. For any two fitnesses fit1 and fit2 of the same class, it must be the case that fit1.equivalentTo(fit2) == fit2.equivalentTo(fit1), and that only one of fit1.betterThan(fit2), fit1.equivalentTo(fit2), and fit2.betterThan(fit1) can be true.

Specified by:
betterThan in class Fitness

fitnessToString

public java.lang.String fitnessToString()
Description copied from class: Fitness
Print to a string the fitness in a fashion intended to be parsed in again via readFitness(...). The fitness and evaluated flag should not be included. The default form simply calls toString(), which is almost certainly wrong, and you'll probably want to override this to something else.

Overrides:
fitnessToString in class Fitness

fitnessToStringForHumans

public java.lang.String fitnessToStringForHumans()
Description copied from class: Fitness
Print to a string the fitness in a fashion readable by humans, and not intended to be parsed in again. The default form simply calls toString(), but you'll probably want to override this to something else.

Overrides:
fitnessToStringForHumans in class Fitness

readFitness

public void readFitness(EvolutionState state,
                        java.io.LineNumberReader reader)
                 throws java.io.IOException
Presently does not decode the fact that the fitness is ideal or not

Overrides:
readFitness in class Fitness
Throws:
java.io.IOException

writeFitness

public void writeFitness(EvolutionState state,
                         java.io.DataOutput dataOutput)
                  throws java.io.IOException
Description copied from class: Fitness
Writes the binary form of an individual out to a DataOutput. This is not for serialization: the object should only write out the data relevant to the object sufficient to rebuild it from a DataInput. The default version exits the program with an "unimplemented" error; you should override this.

Overrides:
writeFitness in class Fitness
Throws:
java.io.IOException

readFitness

public void readFitness(EvolutionState state,
                        java.io.DataInput dataInput)
                 throws java.io.IOException
Description copied from class: Fitness
Reads the binary form of an individual from a DataInput. This is not for serialization: the object should only read in the data written out via printIndividual(state,dataInput). The default version exits the program with an "unimplemented" error; you should override this.

Overrides:
readFitness in class Fitness
Throws:
java.io.IOException