# Package org.apache.datasketches.tuple

package 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.

Related Packages
Package
Description
org.apache.datasketches
This package is the parent package for all sketch families and common code areas.
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.arrayofdoubles
This package is for a concrete implementation of the Tuple sketch for an array of double values.
org.apache.datasketches.tuple.strings
This package is for a generic implementation of the Tuple sketch for single String value.
Class
Description
CompactTupleSketch<S extends Summary>
CompactTupleSketches are never created directly.
DeserializeResult<T>
Returns an object and its size in bytes as a result of a deserialize operation
Filter<T extends Summary>
Class for filtering entries from a `TupleSketch` given a `Summary`
JaccardSimilarity
Jaccard similarity of two TupleSketches, or alternatively, of a TupleSketch and a ThetaSketch.
SerializerDeserializer
Multipurpose serializer-deserializer for a collection of sketches defined by the enum.
SerializerDeserializer.SketchType
Defines the sketch classes that this SerializerDeserializer can handle.
Summary
Interface for user-defined Summary, which is associated with every hash in a tuple sketch
SummaryDeserializer<S extends Summary>
Interface for deserializing user-defined Summary
SummaryFactory<S extends Summary>
Interface for user-defined SummaryFactory
SummarySetOperations<S extends Summary>
This is to provide methods of producing unions and intersections of two Summary objects.
TupleAnotB<S extends Summary>
Computes a set difference, A-AND-NOT-B, of two generic TupleSketches.
TupleIntersection<S extends Summary>
Computes an intersection of two or more generic TupleSketches or generic TupleSketches combined with ThetaSketches.
TupleSketch<S extends Summary>
The top-level class for all Tuple sketches.
TupleSketchIterator<S extends Summary>
Iterator over a generic tuple sketch
TupleUnion<S extends Summary>
Compute the union of two or more generic tuple sketches or generic TupleSketches combined with ThetaSketches.
UpdatableSummary<U>
Interface for updating user-defined Summary
UpdatableTupleSketch<U, S extends UpdatableSummary<U>>
An extension of QuickSelectSketch<S>, which can be updated with many types of keys.
UpdatableTupleSketchBuilder<U, S extends UpdatableSummary<U>>
For building a new generic tuple UpdatableTupleSketch
Util
Common utility functions for Tuples