BitmaskMath (JImmutable Collections 4.0.1 API)

java.lang.Object

org.javimmutable.collections.common.BitmaskMath

public final class BitmaskMath extends Object

Helper class with static methods to manipulate long bitmasks. Used in array map trie calculations. Methods are short to allow inlining.

Field Summary

Fields

Modifier and Type

Field

Description

static final long

ALL_BITS

static final int

ARRAY_SIZE

static final int

MAX_INDEX
Method Summary

Modifier and Type

Method

Description

static long

addBit(long bitmask, long bit)

static int

arrayIndexForBit(long bitmask, long bit)

static int

bitCount(long bitmask)

static long

bitFromIndex(int index)

static boolean

bitIsAbsent(long bitmask, long bit)

static boolean

bitIsPresent(long bitmask, long bit)

static long

bitmask(int... indices)

static <S, D> void

copyToCompactArrayUsingBitmask(long bitmask, S[] source, D[] dest, java.util.function.Function<S,D> transforminator)

static void

forEachIndex(long bitmask, java.util.function.IntConsumer proc)

static int

indexForBit(long bit)

static Indexed<Integer>

indices(long bitmask)

static long

leastBit(long bitmask)

static long

removeBit(long bitmask, long bit)

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

Field Details
- ARRAY_SIZE
  
  public static final int ARRAY_SIZE
  See Also:
  
  Constant Field Values
- MAX_INDEX
  
  public static final int MAX_INDEX
  See Also:
  
  Constant Field Values
- ALL_BITS
  
  public static final long ALL_BITS
  See Also:
  
  Constant Field Values
Method Details
- bitFromIndex
  
  public static long bitFromIndex(int index)
- bitIsAbsent
  
  public static boolean bitIsAbsent(long bitmask, long bit)
- bitIsPresent
  
  public static boolean bitIsPresent(long bitmask, long bit)
- addBit
  
  public static long addBit(long bitmask, long bit)
- removeBit
  
  public static long removeBit(long bitmask, long bit)
- leastBit
  
  public static long leastBit(long bitmask)
- indexForBit
  
  public static int indexForBit(long bit)
- arrayIndexForBit
  
  public static int arrayIndexForBit(long bitmask, long bit)
- bitCount
  
  public static int bitCount(long bitmask)
- indices
  
  @Nonnull public static Indexed<Integer> indices(long bitmask)
- forEachIndex
  
  public static void forEachIndex(long bitmask, java.util.function.IntConsumer proc)
- copyToCompactArrayUsingBitmask
  
  public static <S, D> void copyToCompactArrayUsingBitmask(long bitmask, @Nonnull S[] source, @Nonnull D[] dest, @Nonnull java.util.function.Function<S,D> transforminator)
- bitmask
  
  public static long bitmask(int... indices)