com.yahoo.sketches.theta

Class SetOperationBuilder

java.lang.Object

com.yahoo.sketches.theta.SetOperationBuilder

public class SetOperationBuilder
extends Object

For building a new SetOperation.

Author:

Lee Rhodes

Constructor Summary

Constructors

Constructor and Description
SetOperationBuilder() Constructor for building a new SetOperation.

Method Summary

Modifier and Type	Method and Description
SetOperation	build(Family family) Returns a SetOperation with the current configuration of this Builder and the given Family.
SetOperation	build(int nomEntries, Family family) Returns a SetOperation with the current configuration of this Builder and the given Nominal Entries and Family.
AnotB	buildANotB() Convenience method, returns a configured SetOperation ANotB with Default Nominal Entries
Intersection	buildIntersection() Convenience method, returns a configured SetOperation Intersection with Default Nominal Entries
Union	buildUnion() Convenience method, returns a configured SetOperation Union with Default Nominal Entries
Union	buildUnion(int nomEntries) Convenience method, returns a configured SetOperation Union with the given Nominal Entries.
int	getLgNominalEntries() Returns Log-base 2 Nominal Entries
Memory	getMemory() Returns the Destination Memory See Destination Memory.
float	getP() Returns the pre-sampling probability p
ResizeFactor	getResizeFactor() Returns the Resize Factor
long	getSeed() Returns the seed
SetOperationBuilder	initMemory(Memory dstMem) Initializes the backing Memory store.
SetOperationBuilder	setNominalEntries(int nomEntries) Sets the Nominal Entries for this set operation.
SetOperationBuilder	setP(float p) Sets the upfront uniform sampling probability, p.
SetOperationBuilder	setResizeFactor(ResizeFactor rf) Sets the cache Resize Factor
SetOperationBuilder	setSeed(long seed) Sets the long seed value that is require by the hashing function.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SetOperationBuilder

public SetOperationBuilder()

Constructor for building a new SetOperation. The default configuration is

• Nominal Entries: 4096
• Seed: 9001L
• ResizeFactor.X8
• Input Sampling Probability: 1.0
• Memory: null

Method Detail

setNominalEntries

public SetOperationBuilder setNominalEntries(int nomEntries)

Sets the Nominal Entries for this set operation. The minimum value is 16 and the maximum value is 67,108,864, which is 2^26. Be aware that Unions as large as this maximum value have not been thoroughly tested or characterized for performance.

Parameters:

nomEntries - Nominal Entres This will become the ceiling power of 2 if it is not.

Returns:

this SetOperationBuilder

getLgNominalEntries

public int getLgNominalEntries()

Returns Log-base 2 Nominal Entries

Returns:

Log-base 2 Nominal Entries

setSeed

public SetOperationBuilder setSeed(long seed)

Sets the long seed value that is require by the hashing function.

Parameters:

seed - See seed

Returns:

this SetOperationBuilder

getSeed

public long getSeed()

Returns the seed

Returns:

the seed

setP

public SetOperationBuilder setP(float p)

Sets the upfront uniform sampling probability, p. Although this functionality is implemented for Unions only, it rarely makes sense to use it. The proper use of upfront sampling is when building the sketches.

Parameters:

p - See Sampling Probability, p

Returns:

this SetOperationBuilder

getP

public float getP()

Returns the pre-sampling probability p

Returns:

the pre-sampling probability p

setResizeFactor

public SetOperationBuilder setResizeFactor(ResizeFactor rf)

Sets the cache Resize Factor

Parameters:

rf - See Resize Factor

Returns:

this SetOperationBuilder

getResizeFactor

public ResizeFactor getResizeFactor()

Returns the Resize Factor

Returns:

the Resize Factor

initMemory

public SetOperationBuilder initMemory(Memory dstMem)

Initializes the backing Memory store.

Parameters:

dstMem - The destination Memory. See Destination Memory

Returns:

this SetOperationBuilder

getMemory

public Memory getMemory()

Returns the Destination Memory See Destination Memory.

Returns:

the Destination Memory

build

public SetOperation build(Family family)

Returns a SetOperation with the current configuration of this Builder and the given Family.

Parameters:

family - the chosen SetOperation family

Returns:

a SetOperation

build

public SetOperation build(int nomEntries,
                          Family family)

Returns a SetOperation with the current configuration of this Builder and the given Nominal Entries and Family.

Parameters:

nomEntries - Nominal Entres This will become the ceiling power of 2 if it is not.

family - build this SetOperation family

Returns:

a SetOperation

buildUnion

public Union buildUnion()

Convenience method, returns a configured SetOperation Union with Default Nominal Entries

Returns:

a Union object

buildUnion

public Union buildUnion(int nomEntries)

Convenience method, returns a configured SetOperation Union with the given Nominal Entries.

Parameters:

nomEntries - Nominal Entres

Returns:

a Union object

buildIntersection

public Intersection buildIntersection()

Convenience method, returns a configured SetOperation Intersection with Default Nominal Entries

Returns:

an Intersection object

buildANotB

public AnotB buildANotB()

Convenience method, returns a configured SetOperation ANotB with Default Nominal Entries

Returns:

an ANotB object

toString

public String toString()

Overrides:

toString in class Object