edu.udo.cs.yale.operator.generator
Interface TargetFunction

All Known Implementing Classes:

CheckerboardClassificationFunction, ClassificationFunction, ComplicatedFunction, ComplicatedFunction2, GaussianFunction, GaussianMixtureFunction, GridFunction, InteractionClassificationFunction, MultiClassificationFunction, NonLinearFunction, OneThirdClassification, OneVariableNonLinearFunction, PolynomialClassificationFunction, PolynomialFunction, QuadraticClassificationFunction, RandomClassificationFunction, RandomDotsClassificationFunction, RandomFunction, RegressionFunction, RingClusteringFunction, SimpleNonLinearClassificationFunction, SimplePolynomialClassificationFunction, SimpleSinusFunction, SimpleSuperpositionFunction, SincFunction, SinusClassificationFunction, SinusFrequencyFunction, SinusFunction, SpiralClusteringFunction, SquarePulseFunction, SumClassificationFunction, SumFunction, TransactionDatasetFunction, TriangularFunction

public interface TargetFunction

A target function which is used for the ExampleSetGenerator operator. All target function will need an empty constructor since they are initialized via reflection.

Version:

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

Author:

Ingo Mierswa

Nested Class Summary

static class

TargetFunction.FunctionException Will be thrown if an error occurrs during the calculation of the target function.

Method Summary

double	calculate(double[] args) Calculates the target function on arguments.
double[]	createArguments(int dimension, RandomGenerator random) Creates and returns a number of arguments.
Attribute	getLabel() Returns the label attribute.
void	init(RandomGenerator random) Should be called before the data is created.
void	setLowerArgumentBound(double lower) Sets the lower bound for the arguments.
void	setTotalNumberOfAttributes(int number) Sets the maximal number of attributes.
void	setTotalNumberOfExamples(int number) Sets the maximal number of examples.
void	setUpperArgumentBound(double upper) Sets the upper bound for the arguments.

Method Detail

init

void init(RandomGenerator random)

Should be called before the data is created.

calculate

double calculate(double[] args)
                 throws TargetFunction.FunctionException

Calculates the target function on arguments.

Throws:

TargetFunction.FunctionException

getLabel

Attribute getLabel()

Returns the label attribute.

createArguments

double[] createArguments(int dimension,
                         RandomGenerator random)
                         throws TargetFunction.FunctionException

Creates and returns a number of arguments.

Throws:

TargetFunction.FunctionException

setLowerArgumentBound

void setLowerArgumentBound(double lower)

Sets the lower bound for the arguments.

setUpperArgumentBound

void setUpperArgumentBound(double upper)

Sets the upper bound for the arguments.

setTotalNumberOfExamples

void setTotalNumberOfExamples(int number)

Sets the maximal number of examples. This might be used by some target functions in order to create proper arguments.

setTotalNumberOfAttributes

void setTotalNumberOfAttributes(int number)

Sets the maximal number of attributes. This might be used by some target functions in order to create proper arguments.