Package org.roaringbitmap.longlong
Class Roaring64Bitmap
- java.lang.Object
-
- org.roaringbitmap.longlong.Roaring64Bitmap
-
- All Implemented Interfaces:
java.io.Externalizable
,java.io.Serializable
,ImmutableLongBitmapDataProvider
,LongBitmapDataProvider
public class Roaring64Bitmap extends java.lang.Object implements java.io.Externalizable, LongBitmapDataProvider
Roaring64Bitmap is a compressed 64 bit bitmap. It can contain all the numbers of long rang[Long.MAX_VALUE, Long.MIN_VALUE]. Since java has no unsigned long,we treat the negative value as a successor of the positive value. So the ascending ordering of all the long value is: 0,1,2...Long.MAX_VALUE,Long.MIN_VALUE,Long.MIN_VALUE+1.......-1. See Long.toUnsignedString()- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.roaringbitmap.longlong.ImmutableLongBitmapDataProvider
ImmutableLongBitmapDataProvider.RoaringOfLong
-
-
Constructor Summary
Constructors Constructor Description Roaring64Bitmap()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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)
void
addLong(long x)
Add the value to the container (set the value to "true"), whether it already appears or not.void
and(Roaring64Bitmap x2)
In-place bitwise AND (intersection) operation.void
andNot(Roaring64Bitmap x2)
In-place bitwise ANDNOT (difference) operation.static Roaring64Bitmap
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.Roaring64Bitmap
clone()
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(java.io.DataInput in)
Deserialize (retrieve) this bitmap.void
deserialize(java.nio.ByteBuffer in)
Deserialize (retrieve) this bitmap.boolean
equals(java.lang.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).PeekableLongIterator
getLongIterator()
For better performance, consider the Use theforEach
method.long
getLongSizeInBytes()
Estimate of the memory usage of this data structure.PeekableLongIterator
getReverseLongIterator()
int
getSizeInBytes()
Estimate of the memory usage of this data structure.int
hashCode()
boolean
isEmpty()
Checks whether the bitmap is empty.java.util.Iterator<java.lang.Long>
iterator()
For better performance, consider the Use theforEach
method.ImmutableLongBitmapDataProvider
limit(long x)
Create a new bitmap of the same class, containing at most maxcardinality integers.void
or(Roaring64Bitmap 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(java.io.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 efficientlong
select(long j)
Return the jth value stored in this bitmap.void
serialize(java.io.DataOutput out)
Serialize this bitmap.void
serialize(java.nio.ByteBuffer byteBuffer)
Serialize this bitmap, please make sure the size of the serialized bytes is smaller enough that ByteBuffer can hold it.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.java.lang.String
toString()
A string describing the bitmap.void
trim()
remove the allocated unused memory spacevoid
writeExternal(java.io.ObjectOutput out)
Roaring64NavigableMap
are serializable.void
xor(Roaring64Bitmap x2)
In-place bitwise XOR (symmetric difference) operation.-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.roaringbitmap.longlong.ImmutableLongBitmapDataProvider
reverseStream, stream
-
-
-
-
Method Detail
-
addInt
public void addInt(int x)
-
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 toLong.toUnsignedString(long, int)
. We order the numbers like 0, 1, ..., 9223372036854775807, -9223372036854775808, -9223372036854775807,..., -1.- Specified by:
addLong
in interfaceLongBitmapDataProvider
- Parameters:
x
- long 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 interfaceImmutableLongBitmapDataProvider
- Returns:
- the cardinality
-
getIntCardinality
public int getIntCardinality() throws java.lang.UnsupportedOperationException
- Returns:
- the cardinality as an int
- Throws:
java.lang.UnsupportedOperationException
- if the cardinality does not fit in an int
-
select
public long select(long j) throws java.lang.IllegalArgumentException
Return the jth value stored in this bitmap.- Specified by:
select
in interfaceImmutableLongBitmapDataProvider
- Parameters:
j
- index of the value- Returns:
- the value
- Throws:
java.lang.IllegalArgumentException
- if j is out of the bounds of the bitmap cardinality
-
iterator
public java.util.Iterator<java.lang.Long> iterator()
For better performance, consider the Use theforEach
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 interfaceImmutableLongBitmapDataProvider
- 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 interfaceImmutableLongBitmapDataProvider
- Parameters:
id
- upper limit- Returns:
- the rank
-
or
public void or(Roaring64Bitmap x2)
In-place bitwise OR (union) operation. The current bitmap is modified.- Parameters:
x2
- other bitmap
-
xor
public void xor(Roaring64Bitmap x2)
In-place bitwise XOR (symmetric difference) operation. The current bitmap is modified.- Parameters:
x2
- other bitmap
-
and
public void and(Roaring64Bitmap x2)
In-place bitwise AND (intersection) operation. The current bitmap is modified.- Parameters:
x2
- other bitmap
-
andNot
public void andNot(Roaring64Bitmap x2)
In-place bitwise ANDNOT (difference) operation. The current bitmap is modified.- Parameters:
x2
- other bitmap
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.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 interfacejava.io.Externalizable
- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException
- Specified by:
readExternal
in interfacejava.io.Externalizable
- Throws:
java.io.IOException
-
toString
public java.lang.String toString()
A string describing the bitmap.- Overrides:
toString
in classjava.lang.Object
- Returns:
- the string
-
getLongIterator
public PeekableLongIterator getLongIterator()
For better performance, consider the Use theforEach
method.- Specified by:
getLongIterator
in interfaceImmutableLongBitmapDataProvider
- Returns:
- a custom iterator over set bits, the bits are traversed in ascending sorted order
-
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 interfaceImmutableLongBitmapDataProvider
- 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 interfaceImmutableLongBitmapDataProvider
- 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 interfaceImmutableLongBitmapDataProvider
- Returns:
- estimated memory usage.
-
isEmpty
public boolean isEmpty()
Description copied from interface:ImmutableLongBitmapDataProvider
Checks whether the bitmap is empty.- Specified by:
isEmpty
in interfaceImmutableLongBitmapDataProvider
- 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 interfaceImmutableLongBitmapDataProvider
- 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(java.io.DataOutput out) throws java.io.IOException
Serialize 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. Consider callingrunOptimize()
before serialization to improve compression. The current bitmap is not modified.- Specified by:
serialize
in interfaceImmutableLongBitmapDataProvider
- Parameters:
out
- the DataOutput stream- Throws:
java.io.IOException
- Signals that an I/O exception has occurred.
-
serialize
public void serialize(java.nio.ByteBuffer byteBuffer) throws java.io.IOException
Serialize this bitmap, please make sure the size of the serialized bytes is smaller enough that ByteBuffer can hold it.- Parameters:
byteBuffer
- the ByteBuffer- Throws:
java.io.IOException
- Signals that an I/O exception has occurred.
-
deserialize
public void deserialize(java.io.DataInput in) throws java.io.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:
java.io.IOException
- Signals that an I/O exception has occurred.
-
deserialize
public void deserialize(java.nio.ByteBuffer in) throws java.io.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 ByteBuffer stream- Throws:
java.io.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 interfaceImmutableLongBitmapDataProvider
- 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 interfaceImmutableLongBitmapDataProvider
- Returns:
- array representing the set values.
-
bitmapOf
public static Roaring64Bitmap 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 rangerangeEnd
- exclusive ending of range
-
getReverseLongIterator
public PeekableLongIterator getReverseLongIterator()
- Specified by:
getReverseLongIterator
in interfaceImmutableLongBitmapDataProvider
- 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 interfaceLongBitmapDataProvider
- Parameters:
x
- long value representing the index in a bitmap
-
trim
public void trim()
remove the allocated unused memory space- Specified by:
trim
in interfaceLongBitmapDataProvider
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
flip
public void flip(long x)
Add the value if it is not already present, otherwise remove it.- Parameters:
x
- long value
-
clone
public Roaring64Bitmap clone()
- Overrides:
clone
in classjava.lang.Object
-
-