Package com.qfs.bitmap

Interface IClearableBitmap

All Superinterfaces:

Cloneable, IBitmap, IClone<IBitmap>, Serializable

All Known Implementing Classes:

Bitmap, ChunkedBitmap

public interface IClearableBitmap
extends IBitmap

A bitmap which supports random writing and deleting.

Author:

ActiveViam

Method Summary

Modifier and Type	Method	Description
IClearableBitmap	and(IBitmap other)	Performs a logical AND operation between two bitmaps.
IClearableBitmap	andNot(IBitmap other)	Performs a logical AND NOT operation between two bitmaps.
void	bulkSet(IClearableBitmap bitmap)	Sets all the bits of the given bitmap in this bitmap.
void	clear(int index)	Clears the bit at the given position, i.e.
IClearableBitmap	clone()	This method is very similar to the one used by Object except that it returns the real class.
IClearableBitmap	or(IBitmap other)	Performs a logical OR operation between two bitmaps.
void	set(int index)	Sets the bit at a given position to true.
void	setRange(int first, int last)	Sets all the bits from first (included) to last (included) to true.
IClearableBitmap	xor(IBitmap other)	Performs a logical XOR operation between two bitmaps.

Methods inherited from interface com.qfs.bitmap.IBitmap

and, andNot, cardinality, clear, dataSizeInBytes, forEachBit, get, getIterator, getLast, isEmpty, not, or, sizeInBytes, stream, xor

Method Detail

set

void set(int index)

Sets the bit at a given position to true.

The bits can be set in random order.

Specified by:

set in interface IBitmap

Parameters:

index - the position of the bit to set

setRange

void setRange(int first,
              int last)

Sets all the bits from first (included) to last (included) to true.

Parameters:

first - the position of the first bit to set (included)

last - the position of the last bit to set (included)

clear

void clear(int index)

Clears the bit at the given position, i.e. sets it to false.

Parameters:

index - the position of the bit to clear

bulkSet

void bulkSet(IClearableBitmap bitmap)

Sets all the bits of the given bitmap in this bitmap. This is equivalent to a logical OR operation to this bitmap and the given other bitmap.

The bitmaps must have the same implementation.

Parameters:

bitmap - the bitmap

clone

IClearableBitmap clone()

Description copied from interface: IClone

This method is very similar to the one used by Object except that it returns the real class.

Specified by:

clone in interface IClone<IBitmap>

Returns:

a clone of the object

and

IClearableBitmap and(IBitmap other)

Description copied from interface: IBitmap

Performs a logical AND operation between two bitmaps.

Specified by:

and in interface IBitmap

Parameters:

other - other bitmap operand of the AND operator

Returns:

AND result bitmap

or

IClearableBitmap or(IBitmap other)

Description copied from interface: IBitmap

Performs a logical OR operation between two bitmaps.

Specified by:

or in interface IBitmap

Parameters:

other - other bitmap operand of the OR operator

Returns:

OR result bitmap

xor

IClearableBitmap xor(IBitmap other)

Description copied from interface: IBitmap

Performs a logical XOR operation between two bitmaps.

Specified by:

xor in interface IBitmap

Parameters:

other - other bitmap operand of the XOR operator

Returns:

OR result bitmap

andNot

IClearableBitmap andNot(IBitmap other)

Description copied from interface: IBitmap

Performs a logical AND NOT operation between two bitmaps.

Specified by:

andNot in interface IBitmap

Parameters:

other - other bitmap operand of the AND NOT operator

Returns:

OR result bitmap