Package org.plumelib.util

Class LimitedSizeSet<T extends @Nullable Object>

java.lang.Object
org.plumelib.util.LimitedSizeSet<T>
Type Parameters:
T - the type of elements in the set
All Implemented Interfaces:
Serializable, Cloneable
public class LimitedSizeSet<T extends @Nullable Object> extends Object implements Serializable, Cloneable
LimitedSizeSet stores up to some maximum number of unique values. If more than that many elements are added, then functionality is degraded: most operations return a conservative estimate (because the internal representation is nulled, in order to save space).

If you need LimitedSizeSet<Integer>, use LimitedSizeIntSet instead.

If you need LimitedSizeSet<Long>, use LimitedSizeLongSet instead.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected @org.checkerframework.checker.index.qual.IndexOrHigh({"values"}) int
    numValues
    The number of active elements (equivalently, the first unused index).
    protected @Nullable T @Nullable @MinLen(1) []
    values
    If null, then at least numValues distinct values have been seen (and numValues equals the maxValues argument to the constructor).

  • Constructor Summary

    Constructors
    Constructor
    Description
    LimitedSizeSet(@org.checkerframework.checker.index.qual.Positive int maxValues)
    Create a new LimitedSizeSet that can hold maxValues values.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(T elt)
    Add an element to this set.
    void
    addAll(LimitedSizeSet<? extends T> s)
    Add all elements of s to this set.
    LimitedSizeSet<T>
    clone()
     
    boolean
    contains(T elt)
    Returns true if this set contains the given element.
    @org.checkerframework.checker.index.qual.Positive int
    maxSize()
    An upper bound on how many distinct elements can be individually represented in the set.
    static <T extends @Nullable Object>
    LimitedSizeSet<T>
    merge(@org.checkerframework.checker.index.qual.Positive int maxValues, List<LimitedSizeSet<? extends T>> slist)
    Merges a list of LimitedSizeSet<T> objects into a single object that represents the values seen by the entire list.
    boolean
    repNulled()
    Returns true if more elements have been added than this set can contain (which is the integer that was passed to the constructor when creating this set).
    @org.checkerframework.checker.index.qual.IndexOrHigh({"this.values"}) int
    size()
    A lower bound on the number of elements in the set.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • values

      protected @Nullable T extends @Nullable Object @Nullable @MinLen(1) [] values
      If null, then at least numValues distinct values have been seen (and numValues equals the maxValues argument to the constructor).

    • numValues

      protected @org.checkerframework.checker.index.qual.IndexOrHigh({"values"}) int numValues
      The number of active elements (equivalently, the first unused index).

  • Constructor Details

    • LimitedSizeSet

      public LimitedSizeSet(@org.checkerframework.checker.index.qual.Positive int maxValues)
      Create a new LimitedSizeSet that can hold maxValues values.
      Parameters:
      maxValues - the maximum number of values this set will be able to hold; must be positive

  • Method Details

    • add

      public void add(T elt)
      Add an element to this set.
      Parameters:
      elt - the element to add to this set

    • addAll

      public void addAll(LimitedSizeSet<? extends T> s)
      Add all elements of s to this set.
      Parameters:
      s - the elements to add to this set

    • contains

      @Pure public boolean contains(T elt)
      Returns true if this set contains the given element.
      Parameters:
      elt - the element whose membership to test
      Returns:
      true if this set contains elt

    • size

      @Pure public @org.checkerframework.checker.index.qual.IndexOrHigh({"this.values"}) int size(@GuardSatisfied LimitedSizeSet<T extends @Nullable Object> this)
      A lower bound on the number of elements in the set. Returns either the number of elements that have been inserted in the set, or maxSize(), whichever is less.
      Returns:
      a number that is a lower bound on the number of elements added to the set

    • maxSize

      public @org.checkerframework.checker.index.qual.Positive int maxSize()
      An upper bound on how many distinct elements can be individually represented in the set. Returns maxValues+1 (where maxValues is the argument to the constructor).
      Returns:
      maximum capacity of the set representation

    • repNulled

      @EnsuresNonNullIf(result=false, expression="values") @Pure public boolean repNulled(@GuardSatisfied LimitedSizeSet<T extends @Nullable Object> this)
      Returns true if more elements have been added than this set can contain (which is the integer that was passed to the constructor when creating this set).
      Returns:
      true if this set has been filled to capacity and its internal representation is nulled

    • clone

      @SideEffectFree public LimitedSizeSet<T> clone(@GuardSatisfied LimitedSizeSet<T extends @Nullable Object> this)
      Overrides:
      clone in class Object

    • merge

      public static <T extends @Nullable Object> LimitedSizeSet<T> merge(@org.checkerframework.checker.index.qual.Positive int maxValues, List<LimitedSizeSet<? extends T>> slist)
      Merges a list of LimitedSizeSet<T> objects into a single object that represents the values seen by the entire list. Returns the new object, whose maxValues is the given integer.
      Type Parameters:
      T - (super)type of elements of the sets
      Parameters:
      maxValues - the maximum size for the returned LimitedSizeSet
      slist - a list of LimitedSizeSet, whose elements will be merged
      Returns:
      a LimitedSizeSet that merges the elements of slist

    • toString

      @SideEffectFree public String toString(@GuardSatisfied LimitedSizeSet<T extends @Nullable Object> this)
      Overrides:
      toString in class Object