ec.simple
Class SimpleFitness

java.lang.Object
  |
  +--ec.simple.SimpleFitness
All Implemented Interfaces:
java.lang.Cloneable, Fitness, Prototype, java.io.Serializable, Setup
Direct Known Subclasses:
IncrementalAveragedFitness

public class SimpleFitness
extends java.lang.Object
implements Fitness

A simple default fitness, consisting of a single floating-point value which ranges from 0 (worst), and where fitness A is superior to fitness B if and only if A > B. Fitness values may range from [0.0,infinity), so in theory "infinity" could be the ideal fitness -- but in fact you can have any maximum ideal fitness because when you set a fitness, you specify whether or not it is the ideal.

Default Base
simple.fitness

See Also:
Serialized Form

Field Summary
protected  float fitness
          The fitness.
static java.lang.String FITNESS_PREAMBLE
           
protected  boolean isIdeal
           
static java.lang.String 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 bettter or worse than the other.
 float fitness()
          Should return an absolute fitness value in the half-open range [0.0,infinity), where 0.0 is <= the worst possible value, and inifity is > the ideal fitness.
 boolean isIdealFitness()
          Should return true if this is a good enough fitness to end the run
 void printFitness(EvolutionState state, int log, int verbosity)
          Should print the fitness out in a computer-readable fashion, using state.output.println(...,verbosity,log).
 void printFitness(EvolutionState state, java.io.PrintWriter writer)
          Should print the fitness out in a computer-readable fashion, using state.output.println(...,verbosity,log).
 void printFitnessForHumans(EvolutionState state, int log, int verbosity)
          Should print the fitness out in a pleasing way to humans, using state.output.println(...,verbosity,log)
 java.lang.Object protoClone()
          Creates a new individual cloned from a prototype, and suitable to begin use in its own evolutionary context.
 java.lang.Object protoCloneSimple()
          This should be implemented in a the top-level Prototype ONLY; in fact, it should probably be declared final.
 void readFitness(EvolutionState state, java.io.LineNumberReader reader)
          Reads in the fitness from a form printed by printFitness().
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FITNESS_PREAMBLE

public static final java.lang.String FITNESS_PREAMBLE

P_FITNESS

public static final java.lang.String P_FITNESS

fitness

protected float fitness
The fitness. Ranges from [0.0,infinity) -- see Fitness.fitness() for more information
See Also:
#ec.Fitness.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(...).
Specified by:
defaultBase in interface Prototype

protoClone

public java.lang.Object protoClone()
                            throws java.lang.CloneNotSupportedException
Description copied from interface: Prototype
Creates a new individual cloned from a prototype, and suitable to begin use in its own evolutionary context.

The question here is whether or not this means to perform a "deep" or "light" ("shallow") clone, or something in-between. You may need to deep-clone parts of your object rather than simply copying their references, depending on the situation:

Implementations.

If you know that your superclasses will never change their protoClone() implementations, you might try inlining them in your overridden protoClone() method. But this is dangerous (though it yields a small net increase).

In general, you want to keep your deep cloning to an absolute minimum, so that you don't have to call protoClone() but one time.

The approach taken here is the fastest that I am aware of while still permitting objects to be specified at runtime from a parameter file. It would be faster to use the "new" operator; but that would require hard-coding that we can't do. Although using java.lang.Object.clone() entails an extra layer that deals with stripping away the "protected" keyword and also wrapping the exception handling (which is a BIG hit, about three times as slow as using "new"), it's still MUCH faster than using java.lang.Class.newInstance(), and also much faster than rolling our own Clone() method.

Specified by:
protoClone in interface Prototype

protoCloneSimple

public final java.lang.Object protoCloneSimple()
Description copied from interface: Prototype
This should be implemented in a the top-level Prototype ONLY; in fact, it should probably be declared final. It should be implemented as follows:

public final Object protoCloneSimple()
{
try { return protoClone(); }
catch (CloneNotSupportedException e) 
{ throw new InternalError(); } // never happens
} 
Specified by:
protoCloneSimple in interface Prototype

setFitness

public final 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).
See Also:
setFitness(final EvolutionState state, float _f, boolean _isIdeal)

setFitness

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

fitness

public final float fitness()
Description copied from interface: Fitness
Should return an absolute fitness value in the half-open range [0.0,infinity), where 0.0 is <= the worst possible value, and inifity is > the ideal fitness. You don't need to have your fitness values go all the way up to infinity -- doing them in the range [0.0,1.0], for example, is just fine.

This function should be used only by fitness-proportionate selection and other selection methods which require an absolute fitness value. All other approaches should use the equivalentTo() and betterThan() methods.

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

Specified by:
fitness in interface Fitness

setup

public final 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

isIdealFitness

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

equivalentTo

public final boolean equivalentTo(Fitness _fitness)
Description copied from interface: Fitness
Should return true if this fitness is in the same equivalence class as _fitness, that is, neither is clearly bettter or worse than the other. You may assume that _fitness is of the same class as yourself. worseThan(), equivalentTo() and betterThan() should be disjoint sets.
Specified by:
equivalentTo in interface Fitness

betterThan

public final boolean betterThan(Fitness _fitness)
Description copied from interface: Fitness
Should return true if this fitness is clearly better than _fitness; You may assume that _fitness is of the same class as yourself. worseThan(), equivalentTo() and betterThan() should be disjoint sets.
Specified by:
betterThan in interface Fitness

printFitness

public void printFitness(EvolutionState state,
                         int log,
                         int verbosity)
Description copied from interface: Fitness
Should print the fitness out in a computer-readable fashion, using state.output.println(...,verbosity,log). You should use ec.util.Code to encode fitness values.
Specified by:
printFitness in interface Fitness

printFitness

public void printFitness(EvolutionState state,
                         java.io.PrintWriter writer)
Description copied from interface: Fitness
Should print the fitness out in a computer-readable fashion, using state.output.println(...,verbosity,log). You should use ec.util.Code to encode fitness values. Usually you should try to use printFitness(state,log,verbosity) instead -- use this method only if you can't print through the Output facility for some reason.
Specified by:
printFitness in interface Fitness

printFitnessForHumans

public void printFitnessForHumans(EvolutionState state,
                                  int log,
                                  int verbosity)
Description copied from interface: Fitness
Should print the fitness out in a pleasing way to humans, using state.output.println(...,verbosity,log)
Specified by:
printFitnessForHumans in interface Fitness

readFitness

public void readFitness(EvolutionState state,
                        java.io.LineNumberReader reader)
                 throws java.io.IOException,
                        java.lang.CloneNotSupportedException
Description copied from interface: Fitness
Reads in the fitness from a form printed by printFitness().
Specified by:
readFitness in interface Fitness