# Class: com.pnfsoftware.jeb.util.collect.Bitmap

A fast, efficient bitmap making optimal use of memory.  

 Implementation note: this bitmap works optimally on 64\-bit systems.

## Constructor: Bitmap
- parameter: `bitsize`, type: `int`

Description: Create a bitmap.
parameter: bitsize: number of bits

## Method: addAllFrom
- parameter: `other`, type: `com.pnfsoftware.jeb.util.collect.Bitmap`

Description: Add the values of a source bitmap into this bitmap. Both bitmaps must have the same size.
parameter: other: source bitmap

## Method: clear

Description: Clear the bitmap to all false.

## Method: clone
- return type: `com.pnfsoftware.jeb.util.collect.Bitmap`


## Method: countOnes
- return type: `int`

Description: Count the number of true values in the bitmap.
return: number of set bits

## Method: countZeros
- return type: `int`

Description: Count the number of false values in the bitmap.
return: number of unset bits

## Method: equals
- parameter: `obj`, type: `java.lang.Object`
- return type: `boolean`


## Method: formatAsRanges
- return type: `java.lang.String`

Description: Format set bits as inclusive/exclusive ranges.
return: formatted ranges

## Method: formatAsRanges
- parameter: `useExcludedEnds`, type: `boolean`
- return type: `java.lang.String`

Description: Format set bits as ranges.
parameter: useExcludedEnds: true to format ranges as `[begin,end)`; false to use inclusive            end indices
return: formatted ranges

## Method: get
- parameter: `i`, type: `int`
- return type: `boolean`

Description: Retrieve the value of a bit.
parameter: i: zero\-based index
return: the current bit value

## Method: hashCode
- return type: `int`


## Method: isEmpty
- return type: `boolean`

Description: Determine whether all entries in the bitmap are set to false.
return: true if all bits are unset

## Method: isFull
- return type: `boolean`

Description: Determine whether all entries in the bitmap are set to true.
return: true if all bits are set

## Method: ones
- return type: `java.util.List<java.lang.Integer>`

Description: Generate a list of zero\-based indices for the bitmap entry is true.
return: a list of integers

## Method: removeAllFrom
- parameter: `other`, type: `com.pnfsoftware.jeb.util.collect.Bitmap`

Description: Remove the values of a source bitmap into this bitmap. Both bitmaps must have the same size.
parameter: other: source bitmap

## Method: reset
- parameter: `i`, type: `int`

Description: Fast reset a bit to false.
parameter: i: zero\-based index

## Method: set
- parameter: `i`, type: `int`
- parameter: `v`, type: `boolean`
- return type: `boolean`

Description: Set a bit to the provided value.
parameter: i: zero\-based index
parameter: v: value
return: true if the value was updated; false if it was unchanged

## Method: set
- parameter: `i`, type: `int`

Description: Fast set a bit to true.
parameter: i: zero\-based index

## Method: setRange
- parameter: `from`, type: `int`
- parameter: `to`, type: `int`

Description: Fast set multiple bits to true.
parameter: from: start zero\-based index \(inclusive\)
parameter: to: end zero\-based index \(exclusive\)

## Method: size
- return type: `int`

Description: Retrieve the map size.
return: number of bits

## Method: toString
- return type: `java.lang.String`


