checkers.flow

Class GenKillBits<K extends @NonNull Object>

@NonNull java.lang.Object

checkers.flow.GenKillBits<K>

Type Parameters:

K - the type of the key

public class GenKillBits<K extends @NonNull Object>
extends @NonNull Object

Maintains multiple gen-kill sets, "keyed" by a value. For instance, the flow-sensitive inference implemented in Flow uses a GenKillBits keyed by AnnotationMirrors to simultaneously track the gen-kill sets of multiple type qualifiers.

This class is essentially an abstraction for maintaining and combining multiple simultaneous bit vectors.

Constructor Summary

Constructors

Constructor and Description
GenKillBits(Collection<K> keys) Creates a new GenKillBits with the specified set of keys.
GenKillBits(GenKillBits<K> other) Creates a new GenKillBits that is a deep copy of the GenKillBits passed as an argument.

Method Summary

Methods

Modifier and Type	Method and Description
static void	andlub(GenKillBits<@Nullable AnnotationMirror> outarg1, GenKillBits<@Nullable AnnotationMirror> arg2, QualifierHierarchy annoRelations) Merges each gen-kill set in outarg1 with the one corresponding to the same key in arg2 via boolean "and" on each bit.
void	clear(K key, int index) Clears the bit (kill) for the key at the specified index.
void	clearInAll(int index) For all keys, clear the bit at the given index.
boolean	contains(K key)
static <K extends @NonNull Object> GenKillBits<K>	copy(GenKillBits<K> other) Creates a new GenKillBits that is a deep copy of the GenKillBits passed as an argument.
boolean	get(K key, int index) Retrieves the bit for the key at the specified index.
static void	orlub(GenKillBits<@Nullable AnnotationMirror> outarg1, GenKillBits<@Nullable AnnotationMirror> arg2, QualifierHierarchy annoRelations) Merges each gen-kill set outarg1 with the one corresponding to the same key in arg2 via boolean "or" on each bit.
void	set(K key, int index) Sets the bit (gen) for the key at the specified index.
@ReadOnly String	toString()
boolean	valid()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GenKillBits

public GenKillBits(Collection<K> keys)

Creates a new GenKillBits with the specified set of keys. (Once specified, the keys may not be changed.)

Parameters:

keys - the keys for the GenKillBits

GenKillBits

public GenKillBits(GenKillBits<K> other)

Creates a new GenKillBits that is a deep copy of the GenKillBits passed as an argument.

Parameters:

other - the GenKillBits to copy

See Also:

copy(GenKillBits)

Method Detail

copy

public static <K extends @NonNull Object> GenKillBits<K> copy(GenKillBits<K> other)

Creates a new GenKillBits that is a deep copy of the GenKillBits passed as an argument.

Type Parameters:

K - the key type of the group

Parameters:

other - the GenKillBits to copy

Returns:

a deep copy of the contents of g

See Also:

GenKillBits(GenKillBits)

set

public void set(K key,
       int index)

Sets the bit (gen) for the key at the specified index. Adds the key if it does not already exist.

Parameters:

key - the key for which the bit should be set

index - the index at which to set the bit

get

public boolean get(K key,
          int index)

Retrieves the bit for the key at the specified index.

Parameters:

key -

index -

Returns:

the value of the bit for the key at the index or false if the key does not exist.

contains

public boolean contains(K key)

clear

public void clear(K key,
         int index)

Clears the bit (kill) for the key at the specified index. Does nothing if the key does not exist.

Parameters:

key - the key for which the bit should be set

index - the index at which to set the bit

clearInAll

public void clearInAll(int index)

For all keys, clear the bit at the given index.

toString

public @ReadOnly String toString()

Overrides:

toString in class @NonNull Object

andlub

public static void andlub(GenKillBits<@Nullable AnnotationMirror> outarg1,
          GenKillBits<@Nullable AnnotationMirror> arg2,
          QualifierHierarchy annoRelations)

Merges each gen-kill set in outarg1 with the one corresponding to the same key in arg2 via boolean "and" on each bit. Modifies outarg1's gen-kill set. If arg2 is missing a key in outarg1 then an empty set is added to arg2 for the key. TODO: lub

Parameters:

outarg1 - the group to modify

arg2 - the group to "and" with

orlub

public static void orlub(GenKillBits<@Nullable AnnotationMirror> outarg1,
         GenKillBits<@Nullable AnnotationMirror> arg2,
         QualifierHierarchy annoRelations)

Merges each gen-kill set outarg1 with the one corresponding to the same key in arg2 via boolean "or" on each bit. Modifies outarg1 gen-kill set. If arg2 is missing a key in outarg1 then an empty set is added to arg2 for the key. TODO: lub.

Parameters:

outarg1 - the group to modify

arg2 - the group to "or" with

valid

public boolean valid()