Package org.apache.uima.internal.util

Class IntHashSet

java.lang.Object
org.apache.uima.internal.util.Common_hash_support
org.apache.uima.internal.util.IntHashSet
All Implemented Interfaces:
PositiveIntSet
public class IntHashSet extends Common_hash_support implements PositiveIntSet
A set of non-zero ints. Can be negative. 0 reserved internally to indicate "not in the map"; you will get an exception if you try to store 0 as a value. 0 will be returned if the value is missing from the map. allowed range is Integer.MIN_VALUE + 1 to Integer.MAX_VALUE 0 is the value for an empty cell Integer.MIN_VALUE is the value for a deleted (removed) value based on Int2IntHashMap This impl is for use in a single thread case only Supports shrinking (reallocating the big table) Supports representing ints as "short" 2byte values if possible, together with an offset amount. Because of the offset, the adjusted key could be == to the offset, so we subtract 1 from it to preserve 0 value as being the null / empty. For short values, the range is: Short.MIN_VALUE+2 to Short.MAX_VALUE after Offset, with the "0" value moved down by 1 and the Short.MIN_VALUE used for deleted (removed) items Automatically switches to full int representation if needed

  • Field Details

  • Constructor Details

    • IntHashSet

      public IntHashSet()

    • IntHashSet

      public IntHashSet(int initialCapacity)

    • IntHashSet

      public IntHashSet(int initialSizeBeforeExpanding, int offset)
      Parameters:
      initialSizeBeforeExpanding - - you can add this many before expansion
      offset - - for values in the short range, the amount to subtract before storing. If == MIN_VALUE, then force 4 byte ints

  • Method Details

    • tableSpace

      public static int tableSpace(int numberOfElements)

    • wontExpand

      public boolean wontExpand()
      Method called by handleHashSet in PositiveIntSet to indicate if adding this many items would cause an expansion
      Returns:
      true if would not expand

    • wontExpand

      public boolean wontExpand(int n)
      Method called by handleHashSet in PositiveIntSet to indicate if adding this many items would cause an expansion
      Parameters:
      n - the number of items added
      Returns:
      true if would not expand

    • getSpaceUsedInWords

      public int getSpaceUsedInWords()

    • getSpaceOverheadInWords

      public static int getSpaceOverheadInWords()

    • clear

      public void clear()
      Description copied from interface: PositiveIntSet
      remove all members of the set
      Specified by:
      clear in interface PositiveIntSet
      Overrides:
      clear in class Common_hash_support

    • contains

      public boolean contains(int rawKey)
      Specified by:
      contains in interface PositiveIntSet
      Parameters:
      rawKey - -
      Returns:
      true if key is in the set

    • find

      public int find(int rawKey)
      This method is part of the PositiveSet API, and is defined to return an int that could be used with iterators to position them. For this case, it is not used, because the iterators don't support positioning this way because they are not sorted.
      Specified by:
      find in interface PositiveIntSet
      Parameters:
      rawKey - an item which may be in the set
      Returns:
      -1 if the item is not in the set, or a position value that can be used with iterators to start at that item.

    • add

      public boolean add(int rawKey)
      Specified by:
      add in interface PositiveIntSet
      Parameters:
      rawKey - -
      Returns:
      true if this set did not already contain the specified element

    • remove

      public boolean remove(int rawKey)
      mostPositive and mostNegative are not updated for removes. So these values may be inaccurate, but mostPositive is always >= actual most positive, and mostNegative is always <= actual most negative. No conversion from int to short Can't replace the item with a 0 because other keys that were stored in the table which previously collided with the removed item won't be found. UIMA-4204
      Specified by:
      remove in interface PositiveIntSet
      Parameters:
      rawKey - the value to remove
      Returns:
      true if the key was present

    • getMostPositive

      public int getMostPositive()
      Returns:
      a value that is >= the actual most positive value in the table. it will be == unless a remove operation has removed a most positive value

    • getMostNegative

      public int getMostNegative()
      Returns:
      a value that is <= the actual least positive value in the table. It will be == unless remove operations has removed a least positive value.

    • showHistogram

      public void showHistogram()
      Overrides:
      showHistogram in class Common_hash_support

    • get

      public int get(int pos)
      For iterator use, position is a magic number returned by the internal find For short keys, the value stored for adjKey == 0 is -1, adjKey == -1 is -2, etc.
      Specified by:
      get in interface PositiveIntSet
      Parameters:
      pos - - get the element at this position. This is for iterator use only, and is not related to any key
      Returns:
      the element

    • iterator

      public IntListIterator iterator()
      Specified by:
      iterator in interface PositiveIntSet
      Returns:
      an iterator (may be ordered or unordered) over the members of the set

    • moveToFirst

      public int moveToFirst()
      Description copied from interface: PositiveIntSet
      For FSBagIndex low level iterator use
      Specified by:
      moveToFirst in interface PositiveIntSet
      Returns:
      the position of the first element, or -1;

    • moveToLast

      public int moveToLast()
      Description copied from interface: PositiveIntSet
      For FSBagIndex low level iterator use
      Specified by:
      moveToLast in interface PositiveIntSet
      Returns:
      the position of the last element, or -1;

    • moveToNext

      public int moveToNext(int position)
      Description copied from interface: PositiveIntSet
      For FSBagIndex low level iterator use
      Specified by:
      moveToNext in interface PositiveIntSet
      Parameters:
      position - -
      Returns:
      the position of the next element, or -1;

    • moveToPrevious

      public int moveToPrevious(int position)
      Description copied from interface: PositiveIntSet
      For FSBagIndex low level iterator use
      Specified by:
      moveToPrevious in interface PositiveIntSet
      Parameters:
      position - -
      Returns:
      the position of the next element, or -1;

    • isValid

      public boolean isValid(int position)
      Description copied from interface: PositiveIntSet
      For FSBagIndex low level iterator use
      Specified by:
      isValid in interface PositiveIntSet
      Parameters:
      position - -
      Returns:
      true if the position is between the first and last element inclusive.

    • bulkAddTo

      public void bulkAddTo(IntVector v)
      Description copied from interface: PositiveIntSet
      add all elements in this set to the IntVector v as a bulk operation
      Specified by:
      bulkAddTo in interface PositiveIntSet
      Parameters:
      v - - to be added to

    • toIntArray

      public int[] toIntArray()
      Specified by:
      toIntArray in interface PositiveIntSet
      Returns:
      the set as an arbitrarily ordered int array

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • is_valid_key

      protected boolean is_valid_key(int pos)
      Specified by:
      is_valid_key in class Common_hash_support

    • keys_length

      protected int keys_length()
      Specified by:
      keys_length in class Common_hash_support

    • newKeysAndValues

      protected void newKeysAndValues(int capacity)
      Specified by:
      newKeysAndValues in class Common_hash_support

    • clearKeysAndValues

      protected void clearKeysAndValues()
      Specified by:
      clearKeysAndValues in class Common_hash_support

    • copy_to_new_table

      protected void copy_to_new_table(int new_capacity, int old_capacity, Common_hash_support.CommonCopyOld2New commonCopy)
      Specified by:
      copy_to_new_table in class Common_hash_support