com.rapidminer.operator.meta
Class ParameterOptimizationOperator

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.OperatorChain
          com.rapidminer.operator.meta.ParameterIteratingOperatorChain
              com.rapidminer.operator.meta.ParameterOptimizationOperator

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

Direct Known Subclasses:

EvolutionaryParameterOptimizationOperator, GridSearchParameterOptimizationOperator

public abstract class ParameterOptimizationOperator
extends ParameterIteratingOperatorChain

This operator provides basic functions for all other parameter optimization operators.

Author:

Ingo Mierswa, Helge Homburg, Tobias Malbrecht ingomierswa Exp $

Field Summary

Fields inherited from class com.rapidminer.operator.meta.ParameterIteratingOperatorChain

PARAMETER_PARAMETERS, PARAMETER_VALUES, VALUE_MODE_CONTINUOUS, VALUE_MODE_DISCRETE

Constructor Summary

ParameterOptimizationOperator(OperatorDescription description)

Method Summary

abstract double	getCurrentBestPerformance()
InnerOperatorCondition	getInnerOperatorCondition() Must return a condition of the IO behaviour of all desired inner operators.
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.
protected PerformanceVector	getPerformance() Applies the inner operator and employs the PerformanceEvaluator for calculating a list of performance criteria which is returned.
protected PerformanceVector	getPerformance(IOContainer input, java.util.Collection<Operator> operators) Applies the given operators and employs the PerformanceEvaluator for calculating a list of performance criteria which is returned.

Methods inherited from class com.rapidminer.operator.meta.ParameterIteratingOperatorChain

getMaxNumberOfInnerOperators, getMinNumberOfInnerOperators, getParameterTypes, getParameterValueMode, parseParameterValues, shouldAddNonConsumedInput

Methods inherited from class com.rapidminer.operator.OperatorChain

addAddListener, addOperator, addOperator, apply, checkDeprecations, checkIO, checkNumberOfInnerOperators, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createProcessTree, getAllInnerOperators, getIndexOfOperator, getInnerOperatorForName, getInnerOperatorsXML, getNumberOfAllOperators, getNumberOfOperators, getOperator, getOperatorFromAll, getOperators, performAdditionalChecks, processFinished, processStarts, registerOperator, removeAddListener, removeOperator, shouldReturnInnerOutput, unregisterOperator

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkForStop, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, 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, register, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, writeXML

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterOptimizationOperator

public ParameterOptimizationOperator(OperatorDescription description)

Method Detail

getCurrentBestPerformance

public abstract double getCurrentBestPerformance()

getPerformance

protected PerformanceVector getPerformance(IOContainer input,
                                           java.util.Collection<Operator> operators)

Applies the given operators and employs the PerformanceEvaluator for calculating a list of performance criteria which is returned.

getPerformance

protected PerformanceVector getPerformance()

Applies the inner operator and employs the PerformanceEvaluator for calculating a list of performance criteria which is returned.

getInnerOperatorCondition

public InnerOperatorCondition getInnerOperatorCondition()

Description copied from class: OperatorChain

Must return a condition of the IO behaviour of all desired inner operators. If there are no "special" conditions and the chain works similar to a simple operator chain this method should at least return a SimpleChainInnerOperatorCondition. More than one condition should be combined with help of the class CombinedInnerOperatorCondition.

Specified by:

getInnerOperatorCondition in class OperatorChain

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