public final class Sketches extends Object
| Modifier and Type | Method and Description |
|---|---|
static int |
getCompactSketchMaxBytes(int lgNomEntries)
Returns the maximum number of storage bytes required for a CompactSketch given the configured
log_base2 of the number of nominal entries, which is a power of 2.
|
static double |
getEstimate(org.apache.datasketches.memory.Memory srcMem)
Gets the unique count estimate from a valid memory image of a Sketch
|
static double |
getLowerBound(int numStdDev,
org.apache.datasketches.memory.Memory srcMem)
Gets the approximate lower error bound from a valid memory image of a Sketch
given the specified number of Standard Deviations.
|
static int |
getMaxAnotBResultBytes(int maxNomEntries)
|
static int |
getMaxCompactSketchBytes(int numberOfEntries)
Returns the maximum number of storage bytes required for a CompactSketch with the given
number of actual entries.
|
static int |
getMaxIntersectionBytes(int nomEntries)
|
static int |
getMaxUnionBytes(int nomEntries)
|
static int |
getMaxUpdateSketchBytes(int nomEntries)
|
static int |
getSerializationVersion(org.apache.datasketches.memory.Memory srcMem)
|
static double |
getUpperBound(int numStdDev,
org.apache.datasketches.memory.Memory srcMem)
Gets the approximate upper error bound from a valid memory image of a Sketch
given the specified number of Standard Deviations.
|
static CompactSketch |
heapifyCompactSketch(org.apache.datasketches.memory.Memory srcMem)
|
static CompactSketch |
heapifyCompactSketch(org.apache.datasketches.memory.Memory srcMem,
long expectedSeed)
|
static SetOperation |
heapifySetOperation(org.apache.datasketches.memory.Memory srcMem)
|
static SetOperation |
heapifySetOperation(org.apache.datasketches.memory.Memory srcMem,
long expectedSeed)
|
static Sketch |
heapifySketch(org.apache.datasketches.memory.Memory srcMem)
|
static Sketch |
heapifySketch(org.apache.datasketches.memory.Memory srcMem,
long expectedSeed)
|
static UpdateSketch |
heapifyUpdateSketch(org.apache.datasketches.memory.Memory srcMem)
|
static UpdateSketch |
heapifyUpdateSketch(org.apache.datasketches.memory.Memory srcMem,
long expectedSeed)
|
static SetOperationBuilder |
setOperationBuilder()
Ref:
SetOperationBuilder |
static UpdateSketchBuilder |
updateSketchBuilder()
Ref:
UpdateSketchBuilder |
static CompactSketch |
wrapCompactSketch(org.apache.datasketches.memory.Memory srcMem)
|
static CompactSketch |
wrapCompactSketch(org.apache.datasketches.memory.Memory srcMem,
long expectedSeed)
|
static Intersection |
wrapIntersection(org.apache.datasketches.memory.Memory srcMem)
Convenience method, calls
SetOperation.wrap(Memory) and casts the result to a Intersection |
static Intersection |
wrapIntersection(org.apache.datasketches.memory.WritableMemory srcMem)
Convenience method, calls
SetOperation.wrap(Memory) and casts the result to a Intersection |
static SetOperation |
wrapSetOperation(org.apache.datasketches.memory.Memory srcMem)
|
static SetOperation |
wrapSetOperation(org.apache.datasketches.memory.Memory srcMem,
long expectedSeed)
|
static SetOperation |
wrapSetOperation(org.apache.datasketches.memory.WritableMemory srcMem)
|
static SetOperation |
wrapSetOperation(org.apache.datasketches.memory.WritableMemory srcMem,
long expectedSeed)
|
static Sketch |
wrapSketch(org.apache.datasketches.memory.Memory srcMem)
Ref:
Sketch.wrap(Memory) |
static Sketch |
wrapSketch(org.apache.datasketches.memory.Memory srcMem,
long expectedSeed)
|
static Union |
wrapUnion(org.apache.datasketches.memory.Memory srcMem)
Convenience method, calls
SetOperation.wrap(Memory) and casts the result to a Union |
static Union |
wrapUnion(org.apache.datasketches.memory.WritableMemory srcMem)
Convenience method, calls
SetOperation.wrap(Memory) and casts the result to a Union |
static UpdateSketch |
wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory srcMem)
|
static UpdateSketch |
wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory srcMem,
long expectedSeed)
|
public static double getEstimate(org.apache.datasketches.memory.Memory srcMem)
srcMem - See Memorypublic static double getLowerBound(int numStdDev,
org.apache.datasketches.memory.Memory srcMem)
numStdDev - See Number of Standard DeviationssrcMem - See Memorypublic static int getMaxAnotBResultBytes(int maxNomEntries)
SetOperation.getMaxAnotBResultBytes(int).
Returns the maximum number of bytes for the returned CompactSketch, given the maximum
value of nomEntries of the first sketch A of AnotB.maxNomEntries - the given valuepublic static int getMaxCompactSketchBytes(int numberOfEntries)
numberOfEntries - the actual number of retained entries stored in the sketch.public static int getCompactSketchMaxBytes(int lgNomEntries)
lgNomEntries - Nominal EntriesSketch.getCompactSketchMaxBytes(int)public static int getMaxIntersectionBytes(int nomEntries)
nomEntries - Ref: SetOperation.getMaxIntersectionBytes(int), nomEntriesSetOperation.getMaxIntersectionBytes(int)public static int getMaxUnionBytes(int nomEntries)
nomEntries - Ref: SetOperation.getMaxUnionBytes(int), nomEntriesSetOperation.getMaxUnionBytes(int)public static int getMaxUpdateSketchBytes(int nomEntries)
nomEntries - Ref: Sketch.getMaxUpdateSketchBytes(int), nomEntriesSketch.getMaxUpdateSketchBytes(int)public static int getSerializationVersion(org.apache.datasketches.memory.Memory srcMem)
srcMem - Ref: Sketch.getSerializationVersion(Memory), srcMemSketch.getSerializationVersion(Memory)public static double getUpperBound(int numStdDev,
org.apache.datasketches.memory.Memory srcMem)
numStdDev - See Number of Standard DeviationssrcMem - See Memorypublic static CompactSketch heapifyCompactSketch(org.apache.datasketches.memory.Memory srcMem)
srcMem - Ref: CompactSketch.heapify(Memory), srcMemCompactSketchpublic static CompactSketch heapifyCompactSketch(org.apache.datasketches.memory.Memory srcMem, long expectedSeed)
srcMem - Ref: CompactSketch.heapify(Memory, long), srcMemexpectedSeed - Ref: CompactSketch.heapify(Memory, long),
expectedSeedCompactSketchpublic static CompactSketch wrapCompactSketch(org.apache.datasketches.memory.Memory srcMem)
srcMem - Ref: CompactSketch.wrap(Memory), srcMemCompactSketchpublic static CompactSketch wrapCompactSketch(org.apache.datasketches.memory.Memory srcMem, long expectedSeed)
srcMem - Ref: CompactSketch.wrap(Memory, long), srcMemexpectedSeed - Ref: CompactSketch.wrap(Memory, long),
expectedSeedCompactSketchpublic static SetOperation heapifySetOperation(org.apache.datasketches.memory.Memory srcMem)
srcMem - Ref: SetOperation.heapify(Memory), srcMemSetOperationpublic static SetOperation heapifySetOperation(org.apache.datasketches.memory.Memory srcMem, long expectedSeed)
srcMem - Ref: SetOperation.heapify(Memory, long),
srcMemexpectedSeed - the seed used to validate the given Memory image.
Ref: SetOperation.heapify(Memory, long),
expectedSeedSetOperationpublic static Sketch heapifySketch(org.apache.datasketches.memory.Memory srcMem)
srcMem - Ref: Sketch.heapify(Memory), srcMemSketchpublic static Sketch heapifySketch(org.apache.datasketches.memory.Memory srcMem, long expectedSeed)
srcMem - Ref: Sketch.heapify(Memory, long), srcMemexpectedSeed - the seed used to validate the given Memory image.
Ref: Sketch.heapify(Memory, long), expectedSeedSketchpublic static UpdateSketch heapifyUpdateSketch(org.apache.datasketches.memory.Memory srcMem)
srcMem - Ref: UpdateSketch.heapify(Memory), srcMemUpdateSketchpublic static UpdateSketch heapifyUpdateSketch(org.apache.datasketches.memory.Memory srcMem, long expectedSeed)
srcMem - Ref: UpdateSketch.heapify(Memory, long),
srcMemexpectedSeed - the seed used to validate the given Memory image.
Ref: UpdateSketch.heapify(Memory, long),
expectedSeedUpdateSketchpublic static SetOperationBuilder setOperationBuilder()
SetOperationBuilderSetOperationBuilderpublic static UpdateSketchBuilder updateSketchBuilder()
UpdateSketchBuilderUpdateSketchBuilderpublic static Intersection wrapIntersection(org.apache.datasketches.memory.Memory srcMem)
SetOperation.wrap(Memory) and casts the result to a IntersectionsrcMem - Ref: SetOperation.wrap(Memory), srcMempublic static Intersection wrapIntersection(org.apache.datasketches.memory.WritableMemory srcMem)
SetOperation.wrap(Memory) and casts the result to a IntersectionsrcMem - Ref: SetOperation.wrap(Memory), srcMempublic static SetOperation wrapSetOperation(org.apache.datasketches.memory.Memory srcMem)
srcMem - Ref: SetOperation.wrap(Memory), srcMemSetOperationpublic static SetOperation wrapSetOperation(org.apache.datasketches.memory.Memory srcMem, long expectedSeed)
srcMem - Ref: SetOperation.wrap(Memory, long),
srcMemexpectedSeed - the seed used to validate the given Memory image.
Ref: SetOperation.wrap(Memory, long),
expectedSeedSetOperationpublic static SetOperation wrapSetOperation(org.apache.datasketches.memory.WritableMemory srcMem)
srcMem - Ref: SetOperation.wrap(Memory), srcMemSetOperationpublic static SetOperation wrapSetOperation(org.apache.datasketches.memory.WritableMemory srcMem, long expectedSeed)
srcMem - Ref: SetOperation.wrap(Memory, long),
srcMemexpectedSeed - the seed used to validate the given Memory image.
Ref: SetOperation.wrap(Memory, long),
expectedSeedSetOperationpublic static Sketch wrapSketch(org.apache.datasketches.memory.Memory srcMem)
Sketch.wrap(Memory)srcMem - Ref: Sketch.wrap(Memory), srcMemSketchpublic static Sketch wrapSketch(org.apache.datasketches.memory.Memory srcMem, long expectedSeed)
srcMem - Ref: Sketch.wrap(Memory, long), srcMemexpectedSeed - the expectedSeed used to validate the given Memory image.
Ref: Sketch.wrap(Memory, long), expectedSeedSketchpublic static Union wrapUnion(org.apache.datasketches.memory.Memory srcMem)
SetOperation.wrap(Memory) and casts the result to a UnionsrcMem - Ref: SetOperation.wrap(Memory), srcMempublic static Union wrapUnion(org.apache.datasketches.memory.WritableMemory srcMem)
SetOperation.wrap(Memory) and casts the result to a UnionsrcMem - Ref: SetOperation.wrap(Memory), srcMempublic static UpdateSketch wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory srcMem)
srcMem - Ref: UpdateSketch.wrap(Memory), srcMemUpdateSketchpublic static UpdateSketch wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory srcMem, long expectedSeed)
srcMem - Ref: UpdateSketch.wrap(Memory, long), srcMemexpectedSeed - the seed used to validate the given Memory image.
Ref: UpdateSketch.wrap(Memory, long), expectedSeedUpdateSketchCopyright © 2015–2024 The Apache Software Foundation. All rights reserved.