ec.breed

Class CheckingPipeline

java.lang.Object

ec.BreedingSource

ec.BreedingPipeline

ec.breed.CheckingPipeline

All Implemented Interfaces:

Prototype, Setup, SteadyStateBSourceForm, RandomChoiceChooserD, Serializable, Cloneable

public class CheckingPipeline
extends BreedingPipeline

CheckingPipeline is a BreedingPipeline which just passes through the individuals it receives from its source 0, but only if those individuals ALL pass a validation check (the method allValid(), which you must override). It tries to find valid individuals some num-times times, and if it cannot, it instead reproduces individuals from its source 1 and returns them instead.

In some cases you may wish instead to produce individuals which are individually checked for validity, rather than together. The easiest way to do this is to add the CheckingPipeline as a child to a ForceBreedingPipeline which has been set with num-inds=1.

Typical Number of Individuals Produced Per produce(...) call
...as many as either child produces

Number of Sources
2

Parameters

base.num-times int >= 1

(number of times we try to get children from source 0 before giving up and using source 1)

Default Base
breed.check

Version:

1.0

Author:

Sean Luke

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	NUM_SOURCES
(package private) int	numTimes
static String	P_CHECK
static String	P_NUMTIMES

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
CheckingPipeline()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allValid(Individual[] inds, int numInds, int subpopulation, EvolutionState state, int thread)
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.

Methods inherited from class ec.BreedingPipeline

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

Methods inherited from class ec.BreedingSource

getProbability, pickRandom, setProbability, setupProbabilities

Methods inherited from class java.lang.Object

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

Field Detail

P_CHECK

public static final String P_CHECK

See Also:

Constant Field Values

P_NUMTIMES

public static final String P_NUMTIMES

See Also:

Constant Field Values

NUM_SOURCES

public static final int NUM_SOURCES

See Also:

Constant Field Values

numTimes

int numTimes

Constructor Detail

CheckingPipeline

public CheckingPipeline()

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)

allValid

public boolean allValid(Individual[] inds,
               int numInds,
               int subpopulation,
               EvolutionState state,
               int thread)

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