ec.breed

Class MultiBreedingPipeline

java.lang.Object

ec.BreedingSource

ec.BreedingPipeline

ec.breed.MultiBreedingPipeline

All Implemented Interfaces:

Prototype, Setup, SteadyStateBSourceForm, RandomChoiceChooserD, java.io.Serializable, java.lang.Cloneable

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

Fields

Modifier and Type	Field and Description
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, likelihood, mybase, P_LIKELIHOOD, P_NUMSOURCES, P_SOURCE, sources, V_SAME

Fields inherited from class ec.BreedingSource

NO_PROBABILITY, P_PROB, probability

Constructor Summary

Constructors

Constructor and Description
MultiBreedingPipeline()

Method Summary

Modifier and Type	Method and Description
Parameter	defaultBase() Returns the default base for this prototype.
int	numSources() Returns the number of sources to this pipeline.
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

clone, finishProducing, individualReplaced, maxChildProduction, minChildProduction, preparePipeline, prepareToProduce, produces, reproduce, sourcesAreProperForm

Methods inherited from class ec.BreedingSource

getProbability, pickRandom, setProbability, setupProbabilities

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

P_GEN_MAX

public static final java.lang.String P_GEN_MAX

See Also:

Constant Field Values

P_MULTIBREED

public static final java.lang.String P_MULTIBREED

See Also:

Constant Field Values

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.

Specified by:

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

Specified by:

setup in interface Prototype

Specified by:

setup in interface Setup

Overrides:

setup in class BreedingPipeline

See Also:

Prototype.setup(EvolutionState,Parameter)

typicalIndsProduced

public int typicalIndsProduced()

Returns the max of typicalIndsProduced() of all its children

Overrides:

typicalIndsProduced in class BreedingPipeline

produce

public int produce(int min,
                   int max,
                   int start,
                   int subpopulation,
                   Individual[] inds,
                   EvolutionState state,
                   int thread)

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.

Specified by:

produce in class BreedingSource