Store (sketches-java 0.8.1 API)

All Known Implementing Classes:

CollapsingHighestDenseStore, CollapsingLowestDenseStore, DenseStore, PaginatedStore, SparseStore, UnboundedSizeDenseStore
```
public interface Store
```
An object that maps integers to counters. It can be seen as a collection of Bin, which are pairs of indices and counters.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`add(Bin bin)` Updates the counter at the specified index.
`default void`	`add(int index)` Increments the counter at the specified index.
`void`	`add(int index, double count)` Updates the counter at the specified index.
`default void`	`add(int index, long count)` Updates the counter at the specified index.
`void`	`clear()` Zeros all counts in the store.
`Store`	`copy()`
`default void`	`decodeAndMergeWith(Input input, BinEncodingMode encodingMode)`
`void`	`encode(Output output, Flag.Type storeFlagType)`
`default void`	`forEach(BinAcceptor acceptor)` Supplies each bin to the acceptor
`java.util.Iterator<Bin>`	`getAscendingIterator()`
`default java.util.stream.Stream<Bin>`	`getAscendingStream()`
`java.util.Iterator<Bin>`	`getDescendingIterator()`
`default java.util.stream.Stream<Bin>`	`getDescendingStream()`
`default int`	`getMaxIndex()`
`default int`	`getMinIndex()`
`default java.util.stream.Stream<Bin>`	`getStream()`
`default double`	`getTotalCount()`
`default boolean`	`isEmpty()`
`default void`	`mergeWith(Store store)` Merges another store into this one.
`default void`	`serialize(Serializer serializer)`
`default int`	`serializedSize()`

- Method Detail
  - add
```
default void add(int index)
```
    Increments the counter at the specified index.
    
    Parameters:
    
    index - the index of the counter to be incremented
  - add
```
default void add(int index,
                 long count)
```
    Updates the counter at the specified index.
    
    Parameters:
    
    index - the index of the counter to be updated
    
    count - a non-negative integer value
    
    Throws:
    
    java.lang.IllegalArgumentException - if count is negative
  - add
```
void add(int index,
         double count)
```
    Updates the counter at the specified index.
    
    Parameters:
    
    index - the index of the counter to be updated
    
    count - a non-negative value
    
    Throws:
    
    java.lang.IllegalArgumentException - if count is negative
  - add
```
default void add(Bin bin)
```
    Updates the counter at the specified index.
    
    Parameters:
    
    bin - the bin to be used for updating the counter
  - mergeWith
```
default void mergeWith(Store store)
```
    Merges another store into this one. This should be equivalent as running the add operations that have been run on the other store on this one.
    
    Parameters:
    
    store - the store to be merged into this one
  - copy
```
Store copy()
```
    Returns:
    
    a (deep) copy of this store
  - clear
```
void clear()
```
    Zeros all counts in the store. The store behaves as if empty after this call, but no underlying storage is released.
  - isEmpty
```
default boolean isEmpty()
```
    Returns:
    
    true iff the Store does not contain any non-zero counter
  - getTotalCount
```
default double getTotalCount()
```
    Returns:
    
    the sum of the counters of this store
  - getMinIndex
```
default int getMinIndex()
```
    Returns:
    
    the index of the lowest non-zero counter
    
    Throws:
    
    java.util.NoSuchElementException - if the store is empty
  - getMaxIndex
```
default int getMaxIndex()
```
    Returns:
    
    the index of the highest non-zero counter
    
    Throws:
    
    java.util.NoSuchElementException - if the store is empty
  - forEach
```
default void forEach(BinAcceptor acceptor)
```
    Supplies each bin to the acceptor
    
    Parameters:
    
    acceptor - consumes this store's bins
  - getStream
```
default java.util.stream.Stream<Bin> getStream()
```
    Returns:
    
    a stream with the non-empty bins of this store as its source
  - getAscendingStream
```
default java.util.stream.Stream<Bin> getAscendingStream()
```
    Returns:
    
    an ordered stream (from lowest to highest index) with the non-empty bins of this store as its source
  - getDescendingStream
```
default java.util.stream.Stream<Bin> getDescendingStream()
```
    Returns:
    
    an ordered stream (from highest to lowest index) with the non-empty bins of this store as its source
  - getAscendingIterator
```
java.util.Iterator<Bin> getAscendingIterator()
```
    Returns:
    
    an iterator that iterates over the non-empty bins of this store, from lowest to highest index
  - getDescendingIterator
```
java.util.Iterator<Bin> getDescendingIterator()
```
    Returns:
    
    an iterator that iterates over the non-empty bins of this store, from highest to lowest index
  - encode
```
void encode(Output output,
            Flag.Type storeFlagType)
     throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - decodeAndMergeWith
```
default void decodeAndMergeWith(Input input,
                                BinEncodingMode encodingMode)
                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - serializedSize
```
default int serializedSize()
```
  - serialize
```
default void serialize(Serializer serializer)
```

Interface Store

Method Summary

Method Detail

add

add

add

add

mergeWith

copy

clear

isEmpty

getTotalCount

getMinIndex

getMaxIndex

forEach

getStream

getAscendingStream

getDescendingStream

getAscendingIterator

getDescendingIterator

encode

decodeAndMergeWith

serializedSize

serialize