Uses of Interface
org.apache.datasketches.tuple.Summary

Packages that use Summary

Package	Description
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 Summary in org.apache.datasketches.thetacommon

Methods in org.apache.datasketches.thetacommon with type parameters of type Summary

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 Summary in org.apache.datasketches.tuple

Classes in org.apache.datasketches.tuple with type parameters of type Summary

Modifier and Type	Class	Description
class	AnotB<S extends Summary>	Computes a set difference, A-AND-NOT-B, of two generic tuple sketches.
class	CompactSketch<S extends Summary>	CompactSketches are never created directly.
class	Filter<T extends Summary>	Class for filtering entries from a Sketch given a Summary
class	Intersection<S extends Summary>	Computes an intersection of two or more generic tuple sketches or generic tuple sketches combined with theta sketches.
class	Sketch<S extends Summary>	This is an equivalent to org.apache.datasketches.theta.Sketch with addition of a user-defined Summary object associated with every unique entry in the sketch.
interface	SummaryDeserializer<S extends Summary>	Interface for deserializing user-defined Summary
interface	SummaryFactory<S extends Summary>	Interface for user-defined SummaryFactory
interface	SummarySetOperations<S extends Summary>	This is to provide methods of producing unions and intersections of two Summary objects.
class	TupleSketchIterator<S extends Summary>	Iterator over a generic tuple sketch
class	Union<S extends Summary>	Compute the union of two or more generic tuple sketches or generic tuple sketches combined with theta sketches.

Subinterfaces of Summary in org.apache.datasketches.tuple

Modifier and Type	Interface	Description
interface	UpdatableSummary<U>	Interface for updating user-defined Summary

Methods in org.apache.datasketches.tuple with type parameters of type Summary

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> S[]	Util.copySummaryArray(S[] summaryArr)	Will copy compact summary arrays as well as hashed summary tables (with nulls).
static <S extends Summary> Sketch<S>	Sketches.createEmptySketch()
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.
static <S extends Summary> Sketch<S>	Sketches.heapifySketch(org.apache.datasketches.memory.Memory mem, SummaryDeserializer<S> deserializer)	Instantiate a Sketch from a given Memory.
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.
static <S extends Summary> S[]	Util.newSummaryArray(S[] summaryArr, int length)	Creates a new Summary Array with the specified length
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.

Methods in org.apache.datasketches.tuple that return Summary

Modifier and Type	Method	Description
Summary	Summary.copy()	Deep copy.
static <S extends Summary> S[]	Util.copySummaryArray(S[] summaryArr)	Will copy compact summary arrays as well as hashed summary tables (with nulls).
static <S extends Summary> S[]	Util.newSummaryArray(S[] summaryArr, int length)	Creates a new Summary Array with the specified length

Methods in org.apache.datasketches.tuple with parameters of type Summary

Modifier and Type	Method	Description
static <S extends Summary> S[]	Util.copySummaryArray(S[] summaryArr)	Will copy compact summary arrays as well as hashed summary tables (with nulls).
static <S extends Summary> S[]	Util.newSummaryArray(S[] summaryArr, int length)	Creates a new Summary Array with the specified length

Uses of Summary in org.apache.datasketches.tuple.adouble

Classes in org.apache.datasketches.tuple.adouble that implement Summary

Modifier and Type	Class	Description
class	DoubleSummary	Summary for generic tuple sketches of type Double.

Uses of Summary in org.apache.datasketches.tuple.aninteger

Classes in org.apache.datasketches.tuple.aninteger that implement Summary

Modifier and Type	Class	Description
class	IntegerSummary	Summary for generic tuple sketches of type Integer.

Uses of Summary in org.apache.datasketches.tuple.strings

Classes in org.apache.datasketches.tuple.strings that implement Summary

Modifier and Type	Class	Description
class	ArrayOfStringsSummary