com.rapidminer.operator.learner.subgroups.utility
Class UtilityFunction

java.lang.Object
  com.rapidminer.operator.learner.subgroups.utility.UtilityFunction

Direct Known Subclasses:

Accuracy, Bias, Binomial, Coverage, Lift, Odds, OddsRatio, Precision, Squared, WRAcc

public abstract class UtilityFunction
extends java.lang.Object

This is the abstract superclass for all utility functions for calculating the utility of rules.

Author:

Tobias Malbrecht

Field Summary

static int	ACCURACY
static int	BIAS
static int	BINOMIAL
static int	COVERAGE
static java.lang.String[]	FUNCTIONS
static int	LIFT
protected static int	NEGATIVE_CLASS
static int	ODDS
static int	ODDS_RATIO
protected static int	POSITIVE_CLASS
static int	PRECISION
static int	SQUARED
protected double	totalNegativeWeight
protected double	totalPositiveWeight
protected double	totalWeight
static int	WRACC

Constructor Summary

UtilityFunction(double totalWeight, double totalPositiveWeight)

Method Summary

abstract java.lang.String	getAbbreviation()
abstract java.lang.String	getName()
double	getTotalNegativeWeight()
double	getTotalPositiveWeight()
double	getTotalWeight()
static UtilityFunction	getUtilityFunction(int utilityFunctionIndex, double totalWeight, double totalPositiveWeight)
static java.lang.Class<? extends UtilityFunction>	getUtilityFunctionClass(int utilityFunctionIndex)
static java.lang.Class[]	getUtilityFunctionClasses()
static UtilityFunction[]	getUtilityFunctions(double totalWeight, double totalPositiveWeight)
abstract double	optimisticEstimate(Hypothesis hypothesis)
java.lang.String	toString()
abstract double	utility(Rule rule)

Methods inherited from class java.lang.Object

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

Field Detail

COVERAGE

public static final int COVERAGE

See Also:

Constant Field Values

PRECISION

public static final int PRECISION

See Also:

Constant Field Values

ACCURACY

public static final int ACCURACY

See Also:

Constant Field Values

BIAS

public static final int BIAS

See Also:

Constant Field Values

LIFT

public static final int LIFT

See Also:

Constant Field Values

BINOMIAL

public static final int BINOMIAL

See Also:

Constant Field Values

WRACC

public static final int WRACC

See Also:

Constant Field Values

SQUARED

public static final int SQUARED

See Also:

Constant Field Values

ODDS

public static final int ODDS

See Also:

Constant Field Values

ODDS_RATIO

public static final int ODDS_RATIO

See Also:

Constant Field Values

FUNCTIONS

public static final java.lang.String[] FUNCTIONS

POSITIVE_CLASS

protected static final int POSITIVE_CLASS

See Also:

Constant Field Values

NEGATIVE_CLASS

protected static final int NEGATIVE_CLASS

See Also:

Constant Field Values

totalWeight

protected double totalWeight

totalPositiveWeight

protected double totalPositiveWeight

totalNegativeWeight

protected double totalNegativeWeight

Constructor Detail

UtilityFunction

public UtilityFunction(double totalWeight,
                       double totalPositiveWeight)

Method Detail

utility

public abstract double utility(Rule rule)

optimisticEstimate

public abstract double optimisticEstimate(Hypothesis hypothesis)

getName

public abstract java.lang.String getName()

getAbbreviation

public abstract java.lang.String getAbbreviation()

getTotalWeight

public double getTotalWeight()

getTotalPositiveWeight

public double getTotalPositiveWeight()

getTotalNegativeWeight

public double getTotalNegativeWeight()

getUtilityFunction

public static UtilityFunction getUtilityFunction(int utilityFunctionIndex,
                                                 double totalWeight,
                                                 double totalPositiveWeight)

getUtilityFunctionClass

public static java.lang.Class<? extends UtilityFunction> getUtilityFunctionClass(int utilityFunctionIndex)

getUtilityFunctions

public static UtilityFunction[] getUtilityFunctions(double totalWeight,
                                                    double totalPositiveWeight)

getUtilityFunctionClasses

public static java.lang.Class[] getUtilityFunctionClasses()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object