com.yahoo.sketches.hll

Class HllSketchBuilder

java.lang.Object

com.yahoo.sketches.hll.HllSketchBuilder

public class HllSketchBuilder
extends Object

Author:

Kevin Lang

Constructor Summary

Constructors

Constructor and Description
HllSketchBuilder() Default constructor using default nominal entries (4096).

Method Summary

Modifier and Type	Method and Description
HllSketch	build() Build a new HllSketch
HllSketchBuilder	copy() Copy constructor
int	getLogBuckets() Gets the currently configured log_base2 of the number of buckets (k)
Preamble	getPreamble() Gets the configured Preamble
boolean	isCompressedDense() Gets the state of Compressed Dense
boolean	isDenseMode() Gets the Dense Mode flag
boolean	isHipEstimator() Gets the state of the Hip Estimator option
HllSketchBuilder	setCompressedDense(boolean compressedDense) Sets the Compressed Dense flag
HllSketchBuilder	setDenseMode(boolean denseMode) Sets the Dense Mode flag
HllSketchBuilder	setHipEstimator(boolean hipEstimator) Sets the Hip Estimator option
HllSketchBuilder	setLogBuckets(int logBuckets) Sets the number of buckets (k) from the log_base2 of the desired value.
HllSketchBuilder	setPreamble(Preamble preamble) Sets the Preamble
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HllSketchBuilder

public HllSketchBuilder()

Default constructor using default nominal entries (4096).

Method Detail

copy

public HllSketchBuilder copy()

Copy constructor

Returns:

a copy of this sketch

setLogBuckets

public HllSketchBuilder setLogBuckets(int logBuckets)

Sets the number of buckets (k) from the log_base2 of the desired value.

Parameters:

logBuckets - the given log_base2 of the desired number of buckets

Returns:

this Builder

getLogBuckets

public int getLogBuckets()

Gets the currently configured log_base2 of the number of buckets (k)

Returns:

the currently configured log_base2 of the number of buckets (k)

setPreamble

public HllSketchBuilder setPreamble(Preamble preamble)

Sets the Preamble

Parameters:

preamble - the given Preamble

Returns:

this builder

getPreamble

public Preamble getPreamble()

Gets the configured Preamble

Returns:

the configured Preamble

setDenseMode

public HllSketchBuilder setDenseMode(boolean denseMode)

Sets the Dense Mode flag

Parameters:

denseMode - the state of dense mode

Returns:

this builder

isDenseMode

public boolean isDenseMode()

Gets the Dense Mode flag

Returns:

the Dense Mode flag

setCompressedDense

public HllSketchBuilder setCompressedDense(boolean compressedDense)

Sets the Compressed Dense flag

Parameters:

compressedDense - the state of Compressed Dense

Returns:

this builder

isCompressedDense

public boolean isCompressedDense()

Gets the state of Compressed Dense

Returns:

the state of Compressed Dense

setHipEstimator

public HllSketchBuilder setHipEstimator(boolean hipEstimator)

Sets the Hip Estimator option

Parameters:

hipEstimator - true if the Hip Estimater option is to be used

Returns:

this builder

isHipEstimator

public boolean isHipEstimator()

Gets the state of the Hip Estimator option

Returns:

the state of the Hip Estimator option

build

public HllSketch build()

Build a new HllSketch

Returns:

a new HllSketch

toString

public String toString()

Overrides:

toString in class Object