BitmapOfLongVector

java.lang.Object
- etomica.graph.model.impl.AbstractBitmap
- - etomica.graph.model.impl.BitmapOfLongVector

All Implemented Interfaces:

Bitmap, java.lang.Comparable<Bitmap>
```
public final class BitmapOfLongVector
extends AbstractBitmap
```
Transparent implementation of arbitrarily large bitmaps based on an array of long values.

Field Summary
- Fields inherited from interface etomica.graph.model.Bitmap
  CH_ONE, CH_ZERO, LONG_MASK, LONG_ONE, LONG_ZERO, SZ_LONG

Constructor Summary

Constructors
Constructor	Description
`BitmapOfLongVector(byte[] byteBitmap)`
`BitmapOfLongVector(int bitSize)`
`BitmapOfLongVector(int bitSize, boolean isSet)`
`BitmapOfLongVector(Bitmap other)`
`BitmapOfLongVector(java.lang.String strBitmap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`allocateBitmap()`	Allocates the storage space for bitSize() bits.
`void`	`and(Bitmap other)`	and: bitmap -> bitmap = (bitmap & other).
`protected int`	`bitCount(int longIndex)`	Returns the number of valid bits in the long with the given index.
`protected int`	`bitOffset(int bitIndex)`	The highest order bit is at bit 0 of bitmap[0], and the lowest order bit is at bit bitSize() - 1 of bitmap[size()-1].
`int`	`bitSize()`	Returns the length in bits of the bitmap.
`void`	`clearBit(int bitIndex)`	The highest order bit is at bit 0 of bitmap[0], and the lowest order bit is at bit bitSize() - 1 of bitmap[size()-1].
`protected void`	`copyFrom(Bitmap other)`
`protected Bitmap`	`createInstance(int bitSize)`
`protected Bitmap`	`createInstance(Bitmap other)`	Creates an instance of the implementing class based on the given parameters.
`boolean`	`equals(java.lang.Object other)`
`int`	`hashCode()`
`protected int`	`longOffset(int bitIndex)`	The highest order bit is at bit 0 of bitmap[0], and the lowest order bit is at bit bitSize() - 1 of bitmap[size()-1].
`protected long`	`maskSingleBit(int bitIndex)`	Returns a long with a single bit set, corresponding to the bit offset of the given bit index.
`protected long`	`maskSingleLong(int longIndex)`	Returns a bitmask corresponding to the valid bits of the long with the given index.
`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)`	The highest order bit is at bit 0 of bitmap[0], and the lowest order bit is at bit bitSize() - 1 of bitmap[size()-1].
`void`	`setBits(boolean value)`
`protected void`	`setBitSize(int bitSize)`
`protected int`	`size()`
`boolean`	`testBit(int bitIndex)`
`void`	`xor(Bitmap other)`	Updates this bitmap with the result of the bitwise AND with the other bitmap: bitmap = (bitmap ^ other).

Methods inherited from class etomica.graph.model.impl.AbstractBitmap
bitCount, comparableInstance, compareTo, copy, copyFrom, copyFrom, copyHighest, copyLowest, dec, defBit, flipBit, hsb, hub, inc, lsb, lub, toNumberString, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BitmapOfLongVector
```
public BitmapOfLongVector(Bitmap other)
```
  - BitmapOfLongVector
```
public BitmapOfLongVector(int bitSize)
```
  - BitmapOfLongVector
```
public BitmapOfLongVector(int bitSize,
                          boolean isSet)
```
  - BitmapOfLongVector
```
public BitmapOfLongVector(java.lang.String strBitmap)
```
  - BitmapOfLongVector
```
public BitmapOfLongVector(byte[] byteBitmap)
```
- Method Detail
  - and
```
public void and(Bitmap other)
```
    Description copied from interface: Bitmap
    
    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.
    
    Specified by:
    
    and in interface Bitmap
    
    Overrides:
    
    and in class AbstractBitmap
  - bitSize
```
public int bitSize()
```
    Description copied from interface: Bitmap
    
    Returns the length in bits of the bitmap.
  - clearBit
```
public void clearBit(int bitIndex)
```
    The highest order bit is at bit 0 of bitmap[0], and the lowest order bit is at bit bitSize() - 1 of bitmap[size()-1].
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class AbstractBitmap
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - nand
```
public void nand(Bitmap other)
```
    Description copied from interface: Bitmap
    
    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.
    
    Specified by:
    
    nand in interface Bitmap
    
    Overrides:
    
    nand in class AbstractBitmap
  - not
```
public void not()
```
    Description copied from interface: Bitmap
    
    Inverts the bits of this bitmap: bitmap = ~bitmap.
    
    Specified by:
    
    not in interface Bitmap
    
    Overrides:
    
    not in class AbstractBitmap
  - or
```
public void or(Bitmap other)
```
    Description copied from interface: Bitmap
    
    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.
    
    Specified by:
    
    or in interface Bitmap
    
    Overrides:
    
    or in class AbstractBitmap
  - setBit
```
public void setBit(int bitIndex)
```
    The highest order bit is at bit 0 of bitmap[0], and the lowest order bit is at bit bitSize() - 1 of bitmap[size()-1].
  - setBits
```
public void setBits(boolean value)
```
    Specified by:
    
    setBits in interface Bitmap
    
    Overrides:
    
    setBits in class AbstractBitmap
  - testBit
```
public boolean testBit(int bitIndex)
```
  - xor
```
public void xor(Bitmap other)
```
    Description copied from interface: Bitmap
    
    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.
    
    Specified by:
    
    xor in interface Bitmap
    
    Overrides:
    
    xor in class AbstractBitmap
  - allocateBitmap
```
protected void allocateBitmap()
```
    Description copied from class: AbstractBitmap
    
    Allocates the storage space for bitSize() bits.
    
    Specified by:
    
    allocateBitmap in class AbstractBitmap
  - bitCount
```
protected int bitCount(int longIndex)
```
    Returns the number of valid bits in the long with the given index.
  - bitOffset
```
protected int bitOffset(int bitIndex)
```
    The highest order bit is at bit 0 of bitmap[0], and the lowest order bit is at bit bitSize() - 1 of bitmap[size()-1].
  - copyFrom
```
protected void copyFrom(Bitmap other)
```
    Overrides:
    
    copyFrom in class AbstractBitmap
  - createInstance
```
protected Bitmap createInstance(Bitmap other)
```
    Description copied from class: AbstractBitmap
    
    Creates an instance of the implementing class based on the given parameters.
    
    Overrides:
    
    createInstance in class AbstractBitmap
  - createInstance
```
protected Bitmap createInstance(int bitSize)
```
    Overrides:
    
    createInstance in class AbstractBitmap
  - longOffset
```
protected int longOffset(int bitIndex)
```
    The highest order bit is at bit 0 of bitmap[0], and the lowest order bit is at bit bitSize() - 1 of bitmap[size()-1].
  - maskSingleBit
```
protected long maskSingleBit(int bitIndex)
```
    Returns a long with a single bit set, corresponding to the bit offset of the given bit index.
  - maskSingleLong
```
protected long maskSingleLong(int longIndex)
```
    Returns a bitmask corresponding to the valid bits of the long with the given index.
  - size
```
protected int size()
```
    Returns:
    
    number of long values held by the bitmap
  - setBitSize
```
protected void setBitSize(int bitSize)
```

Class BitmapOfLongVector

Field Summary

Fields inherited from interface etomica.graph.model.Bitmap

Constructor Summary

Method Summary

Methods inherited from class etomica.graph.model.impl.AbstractBitmap

Methods inherited from class java.lang.Object

Constructor Detail

BitmapOfLongVector

BitmapOfLongVector

BitmapOfLongVector

BitmapOfLongVector

BitmapOfLongVector

Method Detail

and

bitSize

clearBit

equals

hashCode

nand

not

or

setBit

setBits

testBit

xor

allocateBitmap

bitCount

bitOffset

copyFrom

createInstance

createInstance

longOffset

maskSingleBit

maskSingleLong

size

setBitSize