com.datadoghq.sketch.ddsketch.encoding

Enum IndexMappingLayout

java.lang.Object

java.lang.Enum<IndexMappingLayout>

com.datadoghq.sketch.ddsketch.encoding.IndexMappingLayout

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOG Encodes the logarithmic index mapping, specifying the base \(\gamma\) and the index offset.
LOG_CUBIC Encodes the logarithmic index mapping with cubic interpolation between powers of 2, specifying the base \(\gamma\) and the index offset.
LOG_LINEAR Encodes the logarithmic index mapping with linear interpolation between powers of 2, specifying the base \(\gamma\) and the index offset.
LOG_QUADRATIC Encodes the logarithmic index mapping with quadratic interpolation between powers of 2, specifying the base \(\gamma\) and the index offset.
LOG_QUARTIC Encodes the logarithmic index mapping with wuartic interpolation between powers of 2, specifying the base \(\gamma\) and the index offset.

Method Summary

Modifier and Type	Method and Description
static IndexMappingLayout	ofFlag(Flag flag)
Flag	toFlag()
static IndexMappingLayout	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IndexMappingLayout[]	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

LOG

public static final IndexMappingLayout LOG

Encodes the logarithmic index mapping, specifying the base \(\gamma\) and the index offset.

Encoding format:

• [byte] flag
• [float64LE] gamma
• [float64LE] index offset

LOG_LINEAR

public static final IndexMappingLayout LOG_LINEAR

Encodes the logarithmic index mapping with linear interpolation between powers of 2, specifying the base \(\gamma\) and the index offset.

Encoding format:

• [byte] flag
• [float64LE] gamma
• [float64LE] index offset

LOG_QUADRATIC

public static final IndexMappingLayout LOG_QUADRATIC

Encodes the logarithmic index mapping with quadratic interpolation between powers of 2, specifying the base \(\gamma\) and the index offset.

Encoding format:

• [byte] flag
• [float64LE] gamma
• [float64LE] index offset

LOG_CUBIC

public static final IndexMappingLayout LOG_CUBIC

Encodes the logarithmic index mapping with cubic interpolation between powers of 2, specifying the base \(\gamma\) and the index offset.

Encoding format:

• [byte] flag
• [float64LE] gamma
• [float64LE] index offset

LOG_QUARTIC

public static final IndexMappingLayout LOG_QUARTIC

Encodes the logarithmic index mapping with wuartic interpolation between powers of 2, specifying the base \(\gamma\) and the index offset.

Encoding format:

• [byte] flag
• [float64LE] gamma
• [float64LE] index offset

Method Detail

values

public static IndexMappingLayout[] 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 (IndexMappingLayout c : IndexMappingLayout.values())
    System.out.println(c);

Returns:

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

valueOf

public static IndexMappingLayout 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()

ofFlag

public static IndexMappingLayout ofFlag(Flag flag)
                                 throws InvalidFlagException

Throws:

InvalidFlagException