com.yahoo.sketches.quantiles

Class DoublesUnionBuilder

java.lang.Object

com.yahoo.sketches.quantiles.DoublesUnionBuilder

public class DoublesUnionBuilder
extends Object

For building a new DoublesSketch Union operation.

Author:

Lee Rhodes

Constructor Summary

Constructors

Constructor and Description
DoublesUnionBuilder() Constructor for a new DoublesUnionBuilder.

Method Summary

Modifier and Type	Method and Description
DoublesUnion	build() Returns a new empty Union object with the current configuration of this Builder.
static DoublesUnion	build(DoublesSketch sketch) Deprecated. changed name to heapify(DoublesSketch) to more accuately reflect its intent
static DoublesUnion	build(Memory srcMem) Deprecated. changed name to heapify(Memory) to more accuately reflect its intent
static DoublesUnion	copyBuild(DoublesSketch sketch) Deprecated. this is a duplicate of heapify(DoublesSketch) and no longer needed.
int	getMaxK() Gets the current configured value of maxK
Memory	getMemory() Gets the configured Memory to be initialized by the union for off-heap use.
static DoublesUnion	heapify(DoublesSketch sketch) Returns a Heap Union object that has been initialized with the data from the given sketch.
static DoublesUnion	heapify(Memory srcMem) Returns a Heap Union object that has been initialized with the data from the given memory image of a sketch.
DoublesUnionBuilder	initMemory(Memory mem) Specifies the Memory to be initialized for a new off-heap version of the union.
DoublesUnionBuilder	setK(int maxK) Deprecated. please use setMaxK(int), which more accurately describes its function.
DoublesUnionBuilder	setMaxK(int maxK) Sets the parameter masK that determines the maximum size of the sketch that results from a union and its accuracy.
static DoublesUnion	wrap(Memory mem) Returns a Union object that wraps off-heap data of the given memory image of a sketch.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoublesUnionBuilder

public DoublesUnionBuilder()

Constructor for a new DoublesUnionBuilder. The default configuration is

• k: 128. This produces a normalized rank error of about 1.7%
• Memory: null

Method Detail

setMaxK

public DoublesUnionBuilder setMaxK(int maxK)

Sets the parameter masK that determines the maximum size of the sketch that results from a union and its accuracy.

Parameters:

maxK - determines the accuracy and size of the union and is a maximum value. The effective k can be smaller due to unions with smaller k sketches. It is recommended that maxK be a power of 2 to enable unioning of sketches with different values of k.

Returns:

this builder

setK

@Deprecated
public DoublesUnionBuilder setK(int maxK)

Deprecated. please use setMaxK(int), which more accurately describes its function.

Deprecated in favor of a clearer method naming. Please use setMaxK(int).

Parameters:

maxK - See setMaxK(int).

Returns:

this builder

initMemory

public DoublesUnionBuilder initMemory(Memory mem)

Specifies the Memory to be initialized for a new off-heap version of the union.

Parameters:

mem - the given Memory.

Returns:

this builder

getMaxK

public int getMaxK()

Gets the current configured value of maxK

Returns:

the current configured value of maxK

getMemory

public Memory getMemory()

Gets the configured Memory to be initialized by the union for off-heap use.

Returns:

the configured Memory.

build

public DoublesUnion build()

Returns a new empty Union object with the current configuration of this Builder.

Returns:

a Union object

heapify

public static DoublesUnion heapify(DoublesSketch sketch)

Returns a Heap Union object that has been initialized with the data from the given sketch.

Parameters:

sketch - A DoublesSketch to be used as a source of data only and will not be modified.

Returns:

a DoublesUnion object

heapify

public static DoublesUnion heapify(Memory srcMem)

Returns a Heap Union object that has been initialized with the data from the given memory image of a sketch.

Parameters:

srcMem - A memory image of a DoublesSketch to be used as a source of data, but will not be modified.

Returns:

a Union object

wrap

public static DoublesUnion wrap(Memory mem)

Returns a Union object that wraps off-heap data of the given memory image of a sketch. The data structures of the Union remain off-heap.

Parameters:

mem - A memory region to be used as the data structure for the sketch and will be modified.

Returns:

a Union object

build

@Deprecated
public static DoublesUnion build(DoublesSketch sketch)

Deprecated. changed name to heapify(DoublesSketch) to more accuately reflect its intent

Returns a Heap DoublesUnion object that has been initialized with the data from the given sketch.

Parameters:

sketch - A DoublesSketch to be used as a source of data only and will not be modified.

Returns:

a DoublesUnion object

build

@Deprecated
public static DoublesUnion build(Memory srcMem)

Deprecated. changed name to heapify(Memory) to more accuately reflect its intent

Returns a heap Union object that has been initialized with the data from the given Memory image of a DoublesSketch. A reference to this Memory image is not retained.

Parameters:

srcMem - a Memory image of a DoublesSketch

Returns:

a Union object

copyBuild

@Deprecated
public static DoublesUnion copyBuild(DoublesSketch sketch)

Deprecated. this is a duplicate of heapify(DoublesSketch) and no longer needed.

Returns a Union object that has been initialized with the data from the given sketch.

Parameters:

sketch - A DoublesSketch to be used as a source of data, but will not be modified.

Returns:

a Union object