io.nem.core.math

Class SparseBitmap

java.lang.Object

io.nem.core.math.SparseBitmap

All Implemented Interfaces:

java.lang.Iterable<java.lang.Integer>

public class SparseBitmap
extends java.lang.Object
implements java.lang.Iterable<java.lang.Integer>

This is a wrapper for the EWAHCompressedBitmap.

Method Summary

Modifier and Type	Method and Description
SparseBitmap	and(SparseBitmap rhs) Computes the logical and of the context bitmap (this) and the given bitmap.
int	andCardinality(SparseBitmap rhs) Size of the intersection of this bitmap and the given bitmap.
SparseBitmap	andNot(SparseBitmap rhs) Computes the logical and not of the context bitmap (this) and the given bitmap.
static SparseBitmap	batchOr(SparseBitmap... bitmaps) Creates a new SparseBitmap that is the logical or of all the given bitmaps.
int	cardinality() The number of bits that are set.
void	clear() Clears all the bits in this sparse bitmap.
static SparseBitmap	createEmpty() Creates a new SparseBitmap that is empty.
static SparseBitmap	createFromSortedData(int... bitsToSet) Creates a new SparseBitmap from data that are already sorted in strictly ascending order (duplicate values are okay).
static SparseBitmap	createFromUnsortedData(int... bitsToSet) Creates a new SparseBitmap from unsorted data.
boolean	equals(java.lang.Object obj)
boolean	get(int bitToGet) Gets the value of the bit at the given index.
int	getHighestBit() Gets the highest bit that is set in the bitmap.
int	hashCode()
java.util.Iterator<java.lang.Integer>	iterator()
SparseBitmap	or(SparseBitmap rhs) Computes the logical or of the context bitmap (this) and the given bitmap.
void	set(int bitToSet) Set the bit at the given index.
void	setWithoutAscendingCheck(int bitToSet) For speed, this method sets bits at the given index, without checking that the bits are set in strictly ascending order.
java.util.List<java.lang.Integer>	toList() Creates a binary list representation of this sparse bitmap.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

createEmpty

public static SparseBitmap createEmpty()

Creates a new SparseBitmap that is empty.

Returns:

A new SparseBitmap that is empty (no bits set).

createFromSortedData

public static SparseBitmap createFromSortedData(int... bitsToSet)

Creates a new SparseBitmap from data that are already sorted in strictly ascending order (duplicate values are okay).

Parameters:

bitsToSet - The bits to set.

Returns:

A new SparseBitmap with the given bits set.

createFromUnsortedData

public static SparseBitmap createFromUnsortedData(int... bitsToSet)

Creates a new SparseBitmap from unsorted data.

Parameters:

bitsToSet - The bits to set.

Returns:

A new SparseBitmap with the given bits set.

batchOr

public static SparseBitmap batchOr(SparseBitmap... bitmaps)

Creates a new SparseBitmap that is the logical or of all the given bitmaps.

Parameters:

bitmaps - Bitmaps to compute the logical or for

Returns:

SparseBitmap that has the values set according to the or of the given bitmaps.

get

public boolean get(int bitToGet)

Gets the value of the bit at the given index.

Parameters:

bitToGet - The index of the bit to get.

Returns:

true if the bit is set, false if the bit is not set at the given bitToGet index.

setWithoutAscendingCheck

public void setWithoutAscendingCheck(int bitToSet)

For speed, this method sets bits at the given index, without checking that the bits are set in strictly ascending order. If the bits are not in ascending order, performance could be adversely affected.

Parameters:

bitToSet - index of the bit to set

set

public void set(int bitToSet)

Set the bit at the given index. Throws an exception if bits are not set in strictly ascending order. For performance reasons, bits must be set in ascending order.

Parameters:

bitToSet - The index of the bit to set.

clear

public void clear()

Clears all the bits in this sparse bitmap.

or

public SparseBitmap or(SparseBitmap rhs)

Computes the logical or of the context bitmap (this) and the given bitmap.

Parameters:

rhs - Bitmap to compute the logical or with.

Returns:

Logical or of this bitmap (context object) and the given bitmap.

and

public SparseBitmap and(SparseBitmap rhs)

Computes the logical and of the context bitmap (this) and the given bitmap.

Parameters:

rhs - Bitmap to compute the logical and with.

Returns:

Logical and of this bitmap (context object) and the given bitmap.

andNot

public SparseBitmap andNot(SparseBitmap rhs)

Computes the logical and not of the context bitmap (this) and the given bitmap.

Parameters:

rhs - Bitmap to compute the logical and not with.

Returns:

Logical and not of this bitmap (context object) and the given bitmap.

getHighestBit

public int getHighestBit()

Gets the highest bit that is set in the bitmap.

Returns:

The highest bit.

andCardinality

public int andCardinality(SparseBitmap rhs)

Size of the intersection of this bitmap and the given bitmap.

Parameters:

rhs - given sparse bitmap to compute the size of the intersection of

Returns:

size of the intersection of this bitmap and the given bitmap.

cardinality

public int cardinality()

The number of bits that are set.

Returns:

The number of bits that are set.

toList

public java.util.List<java.lang.Integer> toList()

Creates a binary list representation of this sparse bitmap.

Returns:

List representation of this sparse bitmap.

iterator

public java.util.Iterator<java.lang.Integer> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Integer>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object