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

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

All Implemented Interfaces:

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

public class AreaUnderCurve
extends MeasuredPerformance

This criterion calculates the area under the ROC curve.

Version:

$Id: AreaUnderCurve.java,v 2.11 2006/08/03 14:39:30 ingomierswa Exp $

Author:

Ingo Mierswa, Martin Scholz

Field Summary

private double	auc The value of the AUC.
private int	counter A counter for average building.
private java.lang.String	positiveClassName The positive class name.

Constructor Summary

AreaUnderCurve()
Clone constructor.

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.
void	countExample(Example example) Does nothing.
java.lang.String	getDescription() Returns a description of the performance criterion.
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 averagable.
void	readCriterionData(java.io.BufferedReader in) Reads the performance data from the given reader.
void	startCounting(ExampleSet exampleSet) Calculates the AUC.
java.lang.String	toString() Returns the super class implementation of toString() and adds the information about the positive class.
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

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

auc

private double auc

The value of the AUC.

counter

private int counter

A counter for average building.

positiveClassName

private java.lang.String positiveClassName

The positive class name.

Constructor Detail

AreaUnderCurve

public AreaUnderCurve()

Clone constructor.

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

startCounting

public void startCounting(ExampleSet exampleSet)
                   throws OperatorException

Calculates the AUC.

Overrides:

startCounting in class MeasuredPerformance

Throws:

OperatorException

countExample

public void countExample(Example example)

Does nothing. Everything is done in startCounting(ExampleSet).

Specified by:

countExample in class MeasuredPerformance

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

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()

Description copied from class: Averagable

Returns the name of this averagable.

Specified by:

getName in interface ResultObject

Specified by:

getName in class Averagable

getDescription

public java.lang.String getDescription()

Description copied from class: MeasuredPerformance

Returns a description of the performance criterion.

Specified by:

getDescription in class MeasuredPerformance

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

toString

public java.lang.String toString()

Returns the super class implementation of toString() and adds the information about the positive class.

Overrides:

toString in class Averagable