io.crate.operation.aggregation.impl

Class VarianceAggregation

java.lang.Object

io.crate.operation.aggregation.AggregationFunction<VarianceAggregation.VarianceState,java.lang.Double>

io.crate.operation.aggregation.impl.VarianceAggregation

All Implemented Interfaces:

FunctionImplementation<Function>

public class VarianceAggregation
extends AggregationFunction<VarianceAggregation.VarianceState,java.lang.Double>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VarianceAggregation.VarianceState
static class	VarianceAggregation.VarianceStateType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
VarianceAggregation(FunctionInfo info)

Method Summary

Modifier and Type	Method and Description
FunctionInfo	info()
VarianceAggregation.VarianceState	iterate(RamAccountingContext ramAccountingContext, VarianceAggregation.VarianceState state, Input... args) the "aggregate" function.
VarianceAggregation.VarianceState	newState(RamAccountingContext ramAccountingContext) Called once per "aggregation cycle" to create an initial partial-state-value.
DataType	partialType()
VarianceAggregation.VarianceState	reduce(RamAccountingContext ramAccountingContext, VarianceAggregation.VarianceState state1, VarianceAggregation.VarianceState state2) This function merges two aggregation states together and returns that merged state.
static void	register(AggregationImplModule mod)
java.lang.Double	terminatePartial(RamAccountingContext ramAccountingContext, VarianceAggregation.VarianceState state) Called to transform partial states into their final form.

Methods inherited from class io.crate.operation.aggregation.AggregationFunction

normalizeSymbol

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

VarianceAggregation

public VarianceAggregation(FunctionInfo info)

Method Detail

register

public static void register(AggregationImplModule mod)

newState

@Nullable
public VarianceAggregation.VarianceState newState(RamAccountingContext ramAccountingContext)

Description copied from class: AggregationFunction

Called once per "aggregation cycle" to create an initial partial-state-value.

Specified by:

newState in class AggregationFunction<VarianceAggregation.VarianceState,java.lang.Double>

Parameters:

ramAccountingContext - used to account the memory used for the state.

Returns:

a new state instance or null

iterate

public VarianceAggregation.VarianceState iterate(RamAccountingContext ramAccountingContext,
                                                 VarianceAggregation.VarianceState state,
                                                 Input... args)
                                          throws org.elasticsearch.common.breaker.CircuitBreakingException

Description copied from class: AggregationFunction

the "aggregate" function.

Specified by:

iterate in class AggregationFunction<VarianceAggregation.VarianceState,java.lang.Double>

Parameters:

ramAccountingContext - used to account for additional memory usage if the state grows in size

state - the previous aggregation state

args - arguments / input values matching the types of FunctionInfo.argumentTypes. These are usually used to increment/modify the previous state

Returns:

The new/changed state. This might be either a new instance or the same but mutated instance. Users of the AggregationFunction should always use the return value, but must be aware that the input state might have changed too.

Throws:

org.elasticsearch.common.breaker.CircuitBreakingException

reduce

public VarianceAggregation.VarianceState reduce(RamAccountingContext ramAccountingContext,
                                                VarianceAggregation.VarianceState state1,
                                                VarianceAggregation.VarianceState state2)

Description copied from class: AggregationFunction

This function merges two aggregation states together and returns that merged state. This is used in a distributed aggregation workflow where 2 partial aggregations are reduced into 1 partial aggregation

Specified by:

reduce in class AggregationFunction<VarianceAggregation.VarianceState,java.lang.Double>

Returns:

the reduced state. This might be a new instance or a mutated state1 or state2.

terminatePartial

public java.lang.Double terminatePartial(RamAccountingContext ramAccountingContext,
                                         VarianceAggregation.VarianceState state)

Description copied from class: AggregationFunction

Called to transform partial states into their final form. This might result in a loss of "meta data" that was necessary to compute the final value.

Specified by:

terminatePartial in class AggregationFunction<VarianceAggregation.VarianceState,java.lang.Double>

partialType

public DataType partialType()

Specified by:

partialType in class AggregationFunction<VarianceAggregation.VarianceState,java.lang.Double>

info

public FunctionInfo info()