org.apache.datasketches.theta

Class AnotB

java.lang.Object

org.apache.datasketches.theta.SetOperation

org.apache.datasketches.theta.AnotB

public abstract class AnotB
extends SetOperation

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.

As an alternative, one can use the aNotB method that returns the result immediately.

Author:

Lee Rhodes

Constructor Summary

Constructors

Constructor and Description
AnotB()

Method Summary

Modifier and Type	Method and Description
CompactSketch	aNotB(Sketch a, Sketch b) Perform A-and-not-B set operation on the two given sketches and return the result as an ordered CompactSketch on the heap.
abstract CompactSketch	aNotB(Sketch a, Sketch b, boolean dstOrdered, org.apache.datasketches.memory.WritableMemory dstMem) Perform A-and-not-B set operation on the two given sketches and return the result as a CompactSketch.
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 set operation as a CompactSketch of the chosen form
abstract void	update(Sketch a, Sketch b) Perform A-and-not-B set operation on the two given sketches.

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

AnotB

public AnotB()

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()

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

getResult

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

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

Parameters:

dstOrdered - See Destination Ordered.

dstMem - See Destination Memory.

Returns:

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

update

public abstract 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

aNotB

public CompactSketch aNotB(Sketch a,
                           Sketch b)

Perform A-and-not-B set operation on the two given sketches and return the result as an ordered CompactSketch on the heap.

Parameters:

a - The incoming sketch for the first argument

b - The incoming sketch for the second argument

Returns:

an ordered CompactSketch on the heap

aNotB

public abstract CompactSketch aNotB(Sketch a,
                                    Sketch b,
                                    boolean dstOrdered,
                                    org.apache.datasketches.memory.WritableMemory dstMem)

Perform A-and-not-B set operation on the two given sketches and return the result as a CompactSketch.

Parameters:

a - The incoming sketch for the first argument

b - The incoming sketch for the second argument

dstOrdered - See Destination Ordered.

dstMem - See Destination Memory.

Returns:

the result as a CompactSketch.