Roaring64NavigableMap (RoaringBitmap 0.7.0 API)

java.lang.Object
- org.roaringbitmap.longlong.Roaring64NavigableMap

All Implemented Interfaces:

Externalizable, Serializable, ImmutableLongBitmapDataProvider, LongBitmapDataProvider
```
public class Roaring64NavigableMap
extends Object
implements Externalizable, LongBitmapDataProvider
```
Roaring64NavigableMap extends RoaringBitmap to the whole range of longs (or unsigned longs). It enables a cardinality greater up to Long.MAX_VALUE Longs are added by default in unsigned sorted order (i.e. -1L is the greater long to be added while 0 has no previous value). It can be configured to signed sorted order (in which case, 0 is preceded by 1). That is, they are treated as unsigned integers (see Java 8's Integer.toUnsignedLong function). Up to 4294967296 integers can be stored.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Roaring64NavigableMap()` By default, we consider longs are unsigned longs: normal longs: 0 is the lowest possible long.
`Roaring64NavigableMap(BitmapDataProviderSupplier supplier)` By default, longs are managed as unsigned longs and cardinalities are cached.
`Roaring64NavigableMap(boolean signedLongs)` By default, use RoaringBitmap as underlyings `BitmapDataProvider`
`Roaring64NavigableMap(boolean signedLongs, BitmapDataProviderSupplier supplier)` By default, we activating cardinalities caching.
`Roaring64NavigableMap(boolean signedLongs, boolean cacheCardinalities)` By default, use RoaringBitmap as underlyings `BitmapDataProvider`
`Roaring64NavigableMap(boolean signedLongs, boolean cacheCardinalities, BitmapDataProviderSupplier supplier)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(long... dat)` Set all the specified values to true.
`void`	`add(long rangeStart, long rangeEnd)` Add to the current bitmap all longs in [rangeStart,rangeEnd).
`void`	`addInt(int x)` Add the integer value to the container (set the value to "true"), whether it already appears or not.
`void`	`addLong(long x)` Add the value to the container (set the value to "true"), whether it already appears or not.
`void`	`and(Roaring64NavigableMap x2)` In-place bitwise AND (intersection) operation.
`void`	`andNot(Roaring64NavigableMap x2)` In-place bitwise ANDNOT (difference) operation.
`static Roaring64NavigableMap`	`bitmapOf(long... dat)` Generate a bitmap with the specified values set to true.
`void`	`clear()` reset to an empty bitmap; result occupies as much space a newly created bitmap.
`boolean`	`contains(long x)` Checks whether the value in included, which is equivalent to checking if the corresponding bit is set (get in BitSet class).
`void`	`deserialize(DataInput in)` Deserialize (retrieve) this bitmap.
`protected int`	`ensureCumulatives(int high)`
`boolean`	`equals(Object obj)`
`void`	`flip(long x)` Add the value if it is not already present, otherwise remove it.
`void`	`forEach(LongConsumer lc)` Visit all values in the bitmap and pass them to the consumer.
`int`	`getIntCardinality()`
`long`	`getLongCardinality()` Returns the number of distinct integers added to the bitmap (e.g., number of bits set).
`LongIterator`	`getLongIterator()` For better performance, consider the Use the `forEach` method.
`long`	`getLongSizeInBytes()` Estimate of the memory usage of this data structure.
`LongIterator`	`getReverseLongIterator()`
`int`	`getSizeInBytes()` Estimate of the memory usage of this data structure.
`int`	`hashCode()`
`boolean`	`isEmpty()` Checks whether the bitmap is empty.
`Iterator<Long>`	`iterator()` For better performance, consider the Use the `forEach` method.
`ImmutableLongBitmapDataProvider`	`limit(long x)` Create a new bitmap of the same class, containing at most maxcardinality integers.
`void`	`or(Roaring64NavigableMap x2)` In-place bitwise OR (union) operation.
`long`	`rankLong(long id)` Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()).
`void`	`readExternal(ObjectInput in)`
`void`	`removeLong(long x)` If present remove the specified integers (effectively, sets its bit value to false)
`boolean`	`runOptimize()` Use a run-length encoding where it is estimated as more space efficient
`long`	`select(long j)` Return the jth value stored in this bitmap.
`void`	`serialize(DataOutput out)` Serialize this bitmap.
`long`	`serializedSizeInBytes()` Report the number of bytes required to serialize this bitmap.
`long[]`	`toArray()` Return the set values as an array, if the cardinality is smaller than 2147483648.
`protected LongIterator`	`toIterator(Iterator<Map.Entry<Integer,BitmapDataProvider>> it, boolean reversed)`
`String`	`toString()` A string describing the bitmap.
`void`	`trim()` Recover allocated but unused memory.
`void`	`writeExternal(ObjectOutput out)` `Roaring64NavigableMap` are serializable.
`void`	`xor(Roaring64NavigableMap x2)` In-place bitwise XOR (symmetric difference) operation.

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

- Constructor Detail
  - Roaring64NavigableMap
```
public Roaring64NavigableMap()
```
    By default, we consider longs are unsigned longs: normal longs: 0 is the lowest possible long. Long.MAX_VALUE is followed by Long.MIN_VALUE. -1L is the highest possible value
  - Roaring64NavigableMap
```
public Roaring64NavigableMap(boolean signedLongs)
```
    By default, use RoaringBitmap as underlyings BitmapDataProvider
    
    Parameters:
    
    signedLongs - true if longs has to be ordered as plain java longs. False to handle them as unsigned 64bits long (as RoaringBitmap with unsigned integers)
  - Roaring64NavigableMap
```
public Roaring64NavigableMap(boolean signedLongs,
                             boolean cacheCardinalities)
```
    By default, use RoaringBitmap as underlyings BitmapDataProvider
    
    Parameters:
    
    signedLongs - true if longs has to be ordered as plain java longs. False to handle them as unsigned 64bits long (as RoaringBitmap with unsigned integers)
    
    cacheCardinalities - true if cardinalities have to be cached. It will prevent many iteration along the NavigableMap
  - Roaring64NavigableMap
```
public Roaring64NavigableMap(BitmapDataProviderSupplier supplier)
```
    By default, longs are managed as unsigned longs and cardinalities are cached.
    
    Parameters:
    
    supplier - provide the logic to instantiate new BitmapDataProvider, typically instantiated once per high.
  - Roaring64NavigableMap
```
public Roaring64NavigableMap(boolean signedLongs,
                             BitmapDataProviderSupplier supplier)
```
    By default, we activating cardinalities caching.
    
    Parameters:
    
    signedLongs - true if longs has to be ordered as plain java longs. False to handle them as unsigned 64bits long (as RoaringBitmap with unsigned integers)
    
    supplier - provide the logic to instantiate new BitmapDataProvider, typically instantiated once per high.
  - Roaring64NavigableMap
```
public Roaring64NavigableMap(boolean signedLongs,
                             boolean cacheCardinalities,
                             BitmapDataProviderSupplier supplier)
```
    Parameters:
    
    signedLongs - true if longs has to be ordered as plain java longs. False to handle them as unsigned 64bits long (as RoaringBitmap with unsigned integers)
    
    cacheCardinalities - true if cardinalities have to be cached. It will prevent many iteration along the NavigableMap
    
    supplier - provide the logic to instantiate new BitmapDataProvider, typically instantiated once per high.
- Method Detail
  - addLong
```
public void addLong(long x)
```
    Add the value to the container (set the value to "true"), whether it already appears or not. Java lacks native unsigned longs but the x argument is considered to be unsigned. Within bitmaps, numbers are ordered according to Long.compareUnsigned(long, long). We order the numbers like 0, 1, ..., 9223372036854775807, -9223372036854775808, -9223372036854775807,..., -1.
    
    Specified by:
    
    addLong in interface LongBitmapDataProvider
    
    Parameters:
    
    x - long value
  - addInt
```
public void addInt(int x)
```
    Add the integer value to the container (set the value to "true"), whether it already appears or not. Javac lacks native unsigned integers but the x argument is considered to be unsigned. Within bitmaps, numbers are ordered according to Integer.compareUnsigned(int, int). We order the numbers like 0, 1, ..., 2147483647, -2147483648, -2147483647,..., -1.
    
    Parameters:
    
    x - integer value
  - getLongCardinality
```
public long getLongCardinality()
```
    Returns the number of distinct integers added to the bitmap (e.g., number of bits set).
    
    Specified by:
    
    getLongCardinality in interface ImmutableLongBitmapDataProvider
    
    Returns:
    
    the cardinality
  - getIntCardinality
```
public int getIntCardinality()
                      throws UnsupportedOperationException
```
    Returns:
    
    the cardinality as an int
    
    Throws:
    
    UnsupportedOperationException - if the cardinality does not fit in an int
  - select
```
public long select(long j)
            throws IllegalArgumentException
```
    Return the jth value stored in this bitmap.
    
    Specified by:
    
    select in interface ImmutableLongBitmapDataProvider
    
    Parameters:
    
    j - index of the value
    
    Returns:
    
    the value
    
    Throws:
    
    IllegalArgumentException - if j is out of the bounds of the bitmap cardinality
  - iterator
```
public Iterator<Long> iterator()
```
    For better performance, consider the Use the forEach method.
    
    Returns:
    
    a custom iterator over set bits, the bits are traversed in ascending sorted order
  - forEach
```
public void forEach(LongConsumer lc)
```
    Description copied from interface: ImmutableLongBitmapDataProvider
    Visit all values in the bitmap and pass them to the consumer. * Usage:
```
 
  bitmap.forEach(new LongConsumer() {

    {@literal @}Override
    public void accept(long value) {
      // do something here
      
    }});
   
 }
 
```
    Specified by:
    
    forEach in interface ImmutableLongBitmapDataProvider
    
    Parameters:
    
    lc - the consumer
  - rankLong
```
public long rankLong(long id)
```
    Description copied from interface: ImmutableLongBitmapDataProvider
    
    Rank returns the number of integers that are smaller or equal to x (Rank(infinity) would be GetCardinality()). The value is a full 64-bit value.
    
    Specified by:
    
    rankLong in interface ImmutableLongBitmapDataProvider
    
    Parameters:
    
    id - upper limit
    
    Returns:
    
    the rank
  - ensureCumulatives
```
protected int ensureCumulatives(int high)
```
    Parameters:
    
    high - for which high bucket should we compute the cardinality
    
    Returns:
    
    the highest validatedIndex
  - or
```
public void or(Roaring64NavigableMap x2)
```
    In-place bitwise OR (union) operation. The current bitmap is modified.
    
    Parameters:
    
    x2 - other bitmap
  - xor
```
public void xor(Roaring64NavigableMap x2)
```
    In-place bitwise XOR (symmetric difference) operation. The current bitmap is modified.
    
    Parameters:
    
    x2 - other bitmap
  - and
```
public void and(Roaring64NavigableMap x2)
```
    In-place bitwise AND (intersection) operation. The current bitmap is modified.
    
    Parameters:
    
    x2 - other bitmap
  - andNot
```
public void andNot(Roaring64NavigableMap x2)
```
    In-place bitwise ANDNOT (difference) operation. The current bitmap is modified.
    
    Parameters:
    
    x2 - other bitmap
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Roaring64NavigableMap are serializable. However, contrary to RoaringBitmap, the serialization format is not well-defined: for now, it is strongly coupled with Java standard serialization. Just like the serialization may be incompatible between various Java versions, Roaring64NavigableMap are subject to incompatibilities. Moreover, even on a given Java versions, the serialization format may change from one RoaringBitmap version to another
    
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - toString
```
public String toString()
```
    A string describing the bitmap.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the string
  - getLongIterator
```
public LongIterator getLongIterator()
```
    For better performance, consider the Use the forEach method.
    
    Specified by:
    
    getLongIterator in interface ImmutableLongBitmapDataProvider
    
    Returns:
    
    a custom iterator over set bits, the bits are traversed in ascending sorted order
  - toIterator
```
protected LongIterator toIterator(Iterator<Map.Entry<Integer,BitmapDataProvider>> it,
                                  boolean reversed)
```
  - contains
```
public boolean contains(long x)
```
    Description copied from interface: ImmutableLongBitmapDataProvider
    
    Checks whether the value in included, which is equivalent to checking if the corresponding bit is set (get in BitSet class).
    
    Specified by:
    
    contains in interface ImmutableLongBitmapDataProvider
    
    Parameters:
    
    x - long value
    
    Returns:
    
    whether the long value is included.
  - getSizeInBytes
```
public int getSizeInBytes()
```
    Description copied from interface: ImmutableLongBitmapDataProvider
    
    Estimate of the memory usage of this data structure. Internally, this is computed as a 64-bit counter.
    
    Specified by:
    
    getSizeInBytes in interface ImmutableLongBitmapDataProvider
    
    Returns:
    
    estimated memory usage.
  - getLongSizeInBytes
```
public long getLongSizeInBytes()
```
    Description copied from interface: ImmutableLongBitmapDataProvider
    
    Estimate of the memory usage of this data structure. Provides full 64-bit number.
    
    Specified by:
    
    getLongSizeInBytes in interface ImmutableLongBitmapDataProvider
    
    Returns:
    
    estimated memory usage.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: ImmutableLongBitmapDataProvider
    
    Checks whether the bitmap is empty.
    
    Specified by:
    
    isEmpty in interface ImmutableLongBitmapDataProvider
    
    Returns:
    
    true if this bitmap contains no set bit
  - limit
```
public ImmutableLongBitmapDataProvider limit(long x)
```
    Description copied from interface: ImmutableLongBitmapDataProvider
    
    Create a new bitmap of the same class, containing at most maxcardinality integers.
    
    Specified by:
    
    limit in interface ImmutableLongBitmapDataProvider
    
    Parameters:
    
    x - maximal cardinality
    
    Returns:
    
    a new bitmap with cardinality no more than maxcardinality
  - runOptimize
```
public boolean runOptimize()
```
    Use a run-length encoding where it is estimated as more space efficient
    
    Returns:
    
    whether a change was applied
  - serialize
```
public void serialize(DataOutput out)
               throws IOException
```
    Serialize this bitmap. Unlike RoaringBitmap, there is no specification for now: it may change from onve java version to another, and from one RoaringBitmap version to another. Consider calling runOptimize() before serialization to improve compression. The current bitmap is not modified.
    
    Specified by:
    
    serialize in interface ImmutableLongBitmapDataProvider
    
    Parameters:
    
    out - the DataOutput stream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - deserialize
```
public void deserialize(DataInput in)
                 throws IOException
```
    Deserialize (retrieve) this bitmap. Unlike RoaringBitmap, there is no specification for now: it may change from one java version to another, and from one RoaringBitmap version to another. The current bitmap is overwritten.
    
    Parameters:
    
    in - the DataInput stream
    
    Throws:
    
    IOException - Signals that an I/O exception has occurred.
  - serializedSizeInBytes
```
public long serializedSizeInBytes()
```
    Description copied from interface: ImmutableLongBitmapDataProvider
    
    Report the number of bytes required to serialize this bitmap. This is the number of bytes written out when using the serialize method. When using the writeExternal method, the count will be higher due to the overhead of Java serialization.
    
    Specified by:
    
    serializedSizeInBytes in interface ImmutableLongBitmapDataProvider
    
    Returns:
    
    the size in bytes
  - clear
```
public void clear()
```
    reset to an empty bitmap; result occupies as much space a newly created bitmap.
  - toArray
```
public long[] toArray()
```
    Return the set values as an array, if the cardinality is smaller than 2147483648. The long values are in sorted order.
    
    Specified by:
    
    toArray in interface ImmutableLongBitmapDataProvider
    
    Returns:
    
    array representing the set values.
  - bitmapOf
```
public static Roaring64NavigableMap bitmapOf(long... dat)
```
    Generate a bitmap with the specified values set to true. The provided longs values don't have to be in sorted order, but it may be preferable to sort them from a performance point of view.
    
    Parameters:
    
    dat - set values
    
    Returns:
    
    a new bitmap
  - add
```
public void add(long... dat)
```
    Set all the specified values to true. This can be expected to be slightly faster than calling "add" repeatedly. The provided integers values don't have to be in sorted order, but it may be preferable to sort them from a performance point of view.
    
    Parameters:
    
    dat - set values
  - add
```
public void add(long rangeStart,
                long rangeEnd)
```
    Add to the current bitmap all longs in [rangeStart,rangeEnd).
    
    Parameters:
    
    rangeStart - inclusive beginning of range
    
    rangeEnd - exclusive ending of range
  - getReverseLongIterator
```
public LongIterator getReverseLongIterator()
```
    Specified by:
    
    getReverseLongIterator in interface ImmutableLongBitmapDataProvider
    
    Returns:
    
    a custom iterator over set bits, the bits are traversed in descending sorted order
  - removeLong
```
public void removeLong(long x)
```
    Description copied from interface: LongBitmapDataProvider
    
    If present remove the specified integers (effectively, sets its bit value to false)
    
    Specified by:
    
    removeLong in interface LongBitmapDataProvider
    
    Parameters:
    
    x - long value representing the index in a bitmap
  - trim
```
public void trim()
```
    Description copied from interface: LongBitmapDataProvider
    
    Recover allocated but unused memory.
    
    Specified by:
    
    trim in interface LongBitmapDataProvider
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - flip
```
public void flip(long x)
```
    Add the value if it is not already present, otherwise remove it.
    
    Parameters:
    
    x - long value

Class Roaring64NavigableMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Roaring64NavigableMap

Roaring64NavigableMap

Roaring64NavigableMap

Roaring64NavigableMap

Roaring64NavigableMap

Roaring64NavigableMap

Method Detail

addLong

addInt

getLongCardinality

getIntCardinality

select

iterator

forEach

rankLong

ensureCumulatives

or

xor

and

andNot

writeExternal

readExternal

toString

getLongIterator

toIterator

contains

getSizeInBytes

getLongSizeInBytes

isEmpty

limit

runOptimize

serialize

deserialize

serializedSizeInBytes

clear

toArray

bitmapOf

add

add

getReverseLongIterator

removeLong

trim

hashCode

equals

flip