UpdateSketch (com.yahoo.datasketches:sketches-core 0.9.0 API)

java.lang.Object
- com.yahoo.sketches.theta.Sketch
- - com.yahoo.sketches.theta.UpdateSketch

```
public abstract class UpdateSketch
extends Sketch
```
The parent class for the Update Sketch families, such as QuickSelect and Alpha. The primary task of an Upeate Sketch is to consider datums presented via the update() methods for inclusion in its internal cache. This is the sketch building process.

Author:

Lee Rhodes

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateSketchBuilder`	`builder()` Returns a new builder
`CompactSketch`	`compact()` Converts this UpdateSketch to an ordered CompactSketch on the Java heap.
`CompactSketch`	`compact(boolean dstOrdered, Memory dstMem)` Convert this UpdateSketch to a CompactSketch in the chosen form.
`abstract ResizeFactor`	`getResizeFactor()` Returns the configured ResizeFactor
`boolean`	`isCompact()` Returns true if this sketch is in compact form.
`abstract boolean`	`isEmpty()` See Empty
`boolean`	`isOrdered()` Returns true if internal cache is ordered
`abstract UpdateSketch`	`rebuild()` Rebuilds the hash table to remove dirty values or to reduce the size to nominal entries.
`abstract void`	`reset()` Resets this sketch back to a virgin empty state.
`UpdateReturnState`	`update(byte[] data)` Present this sketch with the given byte array.
`UpdateReturnState`	`update(char[] data)` Present this sketch with the given char array.
`UpdateReturnState`	`update(double datum)` Present this sketch with the given double (or float) datum.
`UpdateReturnState`	`update(int[] data)` Present this sketch with the given integer array.
`UpdateReturnState`	`update(long datum)` Present this sketch with a long.
`UpdateReturnState`	`update(long[] data)` Present this sketch with the given long array.
`UpdateReturnState`	`update(String datum)` Present this sketch with the given String.

Methods inherited from class com.yahoo.sketches.theta.Sketch
getCountLessThanTheta, getCurrentBytes, getEstimate, getFamily, getLowerBound, getMaxCompactSketchBytes, getMaxUpdateSketchBytes, getRetainedEntries, getRetainedEntries, getSerializationVersion, getTheta, getUpperBound, heapify, heapify, isDirect, isEstimationMode, toByteArray, toString, toString, wrap, wrap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - isEmpty
```
public abstract boolean isEmpty()
```
    Description copied from class: Sketch
    
    See Empty
    
    Specified by:
    
    isEmpty in class Sketch
    
    Returns:
    
    true if empty.
  - isCompact
```
public boolean isCompact()
```
    Description copied from class: Sketch
    
    Returns true if this sketch is in compact form.
    
    Specified by:
    
    isCompact in class Sketch
    
    Returns:
    
    true if this sketch is in compact form.
  - isOrdered
```
public boolean isOrdered()
```
    Description copied from class: Sketch
    
    Returns true if internal cache is ordered
    
    Specified by:
    
    isOrdered in class Sketch
    
    Returns:
    
    true if internal cache is ordered
  - builder
```
public static final UpdateSketchBuilder builder()
```
    Returns a new builder
    
    Returns:
    
    a new builder
  - reset
```
public abstract void reset()
```
    Resets this sketch back to a virgin empty state.
  - compact
```
public CompactSketch compact(boolean dstOrdered,
                             Memory dstMem)
```
    Convert this UpdateSketch to a CompactSketch in the chosen form.
    This compacting process converts the hash table form of an UpdateSketch to a simple list of the valid hash values from the hash table. Any hash values equal to or greater than theta will be discarded. The number of valid values remaining in the Compact Sketch depends on a number of factors, but may be larger or smaller than Nominal Entries (or k). It will never exceed 2k. If it is critical to always limit the size to no more than k, then rebuild() should be called on the UpdateSketch prior to this.
    
    Parameters:
    
    dstOrdered - See Destination Ordered
    
    dstMem - See Destination Memory.
    
    Returns:
    
    this sketch as a CompactSketch in the chosen form
  - compact
```
public CompactSketch compact()
```
    Converts this UpdateSketch to an ordered CompactSketch on the Java heap.
    
    Returns:
    
    this sketch as an ordered CompactSketch on the Java heap.
  - rebuild
```
public abstract UpdateSketch rebuild()
```
    Rebuilds the hash table to remove dirty values or to reduce the size to nominal entries.
    
    Returns:
    
    this sketch
  - getResizeFactor
```
public abstract ResizeFactor getResizeFactor()
```
    Returns the configured ResizeFactor
    
    Returns:
    
    the configured ResizeFactor
  - update
```
public UpdateReturnState update(long datum)
```
    Present this sketch with a long.
    
    Parameters:
    
    datum - The given long datum.
    
    Returns:
    
    See Update Return State
  - update
```
public UpdateReturnState update(double datum)
```
    Present this sketch with the given double (or float) datum. The double will be converted to a long using Double.doubleToLongBits(datum), which normalizes all NaN values to a single NaN representation. Plus and minus zero will be normalized to plus zero. The special floating-point values NaN and +/- Infinity are treated as distinct.
    
    Parameters:
    
    datum - The given double datum.
    
    Returns:
    
    See Update Return State
  - update
```
public UpdateReturnState update(String datum)
```
    Present this sketch with the given String. The string is converted to a byte array using UTF8 encoding. If the string is null or empty no update attempt is made and the method returns.
    Note: this will not produce the same output hash values as the update(char[]) method and will generally be a little slower depending on the complexity of the UTF8 encoding.
    
    Parameters:
    
    datum - The given String.
    
    Returns:
    
    See Update Return State
  - update
```
public UpdateReturnState update(byte[] data)
```
    Present this sketch with the given byte array. If the byte array is null or empty no update attempt is made and the method returns.
    
    Parameters:
    
    data - The given byte array.
    
    Returns:
    
    See Update Return State
  - update
```
public UpdateReturnState update(char[] data)
```
    Present this sketch with the given char array. If the char array is null or empty no update attempt is made and the method returns.
    Note: this will not produce the same output hash values as the update(String) method but will be a little faster as it avoids the complexity of the UTF8 encoding.
    
    Parameters:
    
    data - The given char array.
    
    Returns:
    
    See Update Return State
  - update
```
public UpdateReturnState update(int[] data)
```
    Present this sketch with the given integer array. If the integer array is null or empty no update attempt is made and the method returns.
    
    Parameters:
    
    data - The given int array.
    
    Returns:
    
    See Update Return State
  - update
```
public UpdateReturnState update(long[] data)
```
    Present this sketch with the given long array. If the long array is null or empty no update attempt is made and the method returns.
    
    Parameters:
    
    data - The given long array.
    
    Returns:
    
    See Update Return State

Class UpdateSketch

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

isEmpty

isCompact

isOrdered

builder

reset

compact

compact

rebuild

getResizeFactor

update

update

update

update

update

update

update