org.apache.datasketches.theta

Class Union

java.lang.Object

org.apache.datasketches.theta.SetOperation

org.apache.datasketches.theta.Union

public abstract class Union
extends SetOperation

The API for Union operations

Author:

Lee Rhodes

Constructor Summary

Constructors

Constructor and Description
Union()

Method Summary

Modifier and Type	Method and Description
Family	getFamily() Gets the Family of this SetOperation
abstract CompactSketch	getResult() Gets the result of this operation as an ordered CompactSketch on the Java heap.
abstract CompactSketch	getResult(boolean dstOrdered, org.apache.datasketches.memory.WritableMemory dstMem) Gets the result of this operation as a CompactSketch of the chosen form.
abstract void	reset() Resets this Union.
abstract byte[]	toByteArray() Returns a byte array image of this Union object
abstract void	update(byte[] data) Present this union with the given byte array.
abstract void	update(char[] data) Present this union with the given char array.
abstract void	update(double datum) Present this union with the given double (or float) datum.
abstract void	update(int[] data) Present this union with the given integer array.
abstract void	update(long datum) Present this union with a long.
abstract void	update(long[] data) Present this union with the given long array.
abstract void	update(org.apache.datasketches.memory.Memory mem) Union the given Memory image of the OpenSource Theta Sketch, which may be ordered or unordered, or the earlier versions of SetSketch, which must be compact and ordered.
abstract void	update(Sketch sketchIn) Union the given on-heap sketch.
abstract void	update(String datum) Present this union with the given String.

Methods inherited from class org.apache.datasketches.theta.SetOperation

builder, getMaxIntersectionBytes, getMaxUnionBytes, heapify, heapify, isSameResource, wrap, wrap, wrap, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

Union

public Union()

Method Detail

getFamily

public Family getFamily()

Description copied from class: SetOperation

Gets the Family of this SetOperation

Specified by:

getFamily in class SetOperation

Returns:

the Family of this SetOperation

getResult

public abstract CompactSketch getResult(boolean dstOrdered,
                                        org.apache.datasketches.memory.WritableMemory dstMem)

Gets the result of this operation as a CompactSketch of the chosen form. This does not disturb the underlying data structure of the union. Therefore, it is OK to continue updating the union after this operation.

Parameters:

dstOrdered - See Destination Ordered

dstMem - See Destination Memory.

Returns:

the result of this operation as a CompactSketch of the chosen form

getResult

public abstract CompactSketch getResult()

Gets the result of this operation as an ordered CompactSketch on the Java heap. This does not disturb the underlying data structure of the union. Therefore, it is OK to continue updating the union after this operation.

Returns:

the result of this operation as an ordered CompactSketch on the Java heap

reset

public abstract void reset()

Resets this Union. The seed remains intact, otherwise reverts back to its virgin state.

toByteArray

public abstract byte[] toByteArray()

Returns a byte array image of this Union object

Returns:

a byte array image of this Union object

update

public abstract void update(Sketch sketchIn)

Union the given on-heap sketch. Valid for the all of the Open Source, Theta Sketches. Not valid for older (prior to Open Source) Theta Sketches. This method can be repeatedly called. If the given sketch is null it is interpreted as an empty sketch.

Parameters:

sketchIn - The incoming sketch.

update

public abstract void update(org.apache.datasketches.memory.Memory mem)

Union the given Memory image of the OpenSource Theta Sketch, which may be ordered or unordered, or the earlier versions of SetSketch, which must be compact and ordered.

This method can be repeatedly called. If the given sketch is null it is interpreted as an empty sketch.

Parameters:

mem - Memory image of sketch to be merged

update

public abstract void update(long datum)

Present this union with a long.

Parameters:

datum - The given long datum.

update

public abstract void update(double datum)

Present this union with the given double (or float) datum. The double will be converted to a long using Double.doubleToLongBits(datum), which normalizes all NaN values to a single NaN representation. Plus and minus zero will be normalized to plus zero. The special floating-point values NaN and +/- Infinity are treated as distinct.

Parameters:

datum - The given double datum.

update

public abstract void update(String datum)

Present this union with the given String. The string is converted to a byte array using UTF8 encoding. If the string is null or empty no update attempt is made and the method returns.

Note: this will not produce the same output hash values as the update(char[]) method and will generally be a little slower depending on the complexity of the UTF8 encoding.

Parameters:

datum - The given String.

update

public abstract void update(byte[] data)

Present this union with the given byte array. If the byte array is null or empty no update attempt is made and the method returns.

Parameters:

data - The given byte array.

update

public abstract void update(int[] data)

Present this union with the given integer array. If the integer array is null or empty no update attempt is made and the method returns.

Parameters:

data - The given int array.

update

public abstract void update(char[] data)

Present this union with the given char array. If the char array is null or empty no update attempt is made and the method returns.

Note: this will not produce the same output hash values as the update(String) method but will be a little faster as it avoids the complexity of the UTF8 encoding.

Parameters:

data - The given char array.

update

public abstract void update(long[] data)

Present this union with the given long array. If the long array is null or empty no update attempt is made and the method returns.

Parameters:

data - The given long array.