Module org.elasticsearch.compute

Package org.elasticsearch.compute.data

Enum Class HistogramBlock.Component

java.lang.Object

java.lang.Enum<HistogramBlock.Component>

org.elasticsearch.compute.data.HistogramBlock.Component

All Implemented Interfaces:

Serializable, Comparable<HistogramBlock.Component>, Constable

Enclosing interface:

HistogramBlock

public static enum HistogramBlock.Component
extends Enum<HistogramBlock.Component>

Exponential histograms are composite data types. This enum defines the components that can be directly accessed, potentially avoiding loading the entire histogram from disk.
This enum can be safely serialized via StreamOutput.writeEnum(Enum).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COUNT	The number of all values summarized by the histogram, 0 if the histogram is empty.
MAX	The maximum of all values summarized by the histogram, null if the histogram is empty.
MIN	The minimum of all values summarized by the histogram, null if the histogram is empty.
SUM	The sum of all values summarized by the histogram, 0.0 if the histogram is empty.

Method Summary

Modifier and Type	Method	Description
static HistogramBlock.Component	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HistogramBlock.Component[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MIN

public static final HistogramBlock.Component MIN

The minimum of all values summarized by the histogram, null if the histogram is empty.

MAX

public static final HistogramBlock.Component MAX

The maximum of all values summarized by the histogram, null if the histogram is empty.

SUM

public static final HistogramBlock.Component SUM

The sum of all values summarized by the histogram, 0.0 if the histogram is empty.

COUNT

public static final HistogramBlock.Component COUNT

The number of all values summarized by the histogram, 0 if the histogram is empty.

Method Details

values

public static HistogramBlock.Component[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HistogramBlock.Component valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null