ec.breed

Class StubPipeline

java.lang.Object

ec.BreedingSource

ec.BreedingPipeline

ec.breed.ReproductionPipeline

ec.breed.StubPipeline

All Implemented Interfaces:

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

public class StubPipeline
extends ReproductionPipeline

StubPipeline is a BreedingPipeline subclass which, during fillStubs(), fills all the stubs with its own stub pipeline. The stub pipeline's stubs are first filled by parent stub sources.

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

Number of Sources
1

Parameters

base.stub-source classname, inherits and != ec.BreedingSource

(the prototypical "stub pipeline" Breeding Source)

Parameter bases

base.stub-source

i_prototype (the stub pipeline)

Default Base
breed.stub

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	P_STUB
static java.lang.String	P_STUB_PIPELINE
BreedingSource	stubPipeline

Fields inherited from class ec.breed.ReproductionPipeline

NUM_SOURCES, P_REPRODUCE

Fields inherited from class ec.BreedingPipeline

DYNAMIC_SOURCES, likelihood, mybase, P_LIKELIHOOD, P_NUMSOURCES, P_SOURCE, sources, V_SAME, V_STUB

Fields inherited from class ec.BreedingSource

NO_PROBABILITY, P_PROB, probability

Constructor Summary

Constructors

Constructor and Description
StubPipeline()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a new individual cloned from a prototype, and suitable to begin use in its own evolutionary context.
Parameter	defaultBase() Returns the default base for this prototype.
void	fillStubs(EvolutionState state, BreedingSource source)
void	setup(EvolutionState state, Parameter base) Sets up the BreedingPipeline.

Methods inherited from class ec.breed.ReproductionPipeline

numSources, produce

Methods inherited from class ec.BreedingPipeline

finishProducing, individualReplaced, maxChildProduction, minChildProduction, preparePipeline, prepareToProduce, produces, 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_STUB

public static final java.lang.String P_STUB

See Also:

Constant Field Values

P_STUB_PIPELINE

public static final java.lang.String P_STUB_PIPELINE

See Also:

Constant Field Values

stubPipeline

public BreedingSource stubPipeline

Constructor Detail

StubPipeline

public StubPipeline()

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

Specified by:

defaultBase in interface Prototype

Overrides:

defaultBase in class ReproductionPipeline

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 ReproductionPipeline

See Also:

Prototype.setup(EvolutionState,Parameter)

clone

public java.lang.Object clone()

Description copied from interface: Prototype

Creates a new individual cloned from a prototype, and suitable to begin use in its own evolutionary context.

Typically this should be a full "deep" clone. However, you may share certain elements with other objects rather than clone hem, depending on the situation:

• If you hold objects which are shared with other instances, don't clone them.
• If you hold objects which must be unique, clone them.
• If you hold objects which were given to you as a gesture of kindness, and aren't owned by you, you probably shouldn't clone them.
• DON'T attempt to clone: Singletons, Cliques, or Populations, or Subpopulation.
• Arrays are not cloned automatically; you may need to clone an array if you're not sharing it with other instances. Arrays have the nice feature of being copyable by calling clone() on them.

Implementations.

• If no ancestor of yours implements clone(), and you have no need to do clone deeply, and you are abstract, then you should not declare clone().
• If no ancestor of yours implements clone(), and you have no need to do clone deeply, and you are not abstract, then you should implement it as follows:

   public Object clone() 
       {
       try
           { 
           return super.clone();
           }
       catch ((CloneNotSupportedException e)
           { throw new InternalError(); } // never happens
       }
          

• If no ancestor of yours implements clone(), but you need to deep-clone some things, then you should implement it as follows:

   public Object clone() 
       {
       try
           { 
           MyObject myobj = (MyObject) (super.clone());
  
           // put your deep-cloning code here...
           }
       catch ((CloneNotSupportedException e)
           { throw new InternalError(); } // never happens
       return myobj;
       } 
          

• If an ancestor has implemented clone(), and you also need to deep clone some things, then you should implement it as follows:

   public Object clone() 
       { 
       MyObject myobj = (MyObject) (super.clone());
  
       // put your deep-cloning code here...
  
       return myobj;
       } 
          

Specified by:

clone in interface Prototype

Overrides:

clone in class BreedingPipeline

fillStubs

public void fillStubs(EvolutionState state,
                      BreedingSource source)

Overrides:

fillStubs in class BreedingPipeline