com.yahoo.sketches.theta

Interface AnotB

public interface AnotB

The API for the set difference operation A and not B operations. This is a stateless operation. However, to make the API more consistent with the other set operations the intended use is:

 AnotB aNotB = SetOperationBuilder.buildAnotB();
 aNotB.update(SketchA, SketchB); //Called only once.
 CompactSketch result = aNotB.getResult();
 

Calling the update function a second time essentially clears the internal state and updates with the new pair of sketches.

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
void	update(Sketch a, Sketch b) Perform A-and-not-B set operation on the two given sketches.

Method Detail

update

void update(Sketch a,
            Sketch b)

Perform A-and-not-B set operation on the two given sketches. A null sketch is interpreted as an empty sketch.

Parameters:

a - The incoming sketch for the first argument

b - The incoming sketch for the second argument

getResult

CompactSketch getResult(boolean dstOrdered,
                        Memory dstMem)

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

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

Returns:

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