org.apache.datasketches.tuple

Class Union<S extends Summary>

java.lang.Object

org.apache.datasketches.tuple.Union<S>

Type Parameters:

S - Type of Summary

public class Union<S extends Summary>
extends Object

Compute a union of two or more tuple sketches. A new instance represents an empty set. Every update() computes a union with the internal set and can only grow the internal set.

Constructor Summary

Constructors

Constructor and Description
Union(int nomEntries, SummarySetOperations<S> summarySetOps) Creates new instance
Union(SummarySetOperations<S> summarySetOps) Creates new instance with default nominal entries

Method Summary

Modifier and Type	Method and Description
CompactSketch<S>	getResult() Gets the internal set as a CompactSketch
void	reset() Resets the internal set to the initial state, which represents an empty set
void	update(Sketch<S> sketchIn) Updates the internal set by adding entries from the given sketch

Methods inherited from class java.lang.Object

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

Constructor Detail

Union

public Union(SummarySetOperations<S> summarySetOps)

Creates new instance with default nominal entries

Parameters:

summarySetOps - instance of SummarySetOperations

Union

public Union(int nomEntries,
             SummarySetOperations<S> summarySetOps)

Creates new instance

Parameters:

nomEntries - nominal number of entries. Forced to the nearest power of 2 greater than given value.

summarySetOps - instance of SummarySetOperations

Method Detail

update

public void update(Sketch<S> sketchIn)

Updates the internal set by adding entries from the given sketch

Parameters:

sketchIn - input sketch to add to the internal set

getResult

public CompactSketch<S> getResult()

Gets the internal set as a CompactSketch

Returns:

result of the unions so far

reset

public void reset()

Resets the internal set to the initial state, which represents an empty set