com.yahoo.sketches.hll

Class Preamble

java.lang.Object

com.yahoo.sketches.hll.Preamble

public final class Preamble
extends Object

Author:

Kevin Lang

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Preamble.Builder Builder for the Preamble

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static Preamble	fromLogK(int logK) Instantiates a new Preamble with the parameter log_base2 of K.
static Preamble	fromMemory(Memory memory) Instantiates a new Preamble from the given Memory
int	getConfigK() Gets the configured K
byte	getFamilyId() Gets the Family ID
byte	getFlags() Gets the flags byte
byte	getLogConfigK() Gets the log_base2 of the configured K
int	getMaxAuxSize() Gets the maximum auxiliary size
byte	getPreambleLongs() Gets the size of the Preamble in longs
short	getSeedHash() Gets the seed hash
byte	getVersion() Gets the serialization version of this Preamble
int	hashCode()
byte[]	toByteArray() Serializes this Preamble to a byte array.

Methods inherited from class java.lang.Object

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

Method Detail

fromMemory

public static Preamble fromMemory(Memory memory)

Instantiates a new Preamble from the given Memory

Parameters:

memory - the given Memory

Returns:

a new Preamble from the given Memory

fromLogK

public static Preamble fromLogK(int logK)

Instantiates a new Preamble with the parameter log_base2 of K.

Parameters:

logK - log_base2 of the desired K

Returns:

a new Preamble with the parameter log_base2 of K.

toByteArray

public byte[] toByteArray()

Serializes this Preamble to a byte array.

Returns:

this Preamble as a byte array

getPreambleLongs

public byte getPreambleLongs()

Gets the size of the Preamble in longs

Returns:

the size of the Preamble in longs

getVersion

public byte getVersion()

Gets the serialization version of this Preamble

Returns:

the serialization version of this Preamble

getFamilyId

public byte getFamilyId()

Gets the Family ID

Returns:

the Family ID

getLogConfigK

public byte getLogConfigK()

Gets the log_base2 of the configured K

Returns:

the log_base2 of the configured K

getConfigK

public int getConfigK()

Gets the configured K

Returns:

the configured K

getMaxAuxSize

public int getMaxAuxSize()

Gets the maximum auxiliary size

Returns:

the maximum auxiliary size

getFlags

public byte getFlags()

Gets the flags byte

Returns:

the flags byte

getSeedHash

public short getSeedHash()

Gets the seed hash

Returns:

the seed hash

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object