# Uses of Class
org.apache.datasketches.tuple.Sketch

Packages that use Sketch
Package
Description
org.apache.datasketches.fdt
Frequent Distinct Tuples Sketch
org.apache.datasketches.thetacommon
This package contains common tools and methods for the theta, tuple, tuple/* and fdt packages.
org.apache.datasketches.tuple
The tuple package contains a number of sketches based on the same fundamental algorithms of the Theta Sketch Framework and extend these concepts for whole new families of sketches.
org.apache.datasketches.tuple.adouble
This package is for a generic implementation of the Tuple sketch for single Double value.
org.apache.datasketches.tuple.aninteger
This package is for a generic implementation of the Tuple sketch for single Integer value.
org.apache.datasketches.tuple.strings
This package is for a generic implementation of the Tuple sketch for single String value.

## Uses of Sketch in org.apache.datasketches.fdt

Subclasses of Sketch in org.apache.datasketches.fdt
Modifier and Type
Class
Description
`final class`
`FdtSketch`
A Frequent Distinct Tuples sketch.

## Uses of Sketch in org.apache.datasketches.thetacommon

Methods in org.apache.datasketches.thetacommon with parameters of type Sketch
Modifier and Type
Method
Description
`static <S extends Summary>
double`
BoundsOnRatiosInTupleSketchedSets.`getEstimateOfBoverA(Sketch<S> sketchA, Sketch sketchB)`
Gets the estimate for B over A
`static <S extends Summary>
double`
BoundsOnRatiosInTupleSketchedSets.`getEstimateOfBoverA(Sketch<S> sketchA, Sketch<S> sketchB)`
Gets the estimate for B over A
`static <S extends Summary>
double`
BoundsOnRatiosInTupleSketchedSets.`getLowerBoundForBoverA(Sketch<S> sketchA, Sketch sketchB)`
Gets the approximate lower bound for B over A based on a 95% confidence interval
`static <S extends Summary>
double`
BoundsOnRatiosInTupleSketchedSets.`getLowerBoundForBoverA(Sketch<S> sketchA, Sketch<S> sketchB)`
Gets the approximate lower bound for B over A based on a 95% confidence interval
`static <S extends Summary>
double`
BoundsOnRatiosInTupleSketchedSets.`getUpperBoundForBoverA(Sketch<S> sketchA, Sketch sketchB)`
Gets the approximate upper bound for B over A based on a 95% confidence interval
`static <S extends Summary>
double`
BoundsOnRatiosInTupleSketchedSets.`getUpperBoundForBoverA(Sketch<S> sketchA, Sketch<S> sketchB)`
Gets the approximate upper bound for B over A based on a 95% confidence interval

## Uses of Sketch in org.apache.datasketches.tuple

Subclasses of Sketch in org.apache.datasketches.tuple
Modifier and Type
Class
Description
`final class`
`CompactSketch<S extends Summary>`
CompactSketches are never created directly.
`class`
`UpdatableSketch<U,S extends UpdatableSummary<U>>`
An extension of QuickSelectSketch<S>, which can be updated with many types of keys.
Methods in org.apache.datasketches.tuple that return Sketch
Modifier and Type
Method
Description
`static <S extends Summary>
Sketch<S>`
Sketches.`createEmptySketch()`
Creates an empty sketch.
`static <S extends Summary>
Sketch<S>`
Sketches.`heapifySketch(org.apache.datasketches.memory.Memory mem, SummaryDeserializer<S> deserializer)`
Instantiate a Sketch from a given Memory.
Methods in org.apache.datasketches.tuple with parameters of type Sketch
Modifier and Type
Method
Description
`static <S extends Summary>
CompactSketch<S>`
AnotB.`aNotB(Sketch<S> skA, Sketch skB)`
Returns the A-and-not-B set operation on a Tuple sketch and a Theta sketch.
`static <S extends Summary>
CompactSketch<S>`
AnotB.`aNotB(Sketch<S> skA, Sketch<S> skB)`
Returns the A-and-not-B set operation on the two given Tuple sketches.
`static <S extends Summary>
boolean`
JaccardSimilarity.`dissimilarityTest(Sketch<S> measured, Sketch expected, S summary, SummarySetOperations<S> summarySetOps, double threshold)`
Tests dissimilarity of a measured Sketch against an expected Sketch.
`static <S extends Summary>
boolean`
JaccardSimilarity.`dissimilarityTest(Sketch<S> measured, Sketch<S> expected, SummarySetOperations<S> summarySetOps, double threshold)`
Tests dissimilarity of a measured Sketch against an expected Sketch.
`static <S extends Summary>
boolean`
JaccardSimilarity.`exactlyEqual(Sketch<S> sketchA, Sketch sketchB, S summary, SummarySetOperations<S> summarySetOps)`
Returns true if the two given sketches have exactly the same hash values and the same theta values.
`static <S extends Summary>
boolean`
JaccardSimilarity.`exactlyEqual(Sketch<S> sketchA, Sketch<S> sketchB, SummarySetOperations<S> summarySetOps)`
Returns true if the two given sketches have exactly the same hash values and the same theta values.
`CompactSketch<T>`
Filter.`filter(Sketch<T> sketchIn)`
Filters elements on the provided `Sketch`
`void`
Intersection.`intersect(Sketch<S> tupleSketch)`
Performs a stateful intersection of the internal set with the given tupleSketch.
`CompactSketch<S>`
Intersection.`intersect(Sketch<S> tupleSketch, Sketch thetaSketch, S summary)`
Perform a stateless intersect set operation on a tuple sketch and a theta sketch and returns the result as an unordered CompactSketch on the heap.
`CompactSketch<S>`
Intersection.`intersect(Sketch<S> tupleSketchA, Sketch<S> tupleSketchB)`
Perform a stateless intersect set operation on the two given tuple sketches and returns the result as an unordered CompactSketch on the heap.
`static <S extends Summary>
double[]`
JaccardSimilarity.`jaccard(Sketch<S> sketchA, Sketch sketchB, S summary, SummarySetOperations<S> summarySetOps)`
Computes the Jaccard similarity index with upper and lower bounds.
`static <S extends Summary>
double[]`
JaccardSimilarity.`jaccard(Sketch<S> sketchA, Sketch<S> sketchB, SummarySetOperations<S> summarySetOps)`
Computes the Jaccard similarity index with upper and lower bounds.
`void`
AnotB.`notB(Sketch<S> skB)`
This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the second (or n+1th) argument B of A-AND-NOT-B.
`void`
AnotB.`setA(Sketch<S> skA)`
This is part of a multistep, stateful AnotB operation and sets the given Tuple sketch as the first argument A of A-AND-NOT-B.
`static <S extends Summary>
boolean`
JaccardSimilarity.`similarityTest(Sketch<S> measured, Sketch expected, S summary, SummarySetOperations<S> summarySetOps, double threshold)`
Tests similarity of a measured Sketch against an expected Sketch.
`static <S extends Summary>
boolean`
JaccardSimilarity.`similarityTest(Sketch<S> measured, Sketch<S> expected, SummarySetOperations<S> summarySetOps, double threshold)`
Tests similarity of a measured Sketch against an expected Sketch.
`void`
Union.`union(Sketch<S> tupleSketch)`
Performs a stateful union of the internal set with the given tupleSketch.
`CompactSketch<S>`
Union.`union(Sketch<S> tupleSketch, Sketch thetaSketch, S summary)`
Perform a stateless, pair-wise union operation between a tupleSketch and a thetaSketch.
`CompactSketch<S>`
Union.`union(Sketch<S> tupleSketchA, Sketch<S> tupleSketchB)`
Perform a stateless, pair-wise union operation between two tuple sketches.

## Uses of Sketch in org.apache.datasketches.tuple.adouble

Subclasses of Sketch in org.apache.datasketches.tuple.adouble
Modifier and Type
Class
Description
`class`
`DoubleSketch`
Extends UpdatableSketch<Double, DoubleSummary>

## Uses of Sketch in org.apache.datasketches.tuple.aninteger

Subclasses of Sketch in org.apache.datasketches.tuple.aninteger
Modifier and Type
Class
Description
`class`
`IntegerSketch`
Extends UpdatableSketch<Integer, IntegerSummary>

## Uses of Sketch in org.apache.datasketches.tuple.strings

Subclasses of Sketch in org.apache.datasketches.tuple.strings
Modifier and Type
Class
Description
`class`
`ArrayOfStringsSketch`
Extends UpdatableSketch<String[], ArrayOfStringsSummary>