ec.breed
Class MultiBreedingPipeline

java.lang.Object
  |
  +--ec.BreedingSource
        |
        +--ec.BreedingPipeline
              |
              +--ec.breed.MultiBreedingPipeline

public class MultiBreedingPipeline
extends BreedingPipeline

MultiBreedingPipeline is a BreedingPipeline stores some n child sources; each time it must produce an individual or two, it picks one of these sources at random and has it do the production.

Typical Number of Individuals Produced Per produce(...) call
If by base.generate-max is true, then always the maximum number of the typical numbers of any child source. If false, then varies depending on the child source picked.

Number of Sources
Dynamic. As many as the user specifies.

Parameters
base.generate-max
bool = true (default) or false
(Each time produce(...) is called, should the MultiBreedingPipeline force all its sources to produce exactly the same number of individuals as the largest typical number of individuals produced by any source in the group?)

Default Base
breed.multibreed

See Also:
Serialized Form

Field Summary
 boolean generateMax
           
 int maxGeneratable
           
static java.lang.String P_GEN_MAX
           
static java.lang.String P_MULTIBREED
           
 
Fields inherited from class ec.BreedingPipeline
DYNAMIC_SOURCES, P_NUMSOURCES, P_SOURCE, sources, V_SAME
 
Fields inherited from class ec.BreedingSource
CHECKBOUNDARY, DEFAULT_PRODUCED, NO_PROBABILITY, P_PROB, probability, UNUSED
 
Constructor Summary
MultiBreedingPipeline()
           
 
Method Summary
 Parameter defaultBase()
          Returns the default base for this prototype.
 int numSources()
          Returns the number of sources to this pipeline.
 void prepareToProduce(EvolutionState s, 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.
 int produce(int min, int max, int start, int subpopulation, Individual[] inds, EvolutionState state, int thread)
          Produces n individuals from the given subpopulation and puts them into inds[start...start+n-1], where n = Min(Max(q,min),max), where q is the "typical" number of individuals the BreedingSource produces in one shot, and returns n.
 void setup(EvolutionState state, Parameter base)
          Sets up the BreedingPipeline.
 int typicalIndsProduced()
          Returns the max of typicalIndsProduced() of all its children
 
Methods inherited from class ec.BreedingPipeline
preparePipeline, produces, protoClone
 
Methods inherited from class ec.BreedingSource
getProbability, pickRandom, protoCloneSimple, setProbability, setupProbabilities
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

P_GEN_MAX

public static final java.lang.String P_GEN_MAX

P_MULTIBREED

public static final java.lang.String P_MULTIBREED

maxGeneratable

public int maxGeneratable

generateMax

public boolean generateMax
Constructor Detail

MultiBreedingPipeline

public MultiBreedingPipeline()
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(...).

numSources

public int numSources()
Description copied from class: BreedingPipeline
Returns the number of sources to this pipeline. Called during BreedingPipeline's setup. Be sure to return a value > 0, or DYNAMIC_SOURCES which indicates that setup should check the parameter file for the parameter "num-sources" to make its determination.
Overrides:
numSources in class BreedingPipeline

setup

public void setup(EvolutionState state,
                  Parameter base)
Description copied from class: BreedingSource
Sets up the BreedingPipeline. You can use state.output.error here because the top-level caller promises to call exitIfErrors() after calling setup. Note that probability might get modified again by an external source if it doesn't normalize right.

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}.

Overrides:
setup in class BreedingPipeline
Tags copied from class: BreedingSource
See Also:
Prototype.setup(EvolutionState,Parameter)

prepareToProduce

public void prepareToProduce(EvolutionState s,
                             int subpopulation,
                             int thread)
Description copied from class: BreedingSource
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. Individuals should be produced from old individuals in positions [start...start+length] in the subpopulation only. May be called again to reset the BreedingSource for a whole 'nuther subpopulation.
Overrides:
prepareToProduce in class BreedingPipeline

typicalIndsProduced

public int typicalIndsProduced()
Returns the max of typicalIndsProduced() of all its children
Overrides:
typicalIndsProduced in class BreedingSource

produce

public int produce(int min,
                   int max,
                   int start,
                   int subpopulation,
                   Individual[] inds,
                   EvolutionState state,
                   int thread)
            throws java.lang.CloneNotSupportedException
Description copied from class: BreedingSource
Produces n individuals from the given subpopulation and puts them into inds[start...start+n-1], where n = Min(Max(q,min),max), where q is the "typical" number of individuals the BreedingSource produces in one shot, and returns n. max must be >= min, and min must be >= 1. For example, crossover might typically produce two individuals, tournament selection might typically produce a single individual, etc.
Overrides:
produce in class BreedingSource