edu.udo.cs.yale.operator.performance
Class PerformanceCriterion

java.lang.Object
  edu.udo.cs.yale.operator.AbstractIOObject
      edu.udo.cs.yale.operator.ResultObjectAdapter
          edu.udo.cs.yale.tools.math.Averagable
              edu.udo.cs.yale.operator.performance.PerformanceCriterion

All Implemented Interfaces:

IOObject, ResultObject, java.lang.Cloneable, java.lang.Comparable<Averagable>

Direct Known Subclasses:

EstimatedPerformance, MeasuredPerformance

public abstract class PerformanceCriterion
extends Averagable

Each PerformanceCriterion contains a method to compute this criterion on a given set of examples, each which has to have a real and a predicted label.
PerformanceCriteria must implement the compareTo method in a way that allows Collections to sort the criteria in ascending order and determine the best as the maximum.
Please note that each performance criterion must provide an empty constructor to load the automatic loading and creation of performance criteria.

Version:

$Id: PerformanceCriterion.java,v 2.22 2006/03/27 13:22:02 ingomierswa Exp $

Author:

Ingo Mierswa

Constructor Summary

PerformanceCriterion()

Method Summary

int	compareTo(Averagable o) The semantics of this method follow the specification in the interface java.lang.Comparable in the following way: Two objects of this class are equal if their getFitness() values are equal.
abstract int	getExampleCount() Returns the number of data points which was used to determine the criterion value.
abstract double	getFitness() Returns the fitness depending on the value.
double	getMaxFitness() Returns the maximum fitness.
abstract void	readCriterionData(java.io.BufferedReader in) Reads the performance data from the given reader.
static PerformanceCriterion	readPerformanceCriterion(java.io.BufferedReader in)
abstract void	writeCriterionData(java.io.PrintWriter out) Writes the performance criterion into the given writer.
void	writePerformanceCriterion(java.io.PrintWriter out) Writes the performance criterion into the given writer.

Methods inherited from class edu.udo.cs.yale.tools.math.Averagable

buildAverage, buildSingleAverage, clone, cloneAveragable, formatDeviation, formatPercent, formatValue, getAverage, getMakroAverage, getMakroStandardDeviation, getMakroVariance, getMikroAverage, getMikroStandardDeviation, getMikroVariance, getName, getStandardDeviation, getVariance, toHTML, toString

Methods inherited from class edu.udo.cs.yale.operator.ResultObjectAdapter

addAction, getActions, getVisualisationComponent, toHTML, toResultString

Methods inherited from class edu.udo.cs.yale.operator.AbstractIOObject

copy, read, read, read, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.udo.cs.yale.operator.IOObject

copy, write, write

Constructor Detail

PerformanceCriterion

public PerformanceCriterion()

Method Detail

getExampleCount

public abstract int getExampleCount()

Returns the number of data points which was used to determine the criterion value.

getFitness

public abstract double getFitness()

Returns the fitness depending on the value. Subclasses should use getAverage() instead of getValue() in this method since usually the makro average should be optmized instead of the mikro average. The mikro average should only be used in the (rare) cases where no makro average is available.

writeCriterionData

public abstract void writeCriterionData(java.io.PrintWriter out)
                                 throws java.io.IOException

Writes the performance criterion into the given writer. Please note that the criterion must be written in a human readable format!

Throws:

java.io.IOException

readCriterionData

public abstract void readCriterionData(java.io.BufferedReader in)
                                throws java.io.IOException

Reads the performance data from the given reader.

Throws:

java.io.IOException

getMaxFitness

public double getMaxFitness()

Returns the maximum fitness. The default implementation resturns POSITIVE_INFINITY, subclasses may override this to allow feature operators to end the optimization if the maximum was reached.

compareTo

public int compareTo(Averagable o)

The semantics of this method follow the specification in the interface java.lang.Comparable in the following way: Two objects of this class are equal if their getFitness() values are equal. The return value is 0 in this case. If the specified object is not an object of this class, a ClassCastException is thrown. If the given object has fitness bigger than this object, the return value is -1. If the given object has fitness smaller than this object, 1 is returned. No characteristics beside the fitness are used to compare two objects of this class.

Parameters:

o - Object of this class to compare this object to.

Returns:

-1, 0 or 1 if the given object is greater than, equal to, or less than this object.

writePerformanceCriterion

public void writePerformanceCriterion(java.io.PrintWriter out)
                               throws java.io.IOException

Writes the performance criterion into the given writer. Please note that the criterion must be written in a human readable format!

Throws:

java.io.IOException

readPerformanceCriterion

public static PerformanceCriterion readPerformanceCriterion(java.io.BufferedReader in)
                                                     throws java.io.IOException

Throws:

java.io.IOException