Class InternalHDRPercentileRanks
java.lang.Object
org.opensearch.search.aggregations.InternalAggregation
org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation
org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation.MultiValue
org.opensearch.search.aggregations.metrics.InternalHDRPercentileRanks
- All Implemented Interfaces:
java.lang.Iterable<Percentile>
,NamedWriteable
,Writeable
,org.opensearch.common.xcontent.ToXContent
,org.opensearch.common.xcontent.ToXContentFragment
,Aggregation
,NumericMetricsAggregation
,NumericMetricsAggregation.MultiValue
,PercentileRanks
public class InternalHDRPercentileRanks extends InternalNumericMetricsAggregation.MultiValue implements PercentileRanks
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InternalHDRPercentileRanks.Iter
Nested classes/interfaces inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation
InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue
Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalAggregation
InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder
Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation
Aggregation.CommonFields
Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.metrics.NumericMetricsAggregation
NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue
Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent
org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description protected boolean
keyed
protected double[]
keys
static java.lang.String
NAME
protected org.HdrHistogram.DoubleHistogram
state
Fields inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation
format
Fields inherited from interface org.opensearch.search.aggregations.metrics.PercentileRanks
TYPE_NAME
-
Constructor Summary
Constructors Constructor Description InternalHDRPercentileRanks(java.lang.String name, double[] cdfValues, org.HdrHistogram.DoubleHistogram state, boolean keyed, DocValueFormat formatter, java.util.Map<java.lang.String,java.lang.Object> metadata)
InternalHDRPercentileRanks(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description protected org.opensearch.search.aggregations.metrics.AbstractInternalHDRPercentiles
createReduced(java.lang.String name, double[] keys, org.HdrHistogram.DoubleHistogram merged, boolean keyed, java.util.Map<java.lang.String,java.lang.Object> metadata)
protected void
doWriteTo(StreamOutput out)
org.opensearch.common.xcontent.XContentBuilder
doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
boolean
equals(java.lang.Object obj)
DocValueFormat
formatter()
long
getEstimatedMemoryFootprint()
double[]
getKeys()
Return the keys (percentiles) requested.org.HdrHistogram.DoubleHistogram
getState()
Return the internalDoubleHistogram
sketch for this metric.java.lang.String
getWriteableName()
Returns the name of the writeable objectint
hashCode()
java.util.Iterator<Percentile>
iterator()
boolean
keyed()
Should the output be keyed.double
percent(double value)
Return the percentile for the given value.java.lang.String
percentAsString(double value)
Return the percentile for the given value as a String.static double
percentileRank(org.HdrHistogram.DoubleHistogram state, double value)
org.opensearch.search.aggregations.metrics.AbstractInternalHDRPercentiles
reduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
Reduces the given aggregations to a single one and returns it.double
value(double key)
double
value(java.lang.String name)
Methods inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation.MultiValue
getProperty, sortValue, valueAsString
Methods inherited from class org.opensearch.search.aggregations.metrics.InternalNumericMetricsAggregation
mustReduceOnSingleInternalAgg, sortValue
Methods inherited from class org.opensearch.search.aggregations.InternalAggregation
copyWithRewritenBuckets, forEachBucket, getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, reducePipelines, toString, toXContent, writeSize, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opensearch.search.aggregations.Aggregation
getMetadata, getName, getType
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
keys
protected final double[] keys -
state
protected final org.HdrHistogram.DoubleHistogram state -
keyed
protected final boolean keyed
-
-
Constructor Details
-
InternalHDRPercentileRanks
public InternalHDRPercentileRanks(java.lang.String name, double[] cdfValues, org.HdrHistogram.DoubleHistogram state, boolean keyed, DocValueFormat formatter, java.util.Map<java.lang.String,java.lang.Object> metadata) -
InternalHDRPercentileRanks
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
-
iterator
- Specified by:
iterator
in interfacejava.lang.Iterable<Percentile>
-
percent
public double percent(double value)Description copied from interface:PercentileRanks
Return the percentile for the given value.- Specified by:
percent
in interfacePercentileRanks
-
percentAsString
public java.lang.String percentAsString(double value)Description copied from interface:PercentileRanks
Return the percentile for the given value as a String.- Specified by:
percentAsString
in interfacePercentileRanks
-
value
public double value(double key) -
createReduced
protected org.opensearch.search.aggregations.metrics.AbstractInternalHDRPercentiles createReduced(java.lang.String name, double[] keys, org.HdrHistogram.DoubleHistogram merged, boolean keyed, java.util.Map<java.lang.String,java.lang.Object> metadata) -
percentileRank
public static double percentileRank(org.HdrHistogram.DoubleHistogram state, double value) -
doWriteTo
- Specified by:
doWriteTo
in classInternalAggregation
- Throws:
java.io.IOException
-
value
public double value(java.lang.String name)- Specified by:
value
in classInternalNumericMetricsAggregation.MultiValue
-
formatter
-
getEstimatedMemoryFootprint
public long getEstimatedMemoryFootprint() -
getState
public org.HdrHistogram.DoubleHistogram getState()Return the internalDoubleHistogram
sketch for this metric. -
getKeys
public double[] getKeys()Return the keys (percentiles) requested. -
keyed
public boolean keyed()Should the output be keyed. -
reduce
public org.opensearch.search.aggregations.metrics.AbstractInternalHDRPercentiles reduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)Description copied from class:InternalAggregation
Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.- Specified by:
reduce
in classInternalAggregation
- See Also:
InternalAggregation.mustReduceOnSingleInternalAgg()
-
doXContentBody
public org.opensearch.common.xcontent.XContentBuilder doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
doXContentBody
in classInternalAggregation
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classInternalNumericMetricsAggregation
-
hashCode
public int hashCode()- Overrides:
hashCode
in classInternalNumericMetricsAggregation
-