Bitmap

All Superinterfaces:

java.lang.Comparable<Bitmap>

All Known Implementing Classes:

AbstractBitmap, BitmapOfLong, BitmapOfLongVector
```
public interface Bitmap
extends java.lang.Comparable<Bitmap>
```
Abstracts away the form in which bitmaps implement their operations and store their data.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`CH_ONE`
`static char`	`CH_ZERO`
`static long`	`LONG_MASK`
`static long`	`LONG_ONE`
`static long`	`LONG_ZERO`
`static byte`	`SZ_LONG`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`and(Bitmap other)`	and: bitmap -> bitmap = (bitmap & other).
`int`	`bitCount()`	Returns the number of bits set in the bitmap.
`int`	`bitSize()`	Returns the length in bits of the bitmap.
`void`	`clearBit(int bitIndex)`
`Bitmap`	`comparableInstance(Bitmap other)`	Returns a bitmap instance with the same number of bits as this bitmap.
`Bitmap`	`copy()`	Creates an instance-compatible copy of this bitmap.
`Bitmap`	`copyHighest(int numBits)`	Creates an instance-compatible copy of highest numBits bits of this bitmap.
`Bitmap`	`copyLowest(int numBits)`	Creates an instance-compatible copy of lowest numBits bits of this bitmap.
`void`	`dec()`	Decrements the integer value of this bitmap by one: bitmap--.
`void`	`defBit(int bitIndex, boolean value)`
`void`	`flipBit(int bitIndex)`
`int`	`hsb()`
`int`	`hub()`
`void`	`inc()`	Increments the integer value of this bitmap by one: bitmap++.
`int`	`lsb()`
`int`	`lub()`
`void`	`nand(Bitmap other)`	Updates this bitmap with the result of the bitwise AND with the other bitmap: bitmap = ~(bitmap & other).
`void`	`not()`	Inverts the bits of this bitmap: bitmap = ~bitmap.
`void`	`or(Bitmap other)`	Updates this bitmap with the result of the bitwise AND with the other bitmap: bitmap = (bitmap \| other).
`void`	`setBit(int bitIndex)`
`void`	`setBits(boolean value)`
`boolean`	`testBit(int bitIndex)`
`java.lang.String`	`toNumberString()`	Returns a string for the integer represented by this bitmap
`void`	`xor(Bitmap other)`	Updates this bitmap with the result of the bitwise AND with the other bitmap: bitmap = (bitmap ^ other).

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - CH_ONE
```
static final char CH_ONE
```
    See Also:
    
    Constant Field Values
  - CH_ZERO
```
static final char CH_ZERO
```
    See Also:
    
    Constant Field Values
  - LONG_MASK
```
static final long LONG_MASK
```
    See Also:
    
    Constant Field Values
  - LONG_ONE
```
static final long LONG_ONE
```
    See Also:
    
    Constant Field Values
  - LONG_ZERO
```
static final long LONG_ZERO
```
    See Also:
    
    Constant Field Values
  - SZ_LONG
```
static final byte SZ_LONG
```
    See Also:
    
    Constant Field Values
- Method Detail
  - and
```
void and(Bitmap other)
```
    and: bitmap -> bitmap = (bitmap & other). Assumes the bit length of the other bitmap is AT LEAST as large as the bit length of this bitmap.
  - bitCount
```
int bitCount()
```
    Returns the number of bits set in the bitmap.
  - bitSize
```
int bitSize()
```
    Returns the length in bits of the bitmap.
  - clearBit
```
void clearBit(int bitIndex)
```
  - comparableInstance
```
Bitmap comparableInstance(Bitmap other)
```
    Returns a bitmap instance with the same number of bits as this bitmap. If other has fewer bits than this bitmap, the output bitmap is 0-padded and has the same integer value as other. If other has more bits than this bitmap, the output bitmap is the result of truncating the highest bits of other.
    
    Returns:
    
    copy of the this bitmap
  - copy
```
Bitmap copy()
```
    Creates an instance-compatible copy of this bitmap. This bitmap and the returned bitmap are both instances of the same class.
    
    Returns:
    
    copy of the this bitmap
  - copyHighest
```
Bitmap copyHighest(int numBits)
```
    Creates an instance-compatible copy of highest numBits bits of this bitmap. This bitmap and the returned bitmap are both instances of the same class.
    
    Returns:
    
    copy of the this bitmap
  - copyLowest
```
Bitmap copyLowest(int numBits)
```
    Creates an instance-compatible copy of lowest numBits bits of this bitmap. This bitmap and the returned bitmap are both instances of the same class.
    
    Returns:
    
    copy of the this bitmap
  - dec
```
void dec()
```
    Decrements the integer value of this bitmap by one: bitmap--.
  - defBit
```
void defBit(int bitIndex,
            boolean value)
```
  - flipBit
```
void flipBit(int bitIndex)
```
  - hsb
```
int hsb()
```
  - hub
```
int hub()
```
  - inc
```
void inc()
```
    Increments the integer value of this bitmap by one: bitmap++.
  - lsb
```
int lsb()
```
  - lub
```
int lub()
```
  - nand
```
void nand(Bitmap other)
```
    Updates this bitmap with the result of the bitwise AND with the other bitmap: bitmap = ~(bitmap & other). Assumes the bit length of the other bitmap is AT LEAST as large as the bit length of this bitmap.
  - not
```
void not()
```
    Inverts the bits of this bitmap: bitmap = ~bitmap.
  - or
```
void or(Bitmap other)
```
    Updates this bitmap with the result of the bitwise AND with the other bitmap: bitmap = (bitmap | other). Assumes the bit length of the other bitmap is AT LEAST as large as the bit length of this bitmap.
  - setBit
```
void setBit(int bitIndex)
```
  - setBits
```
void setBits(boolean value)
```
  - testBit
```
boolean testBit(int bitIndex)
```
  - xor
```
void xor(Bitmap other)
```
    Updates this bitmap with the result of the bitwise AND with the other bitmap: bitmap = (bitmap ^ other). Assumes the bit length of the other bitmap is AT LEAST as large as the bit length of this bitmap.
  - toNumberString
```
java.lang.String toNumberString()
```
    Returns a string for the integer represented by this bitmap

Interface Bitmap

Field Summary

Method Summary

Methods inherited from interface java.lang.Comparable

Field Detail

CH_ONE

CH_ZERO

LONG_MASK

LONG_ONE

LONG_ZERO

SZ_LONG

Method Detail

and

bitCount

bitSize

clearBit

comparableInstance

copy

copyHighest

copyLowest

dec

defBit

flipBit

hsb

hub

inc

lsb

lub

nand

not

or

setBit

setBits

testBit

xor

toNumberString