com.rapidminer.operator
Class MacroConstructionOperator

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.MacroConstructionOperator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class MacroConstructionOperator
extends Operator

This operator constructs new macros from expressions which might also use already existing macros. The names of the new macros and their construction description are defined in the parameter list "functions".

The following operators are supported:

• Addition: +
• Subtraction: -
• Multiplication: *
• Division: /
• Power: ^
• Modulus: %
• Less Than: <
• Greater Than: >
• Less or Equal: <=
• More or Equal: >=
• Equal: ==
• Not Equal: !=
• Boolean Not: !
• Boolean And: two ampers and
• Boolean Or: ||

The following log and exponential functions are supported:

• Natural Logarithm: ln(x)
• Logarithm Base 10: log(x)
• Logarithm Dualis (Base 2): ld(x)
• Exponential (e^x): exp(x)
• Power: pow(x,y)

The following trigonometric functions are supported:

• Sine: sin(x)
• Cosine: cos(x)
• Tangent: tan(x)
• Arc Sine: asin(x)
• Arc Cosine: acos(x)
• Arc Tangent: atan(x)
• Arc Tangent (with 2 parameters): atan2(x,y)
• Hyperbolic Sine: sinh(x)
• Hyperbolic Cosine: cosh(x)
• Hyperbolic Tangent: tanh(x)
• Inverse Hyperbolic Sine: asinh(x)
• Inverse Hyperbolic Cosine: acosh(x)
• Inverse Hyperbolic Tangent: atanh(x)

The following statistical functions are supported:

• Round: round(x)
• Round to p decimals: round(x,p)
• Floor: floor(x)
• Ceiling: ceil(x)

The following miscellaneous functions are supported:

• Average: avg(x,y,z...)
• Minimum: min(x,y,z...)
• Maximum: max(x,y,z...)

The following miscellaneous functions are supported:

• If-Then-Else: if(cond,true-evaluation, false-evaluation)
• Absolute: abs(x)
• Square Root: sqrt(x)
• Signum (delivers the sign of a number): sgn(x)
• Random Number (between 0 and 1): rand()
• Modulus (x % y): mod(x,y)
• Sum of k Numbers: sum(x,y,z...)
• Binomial Coefficients: binom(n, i)
• Number to String: str(x)

Beside those operators and functions, this operator also supports the constants pi and e if this is indicated by the corresponding parameter (default: true). You can also use strings in formulas (for example in a conditioned if-formula) but the string values have to be enclosed in double quotes.

Please note that there are some restrictions for the usage of other macros. The values of used macros have to fulfill the following in order to let this operator work properly:

• If the standard constants are usable, macro values with names like "e" or "pi" are not allowed.
• Macro values with function or operator names are also not allowed.
• Macro values containing parentheses are not allowed.

Examples:
17+sin(%{macro1}*%{macro2})
if (%macro1}>5, %{macro2}*%{macro3}, -abs(%{macro4}))

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_FUNCTIONS The parameter name for "List of functions to generate.
static java.lang.String	PARAMETER_USE_STANDARD_CONSTANTS Indicates if standard constants like e or pi should be available.

Constructor Summary

MacroConstructionOperator(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
java.lang.Class<?>[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkDeprecations, checkForStop, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getProcess, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isEnabled, isExpanded, isParallel, isParameterSet, log, logError, logNote, logWarning, performAdditionalChecks, processFinished, processStarts, register, registerOperator, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, unregisterOperator, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_FUNCTIONS

public static final java.lang.String PARAMETER_FUNCTIONS

The parameter name for "List of functions to generate."

See Also:

Constant Field Values

PARAMETER_USE_STANDARD_CONSTANTS

public static final java.lang.String PARAMETER_USE_STANDARD_CONSTANTS

Indicates if standard constants like e or pi should be available.

See Also:

Constant Field Values

Constructor Detail

MacroConstructionOperator

public MacroConstructionOperator(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

getInputClasses

public java.lang.Class<?>[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class<?>[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input objects which should not be consumed must also be defined by this method (e.g. an example set which is changed but not consumed in the case of a preprocessing operator must be defined in both, the methods Operator.getInputClasses() and Operator.getOutputClasses()). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed (defined by changing the implementation in Operator.getInputDescription(Class)) must not be defined as additional output in this method.

May deliver null or an empy array (no additional output is produced or guaranteed). Must return the class array of delivered output objects otherwise.

Specified by:

getOutputClasses in class Operator

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator