|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ec.rule.Rule
Rule is an abstract class for describing rules. It is abstract because it is supposed to be extended by different classes modelling different kinds of rules. It provides the reset abstract method for randomizing the individual. It also provides the mutate function for mutating an individual rule It also provides the clone function for cloning the rule.
You will need to implement some kind of artificial ordering between rules in a ruleset (the lt and gt methods inherited from SortComparator) so the ruleset can be sorted in such a way that it can be compared with another ruleset for equality. You should also implement hashCode and equals in such a way that they aren't based on pointer information, but on actual internal features.
Every rule points to a RuleConstraints which handles information that Rule shares with all the other Rules in a RuleSet.
Parameters
base.constraints string |
(name of the rule constraint) |
Default Base
rule.rule
Field Summary | |
byte |
constraints
An index to a RuleConstraints |
static java.lang.String |
P_CONSTRAINTS
|
static java.lang.String |
P_RULE
|
Constructor Summary | |
Rule()
|
Method Summary | |
RuleConstraints |
constraints()
|
Parameter |
defaultBase()
Returns the default base for this prototype. |
abstract boolean |
equals(java.lang.Object other)
Unlike the standard form for Java, this function should return true if this rule is "genetically identical" to the other rule. |
abstract int |
hashCode()
Generates a hash code for this rule -- the rule for this is that the hash code must be the same for two rules that are equal to each other genetically. |
void |
mutate(EvolutionState state,
int thread)
Mutate the rule. |
void |
printRule(EvolutionState state,
int log,
int verbosity)
Prints the rule in a way that can be read by readRule(). |
void |
printRule(EvolutionState state,
java.io.PrintWriter writer)
Prints the rule in a way that can be read by readRule(). |
void |
printRuleForHumans(EvolutionState state,
int log,
int verbosity)
Nice printing. |
java.lang.String |
printRuleToString(EvolutionState state)
Deprecated. |
java.lang.Object |
protoClone()
Creates a new individual cloned from a prototype, and suitable to begin use in its own evolutionary context. |
java.lang.Object |
protoCloneSimple()
This should be implemented in a the top-level Prototype ONLY; in fact, it should probably be declared final. |
void |
readRule(EvolutionState state,
java.io.LineNumberReader reader)
Reads a rule printed by printRule(...). |
void |
readRuleFromString(java.lang.String string,
EvolutionState state)
Reads a rule from a string, which may contain a final '\n'. |
abstract void |
reset(EvolutionState state,
int thread)
The reset method randomly reinitializes the rule. |
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 |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface ec.util.SortComparator |
gt, lt |
Field Detail |
public static final java.lang.String P_RULE
public static final java.lang.String P_CONSTRAINTS
public byte constraints
Constructor Detail |
public Rule()
Method Detail |
public final RuleConstraints constraints()
public abstract int hashCode()
hashCode
in class java.lang.Object
public abstract boolean equals(java.lang.Object other)
equals
in class java.lang.Object
public abstract void reset(EvolutionState state, int thread)
public void mutate(EvolutionState state, int thread)
public void printRuleForHumans(EvolutionState state, int log, int verbosity)
public java.lang.String printRuleToString(EvolutionState state)
public void readRuleFromString(java.lang.String string, EvolutionState state)
public void printRule(EvolutionState state, int log, int verbosity)
public void printRule(EvolutionState state, java.io.PrintWriter writer)
public void readRule(EvolutionState state, java.io.LineNumberReader reader) throws java.io.IOException, java.lang.CloneNotSupportedException
public Parameter defaultBase()
Prototype
defaultBase
in interface Prototype
public java.lang.Object protoClone() throws java.lang.CloneNotSupportedException
Prototype
The question here is whether or not this means to perform a "deep" or "light" ("shallow") clone, or something in-between. You may need to deep-clone parts of your object rather than simply copying their references, depending on the situation:
Implementations.
public Object protoClone() throws CloneNotSupportedException
{
return super.clone();
}
public Object protoClone() throws CloneNotSupportedException
{
myobj = (MyObject) (super.clone());
// put your deep-cloning code here...
// ...you should use protoClone and not
// protoCloneSimple to clone subordinate objects...
return myobj;
}
public Object protoClone() throws CloneNotSupportedException
{
MyObject myobj = (MyObject)(super.protoClone());
// put your deep-cloning code here...
// ...you should use protoClone and not
// protoCloneSimple to clone subordinate objects...
return myobj;
}
If you know that your superclasses will never change their protoClone() implementations, you might try inlining them in your overridden protoClone() method. But this is dangerous (though it yields a small net increase).
In general, you want to keep your deep cloning to an absolute minimum, so that you don't have to call protoClone() but one time.
The approach taken here is the fastest that I am aware of while still permitting objects to be specified at runtime from a parameter file. It would be faster to use the "new" operator; but that would require hard-coding that we can't do. Although using java.lang.Object.clone() entails an extra layer that deals with stripping away the "protected" keyword and also wrapping the exception handling (which is a BIG hit, about three times as slow as using "new"), it's still MUCH faster than using java.lang.Class.newInstance(), and also much faster than rolling our own Clone() method.
protoClone
in interface Prototype
public final java.lang.Object protoCloneSimple()
Prototype
public final Object protoCloneSimple()
{
try { return protoClone(); }
catch (CloneNotSupportedException e)
{ throw new InternalError(); } // never happens
}
protoCloneSimple
in interface Prototype
public void setup(EvolutionState state, Parameter base)
Prototype
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.
setup
in interface Prototype
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |