Class EwmaModel
java.lang.Object
org.elasticsearch.search.aggregations.pipeline.MovAvgModel
org.elasticsearch.search.aggregations.pipeline.EwmaModel
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
public class EwmaModel extends MovAvgModel
Calculate a exponentially weighted moving average
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EwmaModel.EWMAModelBuilder
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.pipeline.MovAvgModel
MovAvgModel.AbstractModelParser
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAME
static MovAvgModel.AbstractModelParser
PARSER
-
Constructor Summary
Constructors Constructor Description EwmaModel()
EwmaModel(double alpha)
EwmaModel(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description boolean
canBeMinimized()
Returns if the model can be cost minimized.MovAvgModel
clone()
Clone the model, returning an exact copyprotected double[]
doPredict(java.util.Collection<java.lang.Double> values, int numPredictions)
Calls to the model-specific implementation which actually generates the predictionsboolean
equals(java.lang.Object obj)
java.lang.String
getWriteableName()
Returns the name of the writeable objectint
hashCode()
MovAvgModel
neighboringModel()
Generates a "neighboring" model, where one of the tunable parameters has been randomly mutated within the allowed range.double
next(java.util.Collection<java.lang.Double> values)
Returns the next value in the series, according to the underlying smoothing modelXContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write the model to the output streamMethods inherited from class org.elasticsearch.search.aggregations.pipeline.MovAvgModel
emptyPredictions, hasValue, minimizeByDefault, predict, validate
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
PARSER
-
-
Constructor Details
-
Method Details
-
writeTo
Description copied from class:MovAvgModel
Write the model to the output stream- Specified by:
writeTo
in interfaceWriteable
- Specified by:
writeTo
in classMovAvgModel
- Parameters:
out
- Output stream- Throws:
java.io.IOException
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
canBeMinimized
public boolean canBeMinimized()Description copied from class:MovAvgModel
Returns if the model can be cost minimized. Not all models have parameters which can be tuned / optimized.- Specified by:
canBeMinimized
in classMovAvgModel
-
neighboringModel
Description copied from class:MovAvgModel
Generates a "neighboring" model, where one of the tunable parameters has been randomly mutated within the allowed range. Used for minimization- Specified by:
neighboringModel
in classMovAvgModel
-
clone
Description copied from class:MovAvgModel
Clone the model, returning an exact copy- Specified by:
clone
in classMovAvgModel
-
doPredict
protected double[] doPredict(java.util.Collection<java.lang.Double> values, int numPredictions)Description copied from class:MovAvgModel
Calls to the model-specific implementation which actually generates the predictions- Specified by:
doPredict
in classMovAvgModel
- Parameters:
values
- Collection of numerics to movingAvg, usually windowednumPredictions
- Number of newly generated predictions to return- Returns:
- Returns an array of doubles, since most smoothing methods operate on floating points
-
next
public double next(java.util.Collection<java.lang.Double> values)Description copied from class:MovAvgModel
Returns the next value in the series, according to the underlying smoothing model- Specified by:
next
in classMovAvgModel
- Parameters:
values
- Collection of numerics to movingAvg, usually windowed- Returns:
- Returns a double, since most smoothing methods operate on floating points
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Specified by:
hashCode
in classMovAvgModel
-
equals
public boolean equals(java.lang.Object obj)- Specified by:
equals
in classMovAvgModel
-