Class CompactQuantilesDoublesSketch

java.lang.Object

org.apache.datasketches.quantiles.QuantilesDoublesSketch

org.apache.datasketches.quantiles.CompactQuantilesDoublesSketch

All Implemented Interfaces:

MemorySegmentStatus, QuantilesAPI, QuantilesDoublesAPI

public abstract class CompactQuantilesDoublesSketch
extends QuantilesDoublesSketch

Compact sketches are inherently read only.

Author:

Jon Malkin

Field Summary

Fields inherited from interface QuantilesAPI

EMPTY_MSG, MEM_REQ_SVR_NULL_MSG, NOT_SINGLE_ITEM_MSG, SELF_MERGE_MSG, TGT_IS_READ_ONLY_MSG, UNSUPPORTED_MSG

Method Summary

Modifier and Type	Method	Description
boolean	isReadOnly()	Returns true if this sketch is read only.
void	reset()	Resets this sketch to the empty state.
void	update(double quantile)	Updates this sketch with the given item.

Methods inherited from class QuantilesDoublesSketch

builder, downSample, getCDF, getCompactSerialiedSizeBytes, getCurrentCompactSerializedSizeBytes, getCurrentUpdatableSerializedSizeBytes, getK, getKFromEpsilon, getMaxItem, getMinItem, getN, getNormalizedRankError, getNormalizedRankError, getNumRetained, getPMF, getQuantile, getQuantileLowerBound, getQuantiles, getQuantileUpperBound, getRank, getRankLowerBound, getRanks, getRankUpperBound, getSerializedSizeBytes, getSortedView, getUpdatableStorageBytes, hasMemorySegment, heapify, isEmpty, isEstimationMode, isOffHeap, isSameResource, iterator, putIntoMemorySegment, putIntoMemorySegment, toByteArray, toByteArray, toString, toString, toString, toString, wrap, writableWrap, writableWrap

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface QuantilesDoublesAPI

getCDF, getPMF, getQuantile, getQuantiles, getRank, getRanks

Method Details

isReadOnly

public boolean isReadOnly()

Description copied from interface: QuantilesAPI

Returns true if this sketch is read only.

Specified by:

isReadOnly in interface QuantilesAPI

Specified by:

isReadOnly in class QuantilesDoublesSketch

Returns:

true if this sketch is read only.

reset

public void reset()

Description copied from interface: QuantilesAPI

Resets this sketch to the empty state. If the sketch is read only this does nothing.

The parameter k will not change.

Specified by:

reset in interface QuantilesAPI

Specified by:

reset in class QuantilesDoublesSketch

update

public void update(double quantile)

Description copied from interface: QuantilesDoublesAPI

Updates this sketch with the given item.

Parameters:

quantile - from a stream of items. NaNs are ignored.