com.rapidminer.tools.math.function.aggregation
Class AverageFunction

java.lang.Object
  com.rapidminer.tools.math.function.aggregation.AbstractAggregationFunction
      com.rapidminer.tools.math.function.aggregation.AverageFunction

All Implemented Interfaces:

AggregationFunction

public class AverageFunction
extends AbstractAggregationFunction

Calculates the average.

Author:

Tobias Malbrecht, Ingo Mierswa

Field Summary

Fields inherited from class com.rapidminer.tools.math.function.aggregation.AbstractAggregationFunction

AVERAGE, COUNT, DEFAULT_IGNORE_MISSINGS, foundMissing, ignoreMissings, KNOWN_AGGREGATION_FUNCTION_NAMES, KNOWN_AGGREGATION_FUNCTIONS, MAXIMUM, MEDIAN, MINIMUM, MODE, STANDARD_DEVIATION, SUM, VARIANCE

Constructor Summary

AverageFunction()

AverageFunction(java.lang.Boolean ignoreMissings)

Method Summary

java.lang.String	getName() Returns the name of the aggregation function.
double	getValue() Returns the function value.
protected void	reset() Reset the counters.
boolean	supportsAttribute(Attribute attribute) Returns whether this function supports the given attribute.
void	update(double value) Consider a new value by updating counters.
void	update(double value, double weight) Consider a new value and a corresponding weight by updating counters.

Methods inherited from class com.rapidminer.tools.math.function.aggregation.AbstractAggregationFunction

calculate, calculate, createAggregationFunction, createAggregationFunction, createAggregationFunction, createAggregationFunction

Methods inherited from class java.lang.Object

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

Constructor Detail

AverageFunction

public AverageFunction()

AverageFunction

public AverageFunction(java.lang.Boolean ignoreMissings)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: AggregationFunction

Returns the name of the aggregation function.

reset

protected void reset()

Description copied from class: AbstractAggregationFunction

Reset the counters.

Specified by:

reset in class AbstractAggregationFunction

update

public void update(double value,
                   double weight)

Description copied from interface: AggregationFunction

Consider a new value and a corresponding weight by updating counters.

update

public void update(double value)

Description copied from interface: AggregationFunction

Consider a new value by updating counters.

getValue

public double getValue()

Description copied from interface: AggregationFunction

Returns the function value.

supportsAttribute

public boolean supportsAttribute(Attribute attribute)

Description copied from interface: AggregationFunction

Returns whether this function supports the given attribute.