io.warp10.script.aggregator

Class CircularMean

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.aggregator.CircularMean

All Implemented Interfaces:

WarpScriptAggregatorFunction, WarpScriptBucketizerFunction, WarpScriptMapperFunction, WarpScriptReducerFunction

public class CircularMean
extends NamedWarpScriptFunction
implements WarpScriptMapperFunction, WarpScriptReducerFunction, WarpScriptBucketizerFunction

Compute the mean of circular quantities

See Also:

https://en.wikipedia.org/wiki/Mean_of_circular_quantities

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CircularMean.Builder

Constructor Summary

Constructors

Constructor and Description
CircularMean(java.lang.String name, double period, boolean forbidNulls)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(java.lang.Object[] args)
java.lang.String	toString()

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularMean

public CircularMean(java.lang.String name,
                    double period,
                    boolean forbidNulls)

Method Detail

apply

public java.lang.Object apply(java.lang.Object[] args)
                       throws WarpScriptException

Specified by:

apply in interface WarpScriptAggregatorFunction

Throws:

WarpScriptException

toString

public java.lang.String toString()

Overrides:

toString in class NamedWarpScriptFunction