BitmapOfLong

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

All Implemented Interfaces:

Bitmap, java.lang.Comparable<Bitmap>
```
public class BitmapOfLong
extends AbstractBitmap
```
This class encodes edges in a space efficient fashion, with the limitation that it can only encode up to 64 bits. Assume N is the number of nodes in an undirected graph. The complete graph with N nodes has N(N-1)/2 edges. Hence, this class can encode all graphs with N = 1..11 (using an upper triangle encoding). NAUTY, the most efficient graph enumeration program as of today (May, 2009) can enumerate graphs with non-isomorphs for N = 11 in 12 minutes (in an INTEL CORE2 DUO T9400 2.53GHz with 4GB RAM) but in approximately 33h for N = 12. Further, for N=12, the maximum number of edges is 66, hence, we cannot use this class to encode the graphs anyway. This is a rather convenient coincidence.

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
Modifier	Constructor	Description
`protected`	`BitmapOfLong()`
	`BitmapOfLong(byte[] byteBitmap)`
	`BitmapOfLong(int bitSize)`
	`BitmapOfLong(int bitSize, boolean isSet)`
	`BitmapOfLong(Bitmap other)`
	`BitmapOfLong(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)`	TIME = O(1) for a compatible instance of other.
`int`	`bitSize()`	Returns the length in bits of the bitmap.
`void`	`clearBit(int bitIndex)`	The highest order bit is at bit 0 of bitmap, and the lowest order bit is at bit bitSize() - 1 of bitmap.
`int`	`compareTo(Bitmap other)`
`protected void`	`copyFrom(Bitmap other)`	TIME = O(1).
`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)`	TIME = O(1) for an instance of BitmapOfLong.
`int`	`hashCode()`	TIME = O(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()`	Returns a bitmask corresponding to the valid bits of the long with the given index.
`void`	`nand(Bitmap other)`	TIME = O(1) for a compatible instance.
`void`	`not()`	TIME = O(1).
`void`	`or(Bitmap other)`	TIME = O(1) for a compatible instance.
`void`	`setBit(int bitIndex)`	The highest order bit is at bit 0 of bitmap, and the lowest order bit is at bit bitSize() - 1 of bitmap.
`void`	`setBits(boolean value)`	TIME = O(1).
`protected void`	`setBitSize(int bitSize)`
`boolean`	`testBit(int bitIndex)`	TIME = O(1).
`void`	`xor(Bitmap other)`	TIME = O(1) for a compatible instance.

Methods inherited from class etomica.graph.model.impl.AbstractBitmap
bitCount, comparableInstance, 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
  - BitmapOfLong
```
public BitmapOfLong(Bitmap other)
```
  - BitmapOfLong
```
public BitmapOfLong(int bitSize)
```
  - BitmapOfLong
```
public BitmapOfLong(int bitSize,
                    boolean isSet)
```
  - BitmapOfLong
```
public BitmapOfLong(java.lang.String strBitmap)
```
  - BitmapOfLong
```
public BitmapOfLong(byte[] byteBitmap)
```
  - BitmapOfLong
```
protected BitmapOfLong()
```
- Method Detail
  - and
```
public void and(Bitmap other)
```
    TIME = O(1) for a compatible instance of other.
    
    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, and the lowest order bit is at bit bitSize() - 1 of bitmap. TIME = O(1).
  - compareTo
```
public int compareTo(Bitmap other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Bitmap>
    
    Overrides:
    
    compareTo in class AbstractBitmap
  - equals
```
public boolean equals(java.lang.Object other)
```
    TIME = O(1) for an instance of BitmapOfLong.
    
    Overrides:
    
    equals in class AbstractBitmap
  - hashCode
```
public int hashCode()
```
    TIME = O(1).
    
    Overrides:
    
    hashCode in class java.lang.Object
  - nand
```
public void nand(Bitmap other)
```
    TIME = O(1) for a compatible instance.
    
    Specified by:
    
    nand in interface Bitmap
    
    Overrides:
    
    nand in class AbstractBitmap
  - not
```
public void not()
```
    TIME = O(1).
    
    Specified by:
    
    not in interface Bitmap
    
    Overrides:
    
    not in class AbstractBitmap
  - or
```
public void or(Bitmap other)
```
    TIME = O(1) for a compatible instance.
    
    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, and the lowest order bit is at bit bitSize() - 1 of bitmap. TIME = O(1).
  - setBits
```
public void setBits(boolean value)
```
    TIME = O(1).
    
    Specified by:
    
    setBits in interface Bitmap
    
    Overrides:
    
    setBits in class AbstractBitmap
  - testBit
```
public boolean testBit(int bitIndex)
```
    TIME = O(1).
  - xor
```
public void xor(Bitmap other)
```
    TIME = O(1) for a compatible instance.
    
    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
  - copyFrom
```
protected void copyFrom(Bitmap other)
```
    TIME = O(1).
    
    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
  - maskSingleBit
```
protected long maskSingleBit(int bitIndex)
```
    Returns a long with a single bit set, corresponding to the bit offset of the given bit index. TIME = O(1).
  - maskSingleLong
```
protected long maskSingleLong()
```
    Returns a bitmask corresponding to the valid bits of the long with the given index. TIME = O(1).
  - setBitSize
```
protected void setBitSize(int bitSize)
```

Class BitmapOfLong

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

BitmapOfLong

BitmapOfLong

BitmapOfLong

BitmapOfLong

BitmapOfLong

BitmapOfLong

Method Detail

and

bitSize

clearBit

compareTo

equals

hashCode

nand

not

or

setBit

setBits

testBit

xor

allocateBitmap

copyFrom

createInstance

createInstance

maskSingleBit

maskSingleLong

setBitSize