Module roaringbitmap

Package org.roaringbitmap.buffer

Class CopyOnWriteRoaringBitmap

java.lang.Object

org.roaringbitmap.buffer.ImmutableRoaringBitmap

org.roaringbitmap.buffer.MutableRoaringBitmap

org.roaringbitmap.buffer.CopyOnWriteRoaringBitmap

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Iterable<Integer>, AppendableStorage<MappeableContainer>, BitmapDataProvider, ImmutableBitmapDataProvider

public class CopyOnWriteRoaringBitmap
extends MutableRoaringBitmap

A MutableRoaringBitmap that implements copy-on-write semantics for containers. This allows efficient sharing of memory-mapped containers until they need to be modified.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.roaringbitmap.ImmutableBitmapDataProvider

ImmutableBitmapDataProvider.RoaringOfInt

Constructor Summary

Constructors

Constructor	Description
CopyOnWriteRoaringBitmap()	Create a new copy-on-write bitmap.

Method Summary

Modifier and Type	Method	Description
void	add(int x)	Add the value to the container (set the value to "true"), whether it already appears or not.
void	and(ImmutableRoaringBitmap x2)	In-place bitwise AND (intersection) operation.
void	andNot(ImmutableRoaringBitmap x2)	In-place bitwise ANDNOT (difference) operation.
CopyOnWriteRoaringBitmap	clone()
void	flip(int x)	Add the value if it is not already present, otherwise remove it.
static CopyOnWriteRoaringBitmap	fromImmutable(ImmutableRoaringBitmap immutable)	Create a copy-on-write bitmap from an immutable bitmap.
void	or(ImmutableRoaringBitmap x2)	In-place bitwise OR (union) operation.
void	remove(int x)	If present remove the specified integers (effectively, sets its bit value to false)
void	xor(ImmutableRoaringBitmap x2)	In-place bitwise XOR (symmetric difference) operation.

Methods inherited from class org.roaringbitmap.buffer.MutableRoaringBitmap

add, add, add, add, add, addN, addOffset, and, andNot, append, bitmapOf, bitmapOfRange, checkedAdd, checkedRemove, clear, deserialize, deserialize, flip, flip, flip, flip, getMappeableRoaringArray, iterator, lazyor, lazyorfromlazyinputs, maximumSerializedSize, naivelazyor, or, or, orNot, rangeSanityCheck, readExternal, remove, remove, remove, remove, removeRunCompression, repairAfterLazy, runOptimize, toImmutableRoaringBitmap, trim, writeExternal, xor

Methods inherited from class org.roaringbitmap.buffer.ImmutableRoaringBitmap

and, and, and, andCardinality, andNot, andNot, andNot, andNotCardinality, cardinalityExceeds, contains, contains, contains, equals, first, firstSigned, flip, flip, forEach, getBatchIterator, getCardinality, getContainerCount, getContainerPointer, getIntIterator, getLongCardinality, getLongSizeInBytes, getReverseIntIterator, getSignedIntIterator, getSizeInBytes, hashCode, hasRunCompression, intersects, intersects, isEmpty, isHammingSimilar, last, lastSigned, lazyor, limit, nextAbsentValue, nextValue, or, or, or, or, orCardinality, orNot, previousAbsentValue, previousValue, rangeCardinality, rank, rankLong, select, selectRange, serialize, serialize, serializedSizeInBytes, toArray, toMutableRoaringBitmap, toMutableRoaringBitmapCopyOnWrite, toRoaringBitmap, toString, validate, xor, xor, xor, xorCardinality

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.roaringbitmap.ImmutableBitmapDataProvider

contains, first, firstSigned, forEach, getBatchIterator, getCardinality, getContainerCount, getIntIterator, getLongCardinality, getLongSizeInBytes, getReverseIntIterator, getSignedIntIterator, getSizeInBytes, isEmpty, last, lastSigned, limit, nextAbsentValue, nextValue, previousAbsentValue, previousValue, rangeCardinality, rank, rankLong, reverseStream, select, serialize, serialize, serializedSizeInBytes, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

CopyOnWriteRoaringBitmap

public CopyOnWriteRoaringBitmap()

Create a new copy-on-write bitmap.

Method Details

fromImmutable

public static CopyOnWriteRoaringBitmap fromImmutable(ImmutableRoaringBitmap immutable)

Create a copy-on-write bitmap from an immutable bitmap.

add

public void add(int x)

Description copied from class: MutableRoaringBitmap

Add the value to the container (set the value to "true"), whether it already appears or not. Java lacks native unsigned integers but the x argument is considered to be unsigned. Within bitmaps, numbers are ordered according toInteger.compareUnsigned(int, int). We order the numbers like 0, 1, ..., 2147483647, -2147483648, -2147483647,..., -1.

Specified by:

add in interface BitmapDataProvider

Overrides:

add in class MutableRoaringBitmap

Parameters:

x - integer value

remove

public void remove(int x)

Description copied from class: MutableRoaringBitmap

If present remove the specified integers (effectively, sets its bit value to false)

Specified by:

remove in interface BitmapDataProvider

Overrides:

remove in class MutableRoaringBitmap

Parameters:

x - integer value representing the index in a bitmap

flip

public void flip(int x)

Description copied from class: MutableRoaringBitmap

Add the value if it is not already present, otherwise remove it.

Overrides:

flip in class MutableRoaringBitmap

Parameters:

x - integer value

or

public void or(ImmutableRoaringBitmap x2)

Description copied from class: MutableRoaringBitmap

In-place bitwise OR (union) operation. The current bitmap is modified.

Overrides:

or in class MutableRoaringBitmap

Parameters:

x2 - other bitmap

and

public void and(ImmutableRoaringBitmap x2)

Description copied from class: MutableRoaringBitmap

In-place bitwise AND (intersection) operation. The current bitmap is modified.

Overrides:

and in class MutableRoaringBitmap

Parameters:

x2 - other bitmap

xor

public void xor(ImmutableRoaringBitmap x2)

Description copied from class: MutableRoaringBitmap

In-place bitwise XOR (symmetric difference) operation. The current bitmap is modified.

Overrides:

xor in class MutableRoaringBitmap

Parameters:

x2 - other bitmap

andNot

public void andNot(ImmutableRoaringBitmap x2)

Description copied from class: MutableRoaringBitmap

In-place bitwise ANDNOT (difference) operation. The current bitmap is modified.

Overrides:

andNot in class MutableRoaringBitmap

Parameters:

x2 - other bitmap

clone

public CopyOnWriteRoaringBitmap clone()

Overrides:

clone in class MutableRoaringBitmap