ec.gp

Class GPData

java.lang.Object

ec.gp.GPData

All Implemented Interfaces:

Prototype, Setup, Serializable, Cloneable

Direct Known Subclasses:

DoubleData, EdgeData, LawnmowerData, MajorityData, MultiplexerData, MultiplexerData, ParityData, RegressionData, TwoBoxData

public class GPData
extends Object
implements Prototype

GPData is the parent class of data transferred between GPNodes. If performed correctly, there need be only one GPData instance ever created in the evaluation of many individuals.

You can use GPData as-is if you have absolutely no data to transfer between individuals. Otherwise, you need to subclas GPData, add your own instance variables, and then override the copyTo(...) method and, depending on whether the data has pointers in it (like arrays), the clone() method as well.

Default Base
gp.data

Version:

1.0

Author:

Sean Luke

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	P_GPDATA

Constructor Summary

Constructors

Constructor and Description
GPData()

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a new individual cloned from a prototype, and suitable to begin use in its own evolutionary context.
void	copyTo(GPData gpd) Modifies gpd so that gpd is equivalent to us.
Parameter	defaultBase() Returns the default base for this prototype.
void	setup(EvolutionState state, Parameter base) Sets up the object by reading it from the parameters stored in state, built off of the parameter base base.

Methods inherited from class java.lang.Object

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

Field Detail

P_GPDATA

public static final String P_GPDATA

See Also:

Constant Field Values

Constructor Detail

GPData

public GPData()

Method Detail

copyTo

public void copyTo(GPData gpd)

Modifies gpd so that gpd is equivalent to us. You may safely assume that gpd is of the same class as we are. Do not share pointers with the other object, except to read-only data: instead, copy any read-write data as necessary.

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

setup

public void setup(EvolutionState state,
                  Parameter base)

Description copied from interface: Prototype

Sets up the object by reading it from the parameters stored in state, built off of the parameter base base. If an ancestor implements this method, be sure to call super.setup(state,base); before you do anything else.

For prototypes, setup(...) is typically called once for the prototype instance; cloned instances do not receive the setup(...) call. setup(...) may be called more than once; the only guarantee is that it will get called at least once on an instance or some "parent" object from which it was ultimately cloned.

Specified by:

setup in interface Prototype

Specified by:

setup in interface Setup

clone

public 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 Object