|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ec.BreedingSource | +--ec.BreedingPipeline
A BreedingPipeline is a BreedingSource which provides "fresh" individuals which can be used to fill a new population. BreedingPipelines might include Crossover pipelines, various Mutation pipelines, etc. This abstract class provides some default versions of various methods to simplify matters for you. It also contains an array of breeding sources for your convenience. You don't have to use them of course, but this means you have to customize the default methods below to make sure they get distributed to your special sources. Note that these sources may contain references to the same object -- they're not necessarily distinct. This is to provide both some simple DAG features and also to conserve space.
A BreedingPipeline implements SteadyStateBSourceForm, meaning that it receives the individualReplaced(...) and sourcesAreProperForm(...) messages. however by default it doesn't do anything with these except distribute them to its sources. You might override these to do something more interesting.
Parameters
base.num-sources int >= 1 |
(User-specified number of sources to the pipeline. Some pipelines have hard-coded numbers of sources; others indicate (with the java constant DYNAMIC_SOURCES) that the number of sources is determined by this user parameter instead.) |
base.source.n classname, inherits and != BreedingSource, or the value same | (Source n for this BreedingPipeline. If the value is set to same, then this source is the exact same source object as base.source.n-1, and further parameters for this object will be ignored and treated as the same as those for n-1. same is not valid for base.source.0) |
Parameter bases
base.source.n | Source n |
Field Summary | |
static int |
DYNAMIC_SOURCES
Indicates that the number of sources is variable and determined by the user in the parameter file. |
Parameter |
mybase
My parameter base -- I keep it around so I can print some messages that are useful with it (not deep cloned) |
static java.lang.String |
P_NUMSOURCES
Standard parameter for number of sources (only used if numSources returns DYNAMIC_SOURCES |
static java.lang.String |
P_SOURCE
Standard parameter for individual-selectors associated with a BreedingPipeline |
BreedingSource[] |
sources
Array of sources feeding the pipeline |
static java.lang.String |
V_SAME
Indicates that a source is the exact same source as the previous source. |
Fields inherited from class ec.BreedingSource |
CHECKBOUNDARY, DEFAULT_PRODUCED, NO_PROBABILITY, P_PROB, probability, UNUSED |
Constructor Summary | |
BreedingPipeline()
|
Method Summary | |
void |
individualReplaced(SteadyStateEvolutionState state,
int subpopulation,
int thread,
int individual)
Called whenever an individual has been replaced by another in the population. |
int |
maxChildProduction()
Returns the maximum among the typicalIndsProduced() for any children -- a function that's useful internally, not very useful for you to call externally. |
int |
minChildProduction()
Returns the minimum among the typicalIndsProduced() for any children -- a function that's useful internally, not very useful for you to call externally. |
abstract int |
numSources()
Returns the number of sources to this pipeline. |
void |
preparePipeline(java.lang.Object hook)
A hook which should be passed to all your subsidiary breeding sources. |
void |
prepareToProduce(EvolutionState state,
int subpopulation,
int thread)
Called before produce(...), usually once a generation, or maybe only once if you're doing steady-state evolution, to let the breeding source "warm up" prior to producing. |
boolean |
produces(EvolutionState state,
Population newpop,
int subpopulation,
int thread)
Returns true if this BreedingSource, when attached to the given subpopulation, will produce individuals of the subpopulation's species. |
java.lang.Object |
protoClone()
Creates a new individual cloned from a prototype, and suitable to begin use in its own evolutionary context. |
void |
setup(EvolutionState state,
Parameter base)
Sets up the BreedingPipeline. |
void |
sourcesAreProperForm(SteadyStateEvolutionState state)
Issue an error (not a fatal -- we guarantee that callers of this method will also call exitIfErrors) if any of your sources, or their sources, etc., are not of SteadyStateBSourceForm. |
int |
typicalIndsProduced()
Returns the "typical" number of individuals produced -- by default this is the minimum typical number of individuals produced by any children sources of the pipeline. |
Methods inherited from class ec.BreedingSource |
getProbability, pickRandom, produce, protoCloneSimple, setProbability, setupProbabilities |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface ec.Prototype |
defaultBase |
Field Detail |
public static final java.lang.String V_SAME
public static final int DYNAMIC_SOURCES
public static final java.lang.String P_NUMSOURCES
public static final java.lang.String P_SOURCE
public Parameter mybase
public BreedingSource[] sources
Constructor Detail |
public BreedingPipeline()
Method Detail |
public abstract int numSources()
public int minChildProduction()
public int maxChildProduction()
public int typicalIndsProduced()
typicalIndsProduced
in class BreedingSource
public void setup(EvolutionState state, Parameter base)
BreedingSource
The most common modification is to normalize it with some other set of probabilities, then set all of them up in increasing summation; this allows the use of the fast static BreedingSource-picking utility method, BreedingSource.pickRandom(...). In order to use this method, for example, if four breeding source probabilities are {0.3, 0.2, 0.1, 0.4}, then they should get normalized and summed by the outside owners as: {0.3, 0.5, 0.6, 1.0}.
setup
in class BreedingSource
ec.BreedingSource
Prototype.setup(EvolutionState,Parameter)
public java.lang.Object protoClone() throws java.lang.CloneNotSupportedException
Prototype
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.
public Object protoClone() throws CloneNotSupportedException
{
return super.clone();
}
public Object protoClone() throws CloneNotSupportedException
{
myobj = (MyObject) (super.clone());
// put your deep-cloning code here...
// ...you should use protoClone and not
// protoCloneSimple to clone subordinate objects...
return myobj;
}
public Object protoClone() throws CloneNotSupportedException
{
MyObject myobj = (MyObject)(super.protoClone());
// put your deep-cloning code here...
// ...you should use protoClone and not
// protoCloneSimple to clone subordinate objects...
return myobj;
}
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.
protoClone
in class BreedingSource
public boolean produces(EvolutionState state, Population newpop, int subpopulation, int thread)
BreedingSource
produces
in class BreedingSource
public void prepareToProduce(EvolutionState state, int subpopulation, int thread)
BreedingSource
prepareToProduce
in class BreedingSource
public void preparePipeline(java.lang.Object hook)
BreedingSource
preparePipeline
in class BreedingSource
public void individualReplaced(SteadyStateEvolutionState state, int subpopulation, int thread, int individual)
SteadyStateBSourceForm
individualReplaced
in interface SteadyStateBSourceForm
public void sourcesAreProperForm(SteadyStateEvolutionState state)
SteadyStateBSourceForm
sourcesAreProperForm
in interface SteadyStateBSourceForm
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |