public class TreeFitnessInfo extends java.lang.Object implements java.lang.Comparable<TreeFitnessInfo>
Modifier and Type | Class and Description |
---|---|
static class |
TreeFitnessInfo.Dimension
The dimension that the fitness metric belongs to.
|
static class |
TreeFitnessInfo.TreeFitnessInfoComboboxRenderer
A renderer for TreeFitnessInfo objects which uses the original renderer
but then shows the TreeFitnessInfo name in the combobox
|
Constructor and Description |
---|
TreeFitnessInfo(java.lang.Class<? extends TreeFitnessAbstract> clazz,
java.lang.String code,
java.lang.String name,
java.lang.String description,
TreeFitnessInfo.Dimension dimension,
boolean isNatural,
java.lang.Class<? extends TreeFitnessAbstract>... dependsOn)
Create a new instance of information for a tree fitness evaluator.
|
TreeFitnessInfo(TreeFitnessInfo original) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(TreeFitnessInfo o)
Sorts
TreeFitnessInfo instances based on their provided NAME, for
visualization purposes mainly (e.g. |
boolean |
equals(java.lang.Object other) |
java.lang.Class<? extends TreeFitnessAbstract> |
getClazz()
Returns the class of the fitness metric this information object belongs
to.
|
java.lang.String |
getCode()
Get the two character code of the fitness metric.
|
java.lang.Class<? extends TreeFitnessAbstract>[] |
getDependsOn()
Returns an array of class names that this evaluator depends on.
|
java.lang.String |
getDescription()
A brief description of the metric, possibly with pointers to literature.
|
TreeFitnessInfo.Dimension |
getDimension()
The
TreeFitnessInfo.Dimension the metric is concerned with. |
java.lang.String |
getName()
The name of the fitness metric.
|
int |
getWorstFitnessValue()
Returns the worst fitness value for this evaluator using the isNatural
boolean.
|
boolean |
isNatural()
Whether a bigger fitness value is good (TRUE) or bad (FALSE).
|
java.lang.String |
toString()
Currently implemented to return the code
|
public TreeFitnessInfo(java.lang.Class<? extends TreeFitnessAbstract> clazz, java.lang.String code, java.lang.String name, java.lang.String description, TreeFitnessInfo.Dimension dimension, boolean isNatural, java.lang.Class<? extends TreeFitnessAbstract>... dependsOn)
clazz
- The Class of the fitness evaluatorcode
- A two character code for the evaluator that UNIQUELY
identifies the evaluatorname
- A descriptive but short name of a couple of words that can be
used in GUI, drop down lists, and reportsdescription
- A (longer) description that describes in more detail what the
evaluator evaluatesdimension
- The TreeFitnessInfo.Dimension
the evaluator coversisNatural
- Whether the values of the evaluator are natural. E.g. TRUE
implies bigger values indicate better qualitydependsOn
- A list of other evaluator classes the current evaluator
depends on, e.g. needs, in that order (!) in a constructor.
This is required for automatic cloning of evaluators for multi
threading and sanity checks (last is NOT IMPLEMENTED)public TreeFitnessInfo(TreeFitnessInfo original)
public java.lang.String getCode()
public boolean isNatural()
public java.lang.String getName()
public java.lang.String getDescription()
public TreeFitnessInfo.Dimension getDimension()
TreeFitnessInfo.Dimension
the metric is concerned with.public java.lang.Class<? extends TreeFitnessAbstract> getClazz()
public java.lang.String toString()
toString
in class java.lang.Object
public int getWorstFitnessValue()
public java.lang.Class<? extends TreeFitnessAbstract>[] getDependsOn()
public int compareTo(TreeFitnessInfo o)
TreeFitnessInfo
instances based on their provided NAME, for
visualization purposes mainly (e.g. nice sorting in combobox lists).compareTo
in interface java.lang.Comparable<TreeFitnessInfo>
public boolean equals(java.lang.Object other)
equals
in class java.lang.Object