com.yahoo.sketches.quantiles

Class DoublesUnion

java.lang.Object

com.yahoo.sketches.quantiles.DoublesUnion

public abstract class DoublesUnion
extends Object

The API for Union operations for quantiles DoublesSketches

Author:

Lee Rhodes

Constructor Summary

Constructors

Constructor and Description
DoublesUnion()

Method Summary

Modifier and Type	Method and Description
static DoublesUnionBuilder	builder() Returns a new UnionBuilder
abstract int	getEffectiveK() Returns the effective k of this Union.
abstract int	getMaxK() Returns the configured maxK of this Union.
abstract DoublesSketch	getResult() Gets the result of this Union operation as a copy of the internal state.
abstract DoublesSketch	getResultAndReset() Gets the result of this Union operation (without a copy) and resets this Union to the virgin state.
abstract boolean	isDirect() Returns true if this union is direct
abstract boolean	isEmpty() Returns true if this union is empty
abstract void	reset() Resets this Union to a virgin state.
abstract String	toString() Returns summary information about the backing sketch.
abstract String	toString(boolean sketchSummary, boolean dataDetail) Returns summary information about the backing sketch.
abstract void	update(double dataItem) Update this union with the given double (or float) data Item.
abstract void	update(DoublesSketch sketchIn) Iterative union operation, which means this method can be repeatedly called.
abstract void	update(Memory mem) Iterative union operation, which means this method can be repeatedly called.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoublesUnion

public DoublesUnion()

Method Detail

builder

public static final DoublesUnionBuilder builder()

Returns a new UnionBuilder

Returns:

a new UnionBuilder

isEmpty

public abstract boolean isEmpty()

Returns true if this union is empty

Returns:

true if this union is empty

isDirect

public abstract boolean isDirect()

Returns true if this union is direct

Returns:

true if this union is direct

getMaxK

public abstract int getMaxK()

Returns the configured maxK of this Union.

Returns:

the configured maxK of this Union.

getEffectiveK

public abstract int getEffectiveK()

Returns the effective k of this Union.

Returns:

the effective k of this Union.

update

public abstract void update(DoublesSketch sketchIn)

Iterative union operation, which means this method can be repeatedly called. Merges the given sketch into this union object. The given sketch is not modified. It is required that the ratio of the two K values be a power of 2. This is easily satisfied if each of the K values is already a power of 2. If the given sketch is null or empty it is ignored.

It is required that the results of the union operation, which can be obtained at any time, is obtained from getResult().

Parameters:

sketchIn - the sketch to be merged into this one.

update

public abstract void update(Memory mem)

Iterative union operation, which means this method can be repeatedly called. Merges the given Memory image of a DoublesSketch into this union object. The given Memory object is not modified and a link to it is not retained. It is required that the ratio of the two K values be a power of 2. This is easily satisfied if each of the K values is already a power of 2. If the given sketch is null or empty it is ignored.

It is required that the results of the union operation, which can be obtained at any time, is obtained from getResult().

Parameters:

mem - Memory image of sketch to be merged

update

public abstract void update(double dataItem)

Update this union with the given double (or float) data Item.

Parameters:

dataItem - The given double datum.

getResult

public abstract DoublesSketch getResult()

Gets the result of this Union operation as a copy of the internal state. This enables further union update operations on this state.

Returns:

the result of this Union operation

getResultAndReset

public abstract DoublesSketch getResultAndReset()

Gets the result of this Union operation (without a copy) and resets this Union to the virgin state.

Returns:

the result of this Union operation and reset.

reset

public abstract void reset()

Resets this Union to a virgin state.

toString

public abstract String toString()

Returns summary information about the backing sketch.

Overrides:

toString in class Object

toString

public abstract String toString(boolean sketchSummary,
                                boolean dataDetail)

Returns summary information about the backing sketch. Used for debugging.

Parameters:

sketchSummary - if true includes sketch summary

dataDetail - if true includes data detail

Returns:

summary information about the sketch.