io.crate.execution.engine.aggregation.impl

Class GeometricMeanAggregation

java.lang.Object

io.crate.execution.engine.aggregation.AggregationFunction<GeometricMeanAggregation.GeometricMeanState,java.lang.Double>

io.crate.execution.engine.aggregation.impl.GeometricMeanAggregation

All Implemented Interfaces:

FunctionImplementation

public class GeometricMeanAggregation
extends AggregationFunction<GeometricMeanAggregation.GeometricMeanState,java.lang.Double>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeometricMeanAggregation.GeometricMeanState
static class	GeometricMeanAggregation.GeometricMeanStateType

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GeometricMeanAggregation(FunctionInfo info)

Method Summary

Modifier and Type	Method and Description
FunctionInfo	info() Provides meta information about this function implementation.
GeometricMeanAggregation.GeometricMeanState	iterate(RamAccountingContext ramAccountingContext, GeometricMeanAggregation.GeometricMeanState state, Input... args) the "aggregate" function.
GeometricMeanAggregation.GeometricMeanState	newState(RamAccountingContext ramAccountingContext, org.elasticsearch.Version indexVersionCreated, org.elasticsearch.common.util.BigArrays bigArrays) Called once per "aggregation cycle" to create an initial partial-state-value.
DataType	partialType()
GeometricMeanAggregation.GeometricMeanState	reduce(RamAccountingContext ramAccountingContext, GeometricMeanAggregation.GeometricMeanState state1, GeometricMeanAggregation.GeometricMeanState state2) This function merges two aggregation states together and returns that merged state.
static void	register(AggregationImplModule mod)
java.lang.Double	terminatePartial(RamAccountingContext ramAccountingContext, GeometricMeanAggregation.GeometricMeanState state) Called to transform partial states into their final form.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.crate.metadata.FunctionImplementation

normalizeSymbol

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

GeometricMeanAggregation

public GeometricMeanAggregation(FunctionInfo info)

Method Detail

register

public static void register(AggregationImplModule mod)

newState

@Nullable
public GeometricMeanAggregation.GeometricMeanState newState(RamAccountingContext ramAccountingContext,
                                                                      org.elasticsearch.Version indexVersionCreated,
                                                                      org.elasticsearch.common.util.BigArrays bigArrays)

Description copied from class: AggregationFunction

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

Specified by:

newState in class AggregationFunction<GeometricMeanAggregation.GeometricMeanState,java.lang.Double>

Parameters:

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

indexVersionCreated - the version the current index was created on, this is useful for BWC

bigArrays - the BigArrays singleton instance of the current node

Returns:

a new state instance or null

iterate

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

Description copied from class: AggregationFunction

the "aggregate" function.

Specified by:

iterate in class AggregationFunction<GeometricMeanAggregation.GeometricMeanState,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 GeometricMeanAggregation.GeometricMeanState reduce(RamAccountingContext ramAccountingContext,
                                                          GeometricMeanAggregation.GeometricMeanState state1,
                                                          GeometricMeanAggregation.GeometricMeanState 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<GeometricMeanAggregation.GeometricMeanState,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,
                                         GeometricMeanAggregation.GeometricMeanState 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<GeometricMeanAggregation.GeometricMeanState,java.lang.Double>

partialType

public DataType partialType()

Specified by:

partialType in class AggregationFunction<GeometricMeanAggregation.GeometricMeanState,java.lang.Double>

info

public FunctionInfo info()

Description copied from interface: FunctionImplementation

Provides meta information about this function implementation.