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

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
                  edu.udo.cs.yale.operator.performance.EstimatedPerformance

All Implemented Interfaces:

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

public class EstimatedPerformance
extends PerformanceCriterion

This class is used to store estimated performance values before or even without the performance test is actually done using a test set. Please note that this type of performance cannot be used to calculate average values, i.e. it will lead to an error if an EstimatedPerformance criterion is used in a validation operator.

Version:

$Id: EstimatedPerformance.java,v 2.21 2006/04/06 15:23:37 ingomierswa Exp $

Author:

Simon Fischer, Ingo Mierswa

Field Summary

private int	exampleCount
private boolean	minimizeForFitness
private java.lang.String	name
private double	value

Constructor Summary

EstimatedPerformance()
Clone constructor.

EstimatedPerformance(java.lang.String name, double value, int numberOfExamples, boolean minimizeForFitness)
Constructs a new extimated performance criterion.

Method Summary

void	buildSingleAverage(Averagable performance) This method should build the average of this and another averagables of the same type.
protected void	cloneAveragable(Averagable other) Must be implemented by subclasses such that it copies all values of other to this.
int	getExampleCount() Returns the number of data points which was used to determine the criterion value.
double	getFitness() Returns the fitness.
double	getMikroAverage() Returns the (current) value of the averagable (the average itself).
double	getMikroVariance() Returns the variance of the averagable.
java.lang.String	getName() Returns the name of this estimated performance criterion, which can be set using setName().
void	readCriterionData(java.io.BufferedReader in) Reads the performance data from the given reader.
void	setMikroAverage(double value, int numberOfExamples) Sets the value of this estimated performance criterion.
void	writeCriterionData(java.io.PrintWriter out) Writes the performance criterion into the given writer.

Methods inherited from class edu.udo.cs.yale.operator.performance.PerformanceCriterion

compareTo, getMaxFitness, readPerformanceCriterion, writePerformanceCriterion

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

buildAverage, clone, formatDeviation, formatPercent, formatValue, getAverage, getMakroAverage, getMakroStandardDeviation, getMakroVariance, getMikroStandardDeviation, 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

Field Detail

name

private java.lang.String name

value

private double value

exampleCount

private int exampleCount

minimizeForFitness

private boolean minimizeForFitness

Constructor Detail

EstimatedPerformance

public EstimatedPerformance()

Clone constructor.

EstimatedPerformance

public EstimatedPerformance(java.lang.String name,
                            double value,
                            int numberOfExamples,
                            boolean minimizeForFitness)

Constructs a new extimated performance criterion.

Parameters:

name - Human readable name

value - The Value of the performance criterion

numberOfExamples - The number of examples used to estimate this value.

minimizeForFitness - Indicates whether or not (-1) * value should be used as fitness value.

Method Detail

writeCriterionData

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

Description copied from class: PerformanceCriterion

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

Specified by:

writeCriterionData in class PerformanceCriterion

Throws:

java.io.IOException

readCriterionData

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

Description copied from class: PerformanceCriterion

Reads the performance data from the given reader.

Specified by:

readCriterionData in class PerformanceCriterion

Throws:

java.io.IOException

getExampleCount

public int getExampleCount()

Description copied from class: PerformanceCriterion

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

Specified by:

getExampleCount in class PerformanceCriterion

getMikroVariance

public double getMikroVariance()

Description copied from class: Averagable

Returns the variance of the averagable. The returned value must not be negative. If the averagable does not define a variance this method should return Double.NaN.

Specified by:

getMikroVariance in class Averagable

setMikroAverage

public void setMikroAverage(double value,
                            int numberOfExamples)

Sets the value of this estimated performance criterion.

Parameters:

value - The Value of the performance criterion

numberOfExamples - The number of examples used to estimate this value. It is used for calculateing the average.

getMikroAverage

public double getMikroAverage()

Description copied from class: Averagable

Returns the (current) value of the averagable (the average itself).

Specified by:

getMikroAverage in class Averagable

getFitness

public double getFitness()

Returns the fitness.

Specified by:

getFitness in class PerformanceCriterion

getName

public java.lang.String getName()

Returns the name of this estimated performance criterion, which can be set using setName().

Specified by:

getName in interface ResultObject

Specified by:

getName in class Averagable

Returns:

The name.

cloneAveragable

protected void cloneAveragable(Averagable other)

Description copied from class: Averagable

Must be implemented by subclasses such that it copies all values of other to this. When this method is called, it is guaranteed, that other is a subclass of the class of the object it is called on.

Specified by:

cloneAveragable in class Averagable

buildSingleAverage

public void buildSingleAverage(Averagable performance)

Description copied from class: Averagable

This method should build the average of this and another averagables of the same type. The next invocation of getValue() should return the average of this and the given averagable. Please refer to SimpleCriterion for a simple implementation example.

Specified by:

buildSingleAverage in class Averagable