com.yahoo.sketches.tuple

Class UpdatableSketch<U,S extends UpdatableSummary<U>>

java.lang.Object

com.yahoo.sketches.tuple.Sketch<S>

com.yahoo.sketches.tuple.UpdatableSketch<U,S>

Type Parameters:

U - Type of the value, which is passed to update method of a Summary

S - Type of the UpdatableSummary<U>

public class UpdatableSketch<U,S extends UpdatableSummary<U>>
extends Sketch<S>

An extension of QuickSelectSketch, which can be updated with many types of keys. Summary objects are created using a user-defined SummaryFactory class, which should allow very flexible parameterization if needed. Keys are presented to a sketch along with values of a user-defined update type U. When an entry is inserted into a sketch or a duplicate key is presented to a sketch then summary.update(U value) method will be called. So any kind of user-defined accumulation is possible. Summaries also must know how to copy themselves. Also union and intersection of summaries can be implemented in a sub-class of SummarySetOperations, which will be used in case Union or Intersection of two instances of Tuple Sketch is needed

Field Summary

Fields inherited from class com.yahoo.sketches.tuple.Sketch

PREAMBLE_LONGS

Method Summary

Modifier and Type	Method and Description
CompactSketch<S>	compact() Converts the current state of the sketch into a compact sketch
int	getRetainedEntries()
S[]	getSummaries()
byte[]	toByteArray() This is to serialize an instance to a byte array.
void	trim() Rebuilds reducing the actual number of entries to the nominal number of entries if needed
void	update(byte[] key, U value) Updates this sketch with a byte[] key and U value.
void	update(double key, U value) Updates this sketch with a double key and U value.
void	update(int[] key, U value) Updates this sketch with a int[] key and U value.
void	update(long[] key, U value) Updates this sketch with a long[] key and U value.
void	update(long key, U value) Updates this sketch with a long key and U value.
void	update(String key, U value) Updates this sketch with a String key and U value.

Methods inherited from class com.yahoo.sketches.tuple.Sketch

getEstimate, getLowerBound, getTheta, getUpperBound, isEmpty, isEstimationMode, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

update

public void update(long key,
                   U value)

Updates this sketch with a long key and U value. The value is passed to update() method of the Summary object associated with the key

Parameters:

key - The given long key

value - The given U value

update

public void update(double key,
                   U value)

Updates this sketch with a double key and U value. The value is passed to update() method of the Summary object associated with the key

Parameters:

key - The given double key

value - The given U value

update

public void update(String key,
                   U value)

Updates this sketch with a String key and U value. The value is passed to update() method of the Summary object associated with the key

Parameters:

key - The given String key

value - The given U value

update

public void update(byte[] key,
                   U value)

Updates this sketch with a byte[] key and U value. The value is passed to update() method of the Summary object associated with the key

Parameters:

key - The given byte[] key

value - The given U value

update

public void update(int[] key,
                   U value)

Updates this sketch with a int[] key and U value. The value is passed to update() method of the Summary object associated with the key

Parameters:

key - The given int[] key

value - The given U value

update

public void update(long[] key,
                   U value)

Updates this sketch with a long[] key and U value. The value is passed to update() method of the Summary object associated with the key

Parameters:

key - The given long[] key

value - The given U value

getSummaries

public S[] getSummaries()

Specified by:

getSummaries in class Sketch<S extends Summary>

Returns:

an array of Summary objects from the sketch

getRetainedEntries

public int getRetainedEntries()

Specified by:

getRetainedEntries in class Sketch<S extends Summary>

Returns:

number of retained entries

trim

public void trim()

Rebuilds reducing the actual number of entries to the nominal number of entries if needed

compact

public CompactSketch<S> compact()

Converts the current state of the sketch into a compact sketch

Returns:

compact sketch

toByteArray

public byte[] toByteArray()

Description copied from class: Sketch

This is to serialize an instance to a byte array. For deserialization there must be a constructor, which takes a Memory object

Specified by:

toByteArray in class Sketch<S extends Summary>

Returns:

serialized representation of the sketch