com.rapidminer.generator
Class BasicArithmeticOperationGenerator

java.lang.Object
  com.rapidminer.generator.FeatureGenerator
      com.rapidminer.generator.BinaryNumericalGenerator
          com.rapidminer.generator.BasicArithmeticOperationGenerator

public class BasicArithmeticOperationGenerator
extends BinaryNumericalGenerator

This class is a very simple implementation of a FeatureGenerator. It has two numerical input attributes and one output attribute. Depending on the mode specified in the constructor the result will be the sum, difference, product or quotient. The four modes are numered from 0 to 3 int this order.

Author:

Simon Fischer, Ingo Mierswa 15:35:40 ingomierswa Exp $

Field Summary

static int	DIFFERENCE
static int	PRODUCT
static int	QUOTIENT
static int	SUM

Fields inherited from class com.rapidminer.generator.FeatureGenerator

resultAttributes, SELECTION_MODE_ALL, SELECTION_MODE_RESTRICTIVE

Constructor Summary

BasicArithmeticOperationGenerator()

BasicArithmeticOperationGenerator(int mode)

Method Summary

double	calculateValue(double o1, double o2)
boolean	equals(java.lang.Object o) A FeatureGenerator equals another FeatureGenerator if its class is equal and its arguments are equal and its function names are equal.
java.lang.String	getFunction() Sets the function name.
int	hashCode()
boolean	isCommutative() Must return true if this generator is commutative.
boolean	isSelfApplicable() Must return true if this generator is self applicable.
FeatureGenerator	newInstance() Subclasses must implement this method so that a new instance of this generator class is returned.
void	setFunction(java.lang.String name) Sets the function name.

Methods inherited from class com.rapidminer.generator.BinaryNumericalGenerator

generate, getInputAttributes, getInputCandidates, getOutputAttributes, toString

Methods inherited from class com.rapidminer.generator.FeatureGenerator

argumentsSet, checkCompatibility, createGeneratorForFunction, generateAll, getArgument, getExampleTable, getSelectionMode, selectGenerator, setArguments, setExampleTable, setSelectionMode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SUM

public static final int SUM

See Also:

Constant Field Values

DIFFERENCE

public static final int DIFFERENCE

See Also:

Constant Field Values

PRODUCT

public static final int PRODUCT

See Also:

Constant Field Values

QUOTIENT

public static final int QUOTIENT

See Also:

Constant Field Values

Constructor Detail

BasicArithmeticOperationGenerator

public BasicArithmeticOperationGenerator(int mode)

BasicArithmeticOperationGenerator

public BasicArithmeticOperationGenerator()

Method Detail

isSelfApplicable

public boolean isSelfApplicable()

Description copied from class: BinaryNumericalGenerator

Must return true if this generator is self applicable.

Specified by:

isSelfApplicable in class BinaryNumericalGenerator

isCommutative

public boolean isCommutative()

Description copied from class: BinaryNumericalGenerator

Must return true if this generator is commutative.

Specified by:

isCommutative in class BinaryNumericalGenerator

newInstance

public FeatureGenerator newInstance()

Description copied from class: FeatureGenerator

Subclasses must implement this method so that a new instance of this generator class is returned. The arguments and the example table will not be cloned and thus be null. This kind of clone is needed as generating algorithms must be able to clone generators form their pool without changing the arguments already set for the others.

Specified by:

newInstance in class FeatureGenerator

calculateValue

public double calculateValue(double o1,
                             double o2)

Specified by:

calculateValue in class BinaryNumericalGenerator

setFunction

public void setFunction(java.lang.String name)

Description copied from class: FeatureGenerator

Sets the function name. This method is only useful if subclasses can generate more than one function. (like the BasicArithmeticOperationGenerator).

Specified by:

setFunction in class FeatureGenerator

getFunction

public java.lang.String getFunction()

Description copied from class: FeatureGenerator

Sets the function name. This method is only useful if subclasses can generate more than one function. (like the BasicArithmeticOperationGenerator).

Specified by:

getFunction in class FeatureGenerator

equals

public boolean equals(java.lang.Object o)

Description copied from class: FeatureGenerator

A FeatureGenerator equals another FeatureGenerator if its class is equal and its arguments are equal and its function names are equal.

Overrides:

equals in class FeatureGenerator

hashCode

public int hashCode()

Overrides:

hashCode in class FeatureGenerator