AbstractBitmap

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

All Implemented Interfaces:

Bitmap, java.lang.Comparable<Bitmap>

Direct Known Subclasses:

BitmapOfLong, BitmapOfLongVector
```
public abstract class AbstractBitmap
extends java.lang.Object
implements Bitmap
```

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

AbstractBitmap()

Constructors
Constructor	Description
`AbstractBitmap()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract void`	`allocateBitmap()`	Allocates the storage space for bitSize() bits.
`void`	`and(Bitmap other)`	and: bitmap -> bitmap = (bitmap & other).
`int`	`bitCount()`	Returns the number of bits set in the bitmap.
`Bitmap`	`comparableInstance(Bitmap other)`	Returns a bitmap instance with the same number of bits as this bitmap.
`int`	`compareTo(Bitmap other)`
`Bitmap`	`copy()`	Creates an instance-compatible copy of this bitmap.
`protected void`	`copyFrom(byte[] byteBitmap)`
`protected void`	`copyFrom(Bitmap other)`
`protected void`	`copyFrom(java.lang.String strBitmap)`
`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.
`protected Bitmap`	`createInstance(int capacity)`
`protected Bitmap`	`createInstance(Bitmap other)`	Creates an instance of the implementing class based on the given parameters.
`void`	`dec()`	Decrements the integer value of this bitmap by one: bitmap--.
`void`	`defBit(int bitIndex, boolean bitValue)`
`boolean`	`equals(java.lang.Object other)`
`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`	`setBits(boolean value)`
`java.lang.String`	`toNumberString()`	Returns a string for the integer represented by this bitmap
`java.lang.String`	`toString()`
`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 etomica.graph.model.Bitmap
bitSize, clearBit, setBit, testBit

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

- Constructor Detail
  - AbstractBitmap
```
public AbstractBitmap()
```
- 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
  - bitCount
```
public int bitCount()
```
    Description copied from interface: Bitmap
    
    Returns the number of bits set in the bitmap.
    
    Specified by:
    
    bitCount in interface Bitmap
  - comparableInstance
```
public Bitmap comparableInstance(Bitmap other)
```
    Description copied from interface: Bitmap
    
    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.
    
    Specified by:
    
    comparableInstance in interface Bitmap
    
    Returns:
    
    copy of the this bitmap
  - compareTo
```
public int compareTo(Bitmap other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Bitmap>
  - copy
```
public Bitmap copy()
```
    Description copied from interface: Bitmap
    
    Creates an instance-compatible copy of this bitmap. This bitmap and the returned bitmap are both instances of the same class.
    
    Specified by:
    
    copy in interface Bitmap
    
    Returns:
    
    copy of the this bitmap
  - copyHighest
```
public Bitmap copyHighest(int numBits)
```
    Description copied from interface: Bitmap
    
    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.
    
    Specified by:
    
    copyHighest in interface Bitmap
    
    Returns:
    
    copy of the this bitmap
  - copyLowest
```
public Bitmap copyLowest(int numBits)
```
    Description copied from interface: Bitmap
    
    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.
    
    Specified by:
    
    copyLowest in interface Bitmap
    
    Returns:
    
    copy of the this bitmap
  - dec
```
public void dec()
```
    Description copied from interface: Bitmap
    
    Decrements the integer value of this bitmap by one: bitmap--.
    
    Specified by:
    
    dec in interface Bitmap
  - defBit
```
public void defBit(int bitIndex,
                   boolean bitValue)
```
    Specified by:
    
    defBit in interface Bitmap
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object
  - flipBit
```
public void flipBit(int bitIndex)
```
    Specified by:
    
    flipBit in interface Bitmap
  - hsb
```
public int hsb()
```
    Specified by:
    
    hsb in interface Bitmap
  - hub
```
public int hub()
```
    Specified by:
    
    hub in interface Bitmap
  - inc
```
public void inc()
```
    Description copied from interface: Bitmap
    
    Increments the integer value of this bitmap by one: bitmap++.
    
    Specified by:
    
    inc in interface Bitmap
  - lsb
```
public int lsb()
```
    Specified by:
    
    lsb in interface Bitmap
  - lub
```
public int lub()
```
    Specified by:
    
    lub in interface Bitmap
  - 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
  - not
```
public void not()
```
    Description copied from interface: Bitmap
    
    Inverts the bits of this bitmap: bitmap = ~bitmap.
    
    Specified by:
    
    not in interface Bitmap
  - 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
  - setBits
```
public void setBits(boolean value)
```
    Specified by:
    
    setBits in interface Bitmap
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - 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
  - allocateBitmap
```
protected abstract void allocateBitmap()
```
    Allocates the storage space for bitSize() bits.
  - copyFrom
```
protected void copyFrom(Bitmap other)
```
  - copyFrom
```
protected void copyFrom(java.lang.String strBitmap)
```
  - copyFrom
```
protected void copyFrom(byte[] byteBitmap)
```
  - createInstance
```
protected Bitmap createInstance(Bitmap other)
```
    Creates an instance of the implementing class based on the given parameters.
  - createInstance
```
protected Bitmap createInstance(int capacity)
```
  - toNumberString
```
public java.lang.String toNumberString()
```
    Description copied from interface: Bitmap
    
    Returns a string for the integer represented by this bitmap
    
    Specified by:
    
    toNumberString in interface Bitmap

Class AbstractBitmap

Field Summary

Fields inherited from interface etomica.graph.model.Bitmap

Constructor Summary

Method Summary

Methods inherited from interface etomica.graph.model.Bitmap

Methods inherited from class java.lang.Object

Constructor Detail

AbstractBitmap

Method Detail

and

bitCount

comparableInstance

compareTo

copy

copyHighest

copyLowest

dec

defBit

equals

flipBit

hsb

hub

inc

lsb

lub

nand

not

or

setBits

toString

xor

allocateBitmap

copyFrom

copyFrom

copyFrom

createInstance

createInstance

toNumberString