com.yahoo.sketches.theta

Interface Intersection

public interface Intersection

The API for intersection operations

Author:

Lee Rhodes

Method Summary

Modifier and Type	Method and Description
CompactSketch	getResult() Gets the result of this operation as an ordered CompactSketch on the Java heap.
CompactSketch	getResult(boolean dstOrdered, Memory dstMem) Gets the result of this operation as a CompactSketch of the chosen form.
boolean	hasResult() Returns true if there is an intersection result available
void	reset() Resets this Intersection.
byte[]	toByteArray() Serialize this intersection to a byte array form.
void	update(Sketch sketchIn) Intersect the given sketch with the internal state.

Method Detail

update

void update(Sketch sketchIn)

Intersect the given sketch with the internal state. This method can be repeatedly called. If the given sketch is null the internal state becomes the empty sketch. Theta will become the minimum of thetas seen so far.

Parameters:

sketchIn - the given sketch

getResult

CompactSketch getResult(boolean dstOrdered,
                        Memory dstMem)

Gets the result of this operation as a CompactSketch of the chosen form. The update method must have been called at least once, otherwise an exception will be thrown. This is because a virgin Intersection object represents the Universal Set, which would have an infinite number of values.

Parameters:

dstOrdered - See Destination Ordered

dstMem - See Destination Memory.

Returns:

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

getResult

CompactSketch getResult()

Gets the result of this operation as an ordered CompactSketch on the Java heap. The update method must have been called at least once.

Returns:

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

hasResult

boolean hasResult()

Returns true if there is an intersection result available

Returns:

true if there is an intersection result available

toByteArray

byte[] toByteArray()

Serialize this intersection to a byte array form.

Returns:

byte array of this intersection

reset

void reset()

Resets this Intersection. The seed remains intact, otherwise reverts to the Universal Set, theta of 1.0 and empty = false.