Package ec.breed

Class 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

See Also:
  • Field Details

  • Constructor Details

    • CheckingPipeline

      public CheckingPipeline()
  • Method Details

    • 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:
    • allValid

      public boolean allValid(ArrayList<Individual> inds, int numInds, int subpopulation, EvolutionState state, int thread)
    • produce

      public int produce(int min, int max, int subpopulation, ArrayList<Individual> inds, EvolutionState state, int thread, HashMap<String,Object> misc)
      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