Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.metrics

Class HistogramUnionState

java.lang.Object

org.elasticsearch.search.aggregations.metrics.HistogramUnionState

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.util.Accountable, Releasable

public class HistogramUnionState
extends Object
implements Releasable, org.apache.lucene.util.Accountable

A state for holding potentially mixed data of exponential histogram and T-Digests. If the data is not mixed, the querying methods will just delegate to ExponentialHistogramState or TDigestState as appropriate. Otherwise the T-Digest data will be converted to exponential histogram and will be merged with the existing exponential histogram data to serve queries. This conversion will happen lazily: All T-Digests will be merged with each other and all exponential histograms will be merged with each other first, to preserve accuracy as much as possible. Only when a query is made that requires both data types, the conversion will happen.

Field Summary

Fields

Modifier and Type	Field	Description
static final HistogramUnionState	EMPTY
static final CircuitBreaker	NOOP_BREAKER

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Method Summary

Modifier and Type	Method	Description
void	add(double value)
void	add(double value, long count)
void	add(ExponentialHistogram histogram)
void	add(HistogramUnionState other)
void	add(TDigestState tdigest)
final double	cdf(double x)
final Collection<Centroid>	centroids()
void	close()
final void	compress()
double	compression()
static HistogramUnionState	create(CircuitBreaker breaker, double tDigestCompression)
static HistogramUnionState	create(CircuitBreaker breaker, TDigestExecutionHint executionHint, double tDigestCompression)
static HistogramUnionState	create(CircuitBreaker breaker, TDigestState.Type type, double tDigestCompression)
static HistogramUnionState	createUsingParamsFrom(HistogramUnionState otherState)
boolean	equals(Object o)
final double	getMax()
final double	getMin()
int	hashCode()
final double	quantile(double q)
long	ramBytesUsed()
static HistogramUnionState	read(CircuitBreaker breaker, StreamInput in)
static HistogramUnionState	readAsPureTDigest(CircuitBreaker breaker, StreamInput in)	Reads a HistogramUnionState serialized via writeAsPureTDigestTo(StreamOutput).
final long	size()
static HistogramUnionState	wrap(CircuitBreaker breaker, TDigestState tdigest)
void	writeAsPureTDigestTo(StreamOutput out)	Writes this state so that it can be deserialized via TDigestState.read(StreamInput).
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Field Details

EMPTY

public static final HistogramUnionState EMPTY

NOOP_BREAKER

public static final CircuitBreaker NOOP_BREAKER

Method Details

create

public static HistogramUnionState create(CircuitBreaker breaker,
 double tDigestCompression)

create

public static HistogramUnionState create(CircuitBreaker breaker,
 TDigestState.Type type,
 double tDigestCompression)

create

public static HistogramUnionState create(CircuitBreaker breaker,
 TDigestExecutionHint executionHint,
 double tDigestCompression)

createUsingParamsFrom

public static HistogramUnionState createUsingParamsFrom(HistogramUnionState otherState)

wrap

public static HistogramUnionState wrap(CircuitBreaker breaker,
 TDigestState tdigest)

add

public void add(HistogramUnionState other)

add

public void add(ExponentialHistogram histogram)

add

public void add(double value)

add

public void add(double value,
 long count)

add

public void add(TDigestState tdigest)

compression

public double compression()

compress

public final void compress()

size

public final long size()

cdf

public final double cdf(double x)

quantile

public final double quantile(double q)

centroids

public final Collection<Centroid> centroids()

getMin

public final double getMin()

getMax

public final double getMax()

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

read

public static HistogramUnionState read(CircuitBreaker breaker,
 StreamInput in)
                                throws IOException

Throws:

IOException

writeAsPureTDigestTo

public void writeAsPureTDigestTo(StreamOutput out)
                          throws IOException

Writes this state so that it can be deserialized via TDigestState.read(StreamInput).

Throws:

IOException

readAsPureTDigest

public static HistogramUnionState readAsPureTDigest(CircuitBreaker breaker,
 StreamInput in)
                                             throws IOException

Reads a HistogramUnionState serialized via writeAsPureTDigestTo(StreamOutput). This means it is also capable of serializing data which was written via TDigestState.write(TDigestState, StreamOutput).

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object