com.datadoghq.sketch.ddsketch.encoding

Enum BinEncodingMode

java.lang.Object

java.lang.Enum<BinEncodingMode>

com.datadoghq.sketch.ddsketch.encoding.BinEncodingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BinEncodingMode>

public enum BinEncodingMode
extends java.lang.Enum<BinEncodingMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTIGUOUS_COUNTS Encodes N contiguous bins, specifying the count of each one.
INDEX_DELTAS Encodes N bins whose counts are each equal to 1.
INDEX_DELTAS_AND_COUNTS Encodes N bins, each one with its index and its count.

Method Summary

Modifier and Type	Method and Description
static BinEncodingMode	ofFlag(Flag flag)
Flag	toFlag(Flag.Type storeFlagType)
static BinEncodingMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BinEncodingMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INDEX_DELTAS_AND_COUNTS

public static final BinEncodingMode INDEX_DELTAS_AND_COUNTS

Encodes N bins, each one with its index and its count. Indexes are delta-encoded.

Encoding format:

• [byte] flag
• [uvarint64] number of bins N
• [varint64] index of first bin
• [varfloat64] count of first bin
• [varint64] difference between the index of the second bin and the index of the first bin
• [varfloat64] count of second bin
• ...
• [varint64] difference between the index of the N-th bin and the index of the (N-1)-th bin
• [varfloat64] count of N-th bin

INDEX_DELTAS

public static final BinEncodingMode INDEX_DELTAS

Encodes N bins whose counts are each equal to 1. Indexes are delta-encoded.

Encoding format:

• [byte] flag
• [uvarint64] number of bins N
• [varint64] index of first bin
• [varint64] difference between the index of the second bin and the index of the first bin
• ...
• [varint64] difference between the index of the N-th bin and the index of the (N-1)-th bin

CONTIGUOUS_COUNTS

public static final BinEncodingMode CONTIGUOUS_COUNTS

Encodes N contiguous bins, specifying the count of each one.

Encoding format:

• [byte] flag
• [uvarint64] number of bins N
• [varint64] index of first bin
• [varint64] difference between two successive indexes
• [varfloat64] count of first bin
• [varfloat64] count of second bin
• ...
• [varfloat64] count of N-th bin

Method Detail

values

public static BinEncodingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BinEncodingMode c : BinEncodingMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static BinEncodingMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toFlag

public final Flag toFlag(Flag.Type storeFlagType)

ofFlag

public static BinEncodingMode ofFlag(Flag flag)
                              throws InvalidFlagException

Throws:

InvalidFlagException