ItemsSketchSortedView (datasketches-java 4.1.0 API)

java.lang.Object
- org.apache.datasketches.quantiles.ItemsSketchSortedView<T>

Type Parameters:

T - The sketch data type

All Implemented Interfaces:

GenericSortedView<T>, SortedView
```
public final class ItemsSketchSortedView<T>
extends Object
implements GenericSortedView<T>
```
The SortedView of the Classic Quantiles ItemsSketch.

Author:

Kevin Lang, Alexander Saydakov

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double[]`	`getCDF(T[] splitPoints, QuantileSearchCriteria searchCrit)` Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], given a set of splitPoints.
`long[]`	`getCumulativeWeights()` Returns the array of cumulative weights
`double[]`	`getPMF(T[] splitPoints, QuantileSearchCriteria searchCrit)` Returns an approximation to the Probability Mass Function (PMF) of the input stream as an array of probability masses as doubles on the interval [0.0, 1.0], given a set of splitPoints.
`T`	`getQuantile(double rank, QuantileSearchCriteria searchCrit)` Gets the approximate quantile of the given normalized rank and the given search criterion.
`T[]`	`getQuantiles()` Returns the array of quantiles.
`double`	`getRank(T quantile, QuantileSearchCriteria searchCrit)` Gets the normalized rank corresponding to the given a quantile.
`boolean`	`isEmpty()` Returns true if this sorted view is empty.
`ItemsSketchSortedViewIterator<T>`	`iterator()` Returns an iterator for this Sorted View.

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

- Method Detail
  - getQuantile
```
public T getQuantile(double rank,
                     QuantileSearchCriteria searchCrit)
```
    Description copied from interface: GenericSortedView
    
    Gets the approximate quantile of the given normalized rank and the given search criterion.
    
    Specified by:
    
    getQuantile in interface GenericSortedView<T>
    
    Parameters:
    
    rank - the given normalized rank, a double in the range [0.0, 1.0].
    
    searchCrit - If INCLUSIVE, the given rank includes all quantiles ≤ the quantile directly corresponding to the given rank. If EXCLUSIVE, he given rank includes all quantiles < the quantile directly corresponding to the given rank.
    
    Returns:
    
    the approximate quantile given the normalized rank.
    
    See Also:
    
    QuantileSearchCriteria
  - getRank
```
public double getRank(T quantile,
                      QuantileSearchCriteria searchCrit)
```
    Description copied from interface: GenericSortedView
    
    Gets the normalized rank corresponding to the given a quantile.
    
    Specified by:
    
    getRank in interface GenericSortedView<T>
    
    Parameters:
    
    quantile - the given quantile
    
    searchCrit - if INCLUSIVE the given quantile is included into the rank.
    
    Returns:
    
    the normalized rank corresponding to the given quantile.
    
    See Also:
    
    QuantileSearchCriteria
  - getCDF
```
public double[] getCDF(T[] splitPoints,
                       QuantileSearchCriteria searchCrit)
```
    Description copied from interface: GenericSortedView
    
    Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0], given a set of splitPoints.
    If the sketch is empty this returns null.
    
    The resulting approximations have a probabilistic guarantee that can be obtained from the getNormalizedRankError(false) function.
    Specified by:
    
    getCDF in interface GenericSortedView<T>
    
    Parameters:
    splitPoints - an array of m unique, monotonically increasing items (of the same type as the input items) that divide the item input domain into m+1 overlapping intervals.
    The start of each interval is below the lowest item retained by the sketch corresponding to a zero rank or zero probability, and the end of the interval is the rank or cumulative probability corresponding to the split point.
    
    The (m+1)th interval represents 100% of the distribution represented by the sketch and consistent with the definition of a cumulative probability distribution, thus the (m+1)th rank or probability in the returned array is always 1.0.
    
    If a split point exactly equals a retained item of the sketch and the search criterion is:
    
    INCLUSIVE, the resulting cumulative probability will include that item.
    
    EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.
    
    It is not recommended to include either the minimum or maximum items of the input stream.
    searchCrit - the desired search criteria.
    
    Returns:
    
    a discrete CDF array of m+1 double ranks (or cumulative probabilities) on the interval [0.0, 1.0].
  - getPMF
```
public double[] getPMF(T[] splitPoints,
                       QuantileSearchCriteria searchCrit)
```
    Description copied from interface: GenericSortedView
    
    Returns an approximation to the Probability Mass Function (PMF) of the input stream as an array of probability masses as doubles on the interval [0.0, 1.0], given a set of splitPoints.
    The resulting approximations have a probabilistic guarantee that can be obtained from the getNormalizedRankError(true) function.
    Specified by:
    
    getPMF in interface GenericSortedView<T>
    
    Parameters:
    splitPoints - an array of m unique, monotonically increasing items (of the same type as the input items) that divide the item input domain into m+1 consecutive, non-overlapping intervals.
    Each interval except for the end intervals starts with a split point and ends with the next split point in sequence.
    
    The first interval starts below the lowest item retained by the sketch corresponding to a zero rank or zero probability, and ends with the first split point
    
    The last (m+1)th interval starts with the last split point and ends after the last item retained by the sketch corresponding to a rank or probability of 1.0.
    
    The sum of the probability masses of all (m+1) intervals is 1.0.
    
    If the search criterion is:
    
    INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude that item.
    
    EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include that item.
    
    It is not recommended to include either the minimum or maximum items of the input stream.
    searchCrit - the desired search criteria.
    
    Returns:
    
    a PMF array of m+1 probability masses as doubles on the interval [0.0, 1.0].
  - getCumulativeWeights
```
public long[] getCumulativeWeights()
```
    Description copied from interface: SortedView
    
    Returns the array of cumulative weights
    
    Specified by:
    
    getCumulativeWeights in interface SortedView
    
    Returns:
    
    the array of cumulative weights
  - getQuantiles
```
public T[] getQuantiles()
```
    Description copied from interface: GenericSortedView
    
    Returns the array of quantiles.
    
    Specified by:
    
    getQuantiles in interface GenericSortedView<T>
    
    Returns:
    
    the array of quantiles.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: SortedView
    
    Returns true if this sorted view is empty.
    
    Specified by:
    
    isEmpty in interface SortedView
    
    Returns:
    
    true if this sorted view is empty.
  - iterator
```
public ItemsSketchSortedViewIterator<T> iterator()
```
    Description copied from interface: SortedView
    
    Returns an iterator for this Sorted View.
    
    Specified by:
    
    iterator in interface GenericSortedView<T>
    
    Specified by:
    
    iterator in interface SortedView
    
    Returns:
    
    an iterator for this Sorted View.

Class ItemsSketchSortedView<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getQuantile

getRank

getCDF

getPMF

getCumulativeWeights

getQuantiles

isEmpty

iterator