com.rapidminer.operator.features.weighting
Class PSOWeighting

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.OperatorChain
          com.rapidminer.operator.features.weighting.PSOWeighting

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class PSOWeighting
extends OperatorChain

This operator performs the weighting of features with a particle swarm approach.

Author:

Ingo Mierswa

Field Summary

static java.lang.String	PARAMETER_DYNAMIC_INERTIA_WEIGHT The parameter name for "If set to true the inertia weight is improved during run.
static java.lang.String	PARAMETER_GENERATIONS_WITHOUT_IMPROVAL The parameter name for "Stop criterion: Stop after n generations without improval of the performance (-1: perform all generations).
static java.lang.String	PARAMETER_GLOBAL_BEST_WEIGHT The parameter name for "The weight for the population's best position during run.
static java.lang.String	PARAMETER_INERTIA_WEIGHT The parameter name for "The (initial) weight for the old weighting.
static java.lang.String	PARAMETER_LOCAL_BEST_WEIGHT The parameter name for "The weight for the individual's best position during run.
static java.lang.String	PARAMETER_LOCAL_RANDOM_SEED The parameter name for "Use the given random seed instead of global random numbers (-1: use global).
static java.lang.String	PARAMETER_MAX_WEIGHT The parameter name for "The upper bound for the weights.
static java.lang.String	PARAMETER_MAXIMUM_NUMBER_OF_GENERATIONS The parameter name for "Number of generations after which to terminate the algorithm.
static java.lang.String	PARAMETER_MIN_WEIGHT The parameter name for "The lower bound for the weights.
static java.lang.String	PARAMETER_NORMALIZE_WEIGHTS The parameter name for "Activates the normalization of all weights.
static java.lang.String	PARAMETER_POPULATION_SIZE The parameter name for "Number of individuals per generation.

Constructor Summary

PSOWeighting(OperatorDescription description)

Method Summary

IOObject[]	apply() Applies all inner operators.
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.
int	getMaxNumberOfInnerOperators() Returns the highest possible value for the maximum number of innner operators.
int	getMinNumberOfInnerOperators() Returns 0 for the minimum number of innner operators.
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.OperatorChain

addAddListener, addOperator, addOperator, checkDeprecations, checkIO, checkNumberOfInnerOperators, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createProcessTree, getAllInnerOperators, getIndexOfOperator, getInnerOperatorForName, getInnerOperatorsXML, getNumberOfAllOperators, getNumberOfOperators, getOperator, getOperatorFromAll, getOperators, performAdditionalChecks, processFinished, processStarts, registerOperator, removeAddListener, removeOperator, shouldAddNonConsumedInput, 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

Field Detail

PARAMETER_NORMALIZE_WEIGHTS

public static final java.lang.String PARAMETER_NORMALIZE_WEIGHTS

The parameter name for "Activates the normalization of all weights."

See Also:

Constant Field Values

PARAMETER_POPULATION_SIZE

public static final java.lang.String PARAMETER_POPULATION_SIZE

The parameter name for "Number of individuals per generation."

See Also:

Constant Field Values

PARAMETER_MAXIMUM_NUMBER_OF_GENERATIONS

public static final java.lang.String PARAMETER_MAXIMUM_NUMBER_OF_GENERATIONS

The parameter name for "Number of generations after which to terminate the algorithm."

See Also:

Constant Field Values

PARAMETER_GENERATIONS_WITHOUT_IMPROVAL

public static final java.lang.String PARAMETER_GENERATIONS_WITHOUT_IMPROVAL

The parameter name for "Stop criterion: Stop after n generations without improval of the performance (-1: perform all generations)."

See Also:

Constant Field Values

PARAMETER_INERTIA_WEIGHT

public static final java.lang.String PARAMETER_INERTIA_WEIGHT

The parameter name for "The (initial) weight for the old weighting."

See Also:

Constant Field Values

PARAMETER_LOCAL_BEST_WEIGHT

public static final java.lang.String PARAMETER_LOCAL_BEST_WEIGHT

The parameter name for "The weight for the individual's best position during run."

See Also:

Constant Field Values

PARAMETER_GLOBAL_BEST_WEIGHT

public static final java.lang.String PARAMETER_GLOBAL_BEST_WEIGHT

The parameter name for "The weight for the population's best position during run."

See Also:

Constant Field Values

PARAMETER_DYNAMIC_INERTIA_WEIGHT

public static final java.lang.String PARAMETER_DYNAMIC_INERTIA_WEIGHT

The parameter name for "If set to true the inertia weight is improved during run."

See Also:

Constant Field Values

PARAMETER_MIN_WEIGHT

public static final java.lang.String PARAMETER_MIN_WEIGHT

The parameter name for "The lower bound for the weights."

See Also:

Constant Field Values

PARAMETER_MAX_WEIGHT

public static final java.lang.String PARAMETER_MAX_WEIGHT

The parameter name for "The upper bound for the weights."

See Also:

Constant Field Values

PARAMETER_LOCAL_RANDOM_SEED

public static final java.lang.String PARAMETER_LOCAL_RANDOM_SEED

The parameter name for "Use the given random seed instead of global random numbers (-1: use global)."

See Also:

Constant Field Values

Constructor Detail

PSOWeighting

public PSOWeighting(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: OperatorChain

Applies all inner operators. The input to this operator becomes the input of the first inner operator. The latter's output is passed to the second inner operator and so on. Note to subclassers: If subclasses (for example wrappers) want to make use of this method remember to call exactly this method (super.apply()) and do not call super.apply(IOContainer) erroneously which will result in an infinite loop.

Overrides:

apply in class OperatorChain

Returns:

the last inner operator's output or the input itself if the chain is empty.

Throws:

OperatorException

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

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

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

getMaxNumberOfInnerOperators

public int getMaxNumberOfInnerOperators()

Returns the highest possible value for the maximum number of innner operators.

Specified by:

getMaxNumberOfInnerOperators in class OperatorChain

getMinNumberOfInnerOperators

public int getMinNumberOfInnerOperators()

Returns 0 for the minimum number of innner operators.

Specified by:

getMinNumberOfInnerOperators in class OperatorChain

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