Package org.apache.datasketches

This package is the parent package for all sketch algorithms. Classes at this level are used by more than one sub-package.
Author:
Lee Rhodes
  • Class Summary 
    Class Description
    ArrayOfBooleansSerDe
    Methods of serializing and deserializing arrays of Boolean as a bit array.
    ArrayOfDoublesSerDe
    Methods of serializing and deserializing arrays of Double.
    ArrayOfItemsSerDe<T>
    Base class for serializing and deserializing custom types.
    ArrayOfLongsSerDe
    Methods of serializing and deserializing arrays of Long.
    ArrayOfNumbersSerDe
    Methods of serializing and deserializing arrays of the object version of primitive types of Number.
    ArrayOfStringsSerDe
    Methods of serializing and deserializing arrays of String.
    ArrayOfUtf16StringsSerDe
    Methods of serializing and deserializing arrays of String.
    BinarySearch
    Contains common equality binary search algorithms.
    BinomialBoundsN
    This class enables the estimation of error bounds given a sample set size, the sampling probability theta, the number of standard deviations and a simple noDataSeen flag.
    BoundsOnBinomialProportions
    Confidence intervals for binomial proportions.
    BoundsOnRatiosInSampledSets
    This class is used to compute the bounds on the estimate of the ratio |B| / |A|, where: |A| is the unknown size of a set A of unique identifiers. |B| is the unknown size of a subset B of A. a = |SA| is the observed size of a sample of A that was obtained by Bernoulli sampling with a known inclusion probability f. b = |SA ∩ B| is the observed size of a subset of SA.
    BoundsOnRatiosInThetaSketchedSets
    This class is used to compute the bounds on the estimate of the ratio B / A, where: A is a Theta Sketch of population PopA. B is a Theta Sketch of population PopB that is a subset of A, obtained by an intersection of A with some other Theta Sketch C, which acts like a predicate or selection clause. The estimate of the ratio PopB/PopA is BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(A, B). The Upper Bound estimate on the ratio PopB/PopA is BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(A, B). The Lower Bound estimate on the ratio PopB/PopA is BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(A, B). Note: The theta of A cannot be greater than the theta of B.
    BoundsOnRatiosInTupleSketchedSets
    This class is used to compute the bounds on the estimate of the ratio B / A, where: A is a Tuple Sketch of population PopA. B is a Tuple or Theta Sketch of population PopB that is a subset of A, obtained by an intersection of A with some other Tuple or Theta Sketch C, which acts like a predicate or selection clause. The estimate of the ratio PopB/PopA is BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(A, B). The Upper Bound estimate on the ratio PopB/PopA is BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(A, B). The Lower Bound estimate on the ratio PopB/PopA is BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(A, B). Note: The theta of A cannot be greater than the theta of B.
    ByteArrayUtil
    Useful methods for byte arrays.
    GenericInequalitySearch
    This provides efficient, unique and unambiguous binary searching for inequalities for ordered arrays of values that may include duplicate values.
    HashOperations
    Helper class for the common hash table methods.
    QuantilesHelper
    Common static methods for quantiles sketches
    QuickSelect
    QuickSelect algorithm improved from Sedgewick.
    Util
    Common utility functions.
  • Enum Summary 
    Enum Description
    Family
    Defines the various families of sketch and set operation classes.
    GenericInequalitySearch.Inequality
    The enumerator of inequalities
    InequalitySearch
    This provides efficient, unique and unambiguous binary searching for inequality comparison criteria for ordered arrays of values that may include duplicate values.
    ResizeFactor
    For the Families that accept this configuration parameter, it controls the size multiple that affects how fast the internal cache grows, when more space is required.
  • Exception Summary 
    Exception Description
    SketchesArgumentException
    Illegal Arguments Exception class for the library
    SketchesException
    Exception class for the library
    SketchesReadOnlyException
    Write operation attempted on a read-only class.
    SketchesStateException
    Illegal State Exception class for the library