BitVector

net.onedaybeard.bitvector.BitVector

```
public class BitVector
```
Performance optimized bitset implementation. Certain operations are prefixed with unsafe; these methods perform no validation.

Constructor Summary

Constructors
Constructor and Description

BitVector()

BitVector(BitVector copyFrom)
Creates a bit set based off another bit vector.

Constructors
Constructor and Description
`BitVector()`
`BitVector(BitVector copyFrom)` Creates a bit set based off another bit vector.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`and(BitVector other)` Performs a logical AND of this target bit set with the argument bit set. This bit set is modified so that each bit in it has the value true if and only if it both initially had the value true and the corresponding bit in the bit set argument also had the value true.
`void`	`andNot(BitVector other)` Clears all of the bits in this bit set whose corresponding bit is set in the specified bit set.
`int`	`cardinality()` Returns the count of `true` bits
`void`	`clear(int index)`
`void`	`clear()` Clears the entire bitset
`boolean`	`contains(BitVector other)` Returns true if this bit set is a super set of the specified set, i.e. it has all bits set to true that are also set to true in the specified BitVector.
`BitVector`	`copy()`
`void`	`ensureCapacity(int bits)` Grows the backing array so that it can hold the requested bits. Mostly applicable when relying on the `unsafe` methods, including `BitVector.unsafeGet` and `BitVector.unsafeClear`.
`boolean`	`equals(java.lang.Object obj)`
`void`	`flip(int index)`
`void`	`forEachBit(kotlin.jvm.functions.Function1<? super java.lang.Integer,kotlin.Unit> f)` Enumerates over all `true` bits sequeneially. This function performs better than forEach and any other functions from `Iterable`.
`boolean`	`get(int index)`
`int[]`	`getWords()` (can be manipulated directly)
`int`	`hashCode()`
`boolean`	`intersects(BitVector other)` Returns true if the specified BitVector has any bits set to true that are also set to true in this BitVector.
`boolean`	`isEmpty()`
`kotlin.collections.IntIterator`	`iterator()`
`int`	`length()` Returns the "logical size" of this bitset: the index of the highest set bit in the bitset plus one. Returns zero if the bitset contains no set bits.
`void`	`or(BitVector other)` Performs a logical OR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value `true` if and only if it either already had the value `true` or the corresponding bit in the bit set argument has the value `true`.
`void`	`set(int index)`
`void`	`set(int index, boolean value)`
`void`	`setWords(int[] p)` (can be manipulated directly)
`java.lang.String`	`toString()`
`void`	`unsafeClear(int index)`
`boolean`	`unsafeGet(int index)`
`void`	`unsafeSet(int index)`
`void`	`unsafeSet(int index, boolean value)`
`void`	`xor(BitVector other)` Performs a logical XOR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if one of the following statements holds:

- Constructor Detail
  - BitVector
```
public BitVector()
```
  - BitVector
```
public BitVector(BitVector copyFrom)
```
    Creates a bit set based off another bit vector.
- Method Detail
  - getWords
```
public int[] getWords()
```
    (can be manipulated directly)
  - setWords
```
public void setWords(int[] p)
```
    (can be manipulated directly)
  - copy
```
public BitVector copy()
```
  - get
```
public boolean get(int index)
```
    Parameters:
    
    index - the index of the bit
    
    Returns:
    
    whether the bit is set
  - set
```
public void set(int index)
```
    Parameters:
    
    index - the index of the bit to set
  - set
```
public void set(int index,
                boolean value)
```
    Parameters:
    
    index - the index of the bit to set
  - unsafeGet
```
public boolean unsafeGet(int index)
```
    Parameters:
    
    index - the index of the bit
    
    Returns:
    
    whether the bit is set
  - unsafeSet
```
public void unsafeSet(int index)
```
    Parameters:
    
    index - the index of the bit to set
  - unsafeSet
```
public void unsafeSet(int index,
                      boolean value)
```
    Parameters:
    
    index - the index of the bit to set
  - flip
```
public void flip(int index)
```
    Parameters:
    
    index - the index of the bit to flip
  - ensureCapacity
```
public void ensureCapacity(int bits)
```
    Grows the backing array so that it can hold the requested bits. Mostly applicable when relying on the unsafe methods, including BitVector.unsafeGet and BitVector.unsafeClear.
    
    Parameters:
    
    bits - number of bits to accomodate
    
    See Also:
    
    BitVector.unsafeGet, BitVector.unsafeClear
  - clear
```
public void clear(int index)
```
    Parameters:
    
    index - the index of the bit to clear
  - unsafeClear
```
public void unsafeClear(int index)
```
    Parameters:
    
    index - the index of the bit to clear
  - clear
```
public void clear()
```
    Clears the entire bitset
  - length
```
public int length()
```
    Returns the "logical size" of this bitset: the index of the highest set bit in the bitset plus one. Returns zero if the bitset contains no set bits.
    
    Returns:
    
    the logical size of this bitset
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    true if this bitset contains no set bits
  - and
```
public void and(BitVector other)
```
    Performs a logical AND of this target bit set with the argument bit set. This bit set is modified so that each bit in it has the value true if and only if it both initially had the value true and the corresponding bit in the bit set argument also had the value true.
    
    Parameters:
    
    other - a bit set
  - andNot
```
public void andNot(BitVector other)
```
    Clears all of the bits in this bit set whose corresponding bit is set in the specified bit set.
    
    Parameters:
    
    other - a bit set
  - or
```
public void or(BitVector other)
```
    Performs a logical OR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if it either already had the value true or the corresponding bit in the bit set argument has the value true.
    
    Parameters:
    
    other - a bit set
  - xor
```
public void xor(BitVector other)
```
    Performs a logical XOR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if one of the following statements holds:
    - The bit initially has the value true, and the corresponding bit in the argument has the value false.
    - The bit initially has the value false, and the corresponding bit in the argument has the value true.
    Parameters:
    
    other -
  - intersects
```
public boolean intersects(BitVector other)
```
    Returns true if the specified BitVector has any bits set to true that are also set to true in this BitVector.
    
    Parameters:
    
    other - a bit set
    
    Returns:
    
    boolean indicating whether this bit set intersects the specified bit set
  - contains
```
public boolean contains(BitVector other)
```
    Returns true if this bit set is a super set of the specified set, i.e. it has all bits set to true that are also set to true in the specified BitVector.
    
    Parameters:
    
    other - a bit set
    
    Returns:
    
    boolean indicating whether this bit set is a super set of the specified set
  - cardinality
```
public int cardinality()
```
    Returns the count of true bits
  - iterator
```
public kotlin.collections.IntIterator iterator()
```
  - hashCode
```
public int hashCode()
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
  - toString
```
public java.lang.String toString()
```
  - forEachBit
```
public void forEachBit(kotlin.jvm.functions.Function1<? super java.lang.Integer,kotlin.Unit> f)
```
    Enumerates over all true bits sequeneially. This function performs better than forEach and any other functions from Iterable.

Class BitVector

Constructor Summary

Method Summary

Constructor Detail

BitVector

BitVector

Method Detail

getWords

setWords

copy

get

set

set

unsafeGet

unsafeSet

unsafeSet

flip

ensureCapacity

clear

unsafeClear

clear

length

isEmpty

and

andNot

or

xor

intersects

contains

cardinality

iterator

hashCode

equals

toString

forEachBit