|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectec.rule.Rule
public abstract class 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 using the Comparable interface, 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.
In addition to serialization for checkpointing, Rules may read and write themselves to streams in three ways.
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 | |
---|---|
java.lang.Object |
clone()
Creates a new individual cloned from a prototype, and suitable to begin use in its own evolutionary context. |
abstract int |
compareTo(java.lang.Object o)
This function replaces the old gt and lt functions that Rule used to require as it implemented the SortComparator interface. |
RuleConstraints |
constraints(RuleInitializer initializer)
|
Parameter |
defaultBase()
Returns the default base for this prototype. |
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()
Rulerates 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)
Prints the rule in a way that can be read by readRule(). |
void |
printRule(EvolutionState state,
int log,
int verbosity)
Deprecated. Verbosity no longer has an effect |
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)
Nice printing. |
void |
printRuleForHumans(EvolutionState state,
int log,
int verbosity)
Deprecated. Verbosity no longer has an effect |
java.lang.String |
printRuleToString()
Prints the rule to a string in a fashion readable by readRuleFromString. |
java.lang.String |
printRuleToString(EvolutionState state)
Deprecated. |
java.lang.String |
printRuleToStringForHumans()
Nice printing to a string. |
void |
readRule(EvolutionState state,
java.io.DataInput dataInput)
Override this if you need to read rules in from a binary stream |
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. |
void |
writeRule(EvolutionState state,
java.io.DataOutput dataOutput)
Override this if you need to write rules out to a binary stream |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
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(RuleInitializer initializer)
public abstract int hashCode()
hashCode
in class java.lang.Object
public 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)
public void printRuleForHumans(EvolutionState state, int log, int verbosity)
public java.lang.String printRuleToStringForHumans()
public java.lang.String printRuleToString(EvolutionState state)
public java.lang.String printRuleToString()
public void readRuleFromString(java.lang.String string, EvolutionState state)
public void printRule(EvolutionState state, int log)
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.io.IOException
public void writeRule(EvolutionState state, java.io.DataOutput dataOutput) throws java.io.IOException
java.io.IOException
public void readRule(EvolutionState state, java.io.DataInput dataInput) throws java.io.IOException
java.io.IOException
public Parameter defaultBase()
Prototype
defaultBase
in interface Prototype
public java.lang.Object clone()
Prototype
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:
Implementations.
public Object clone()
{
try
{
return super.clone();
}
catch ((CloneNotSupportedException e)
{ throw new InternalError(); } // never happens
}
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;
}
public Object clone()
{
MyObject myobj = (MyObject) (super.clone());
// put your deep-cloning code here...
return myobj;
}
clone
in interface Prototype
clone
in class java.lang.Object
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
setup
in interface Setup
public abstract int compareTo(java.lang.Object o)
public abstract int compareTo(Object o) { if (gt(this,o)) return 1; if (lt(this,o)) return -1; return 0; }
compareTo
in interface java.lang.Comparable
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |