Package com.carrotsearch.hppc

Interface CharIntMap

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int addTo​(char key, int additionValue)
      An equivalent of calling
      void clear()
      Clear all keys and values in the container.
      boolean equals​(java.lang.Object obj)
      Compares the specified object with this set for equality.
      int get​(char key)  
      int getOrDefault​(char key, int defaultValue)  
      int hashCode()  
      boolean indexExists​(int index)  
      int indexGet​(int index)
      Returns the value associated with an existing key.
      void indexInsert​(int index, char key, int value)
      Inserts a key-value pair for a key that is not present in the map.
      int indexOf​(char key)
      Returns a logical "index" of a given key that can be used to speed up follow-up value setters or getters in certain scenarios (conditional logic).
      int indexReplace​(int index, int newValue)
      Replaces the value associated with an existing key and returns any previous value stored for that key.
      int put​(char key, int value)
      Place a given key and value in the container.
      int putAll​(CharIntAssociativeContainer container)
      Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
      int putAll​(java.lang.Iterable<? extends CharIntCursor> iterable)
      Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
      int putOrAdd​(char key, int putValue, int incrementValue)
      If key exists, putValue is inserted into the map, otherwise any existing value is incremented by additionValue.
      void release()
      Removes all elements from the collection and additionally releases any internal buffers.
      int remove​(char key)
      Remove all values at the given key.
      java.lang.String visualizeKeyDistribution​(int characters)
      Visually depict the distribution of keys.

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Method Detail

      • get

        int get​(char key)
        Returns:
        Returns the value associated with the given key or the default value for the value type, if the key is not associated with any value. For numeric value types, this default value is 0, for object types it is null.

      • getOrDefault

        int getOrDefault​(char key,
                 int defaultValue)
        Returns:
        Returns the value associated with the given key or the provided default value if the key is not associated with any value.

      • put

        int put​(char key,
        int value)
        Place a given key and value in the container.
        Returns:
        The value previously stored under the given key in the map is returned.

      • putAll

        int putAll​(CharIntAssociativeContainer container)
        Puts all keys from another container to this map, replacing the values of existing keys, if such keys are present.
        Returns:
        Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.

      • putAll

        int putAll​(java.lang.Iterable<? extends CharIntCursor> iterable)
        Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
        Returns:
        Returns the number of keys added to the map as a result of this call (not previously present in the map). Values of existing keys are overwritten.

      • putOrAdd

        int putOrAdd​(char key,
             int putValue,
             int incrementValue)
        If key exists, putValue is inserted into the map, otherwise any existing value is incremented by additionValue.
        Parameters:
        key - The key of the value to adjust.
        putValue - The value to put if key does not exist.
        incrementValue - The value to add to the existing value if key exists.
        Returns:
        Returns the current value associated with key (after changes).

      • addTo

        int addTo​(char key,
          int additionValue)
        An equivalent of calling 
         putOrAdd(key, additionValue, additionValue);
        Parameters:
        key - The key of the value to adjust.
        additionValue - The value to put or add to the existing value if key exists.
        Returns:
        Returns the current value associated with key (after changes).

      • remove

        int remove​(char key)
        Remove all values at the given key. The default value for the key type is returned if the value does not exist in the map.

      • equals

        boolean equals​(java.lang.Object obj)
        Compares the specified object with this set for equality. Returns true if and only if the specified object is also a CharIntMap and both objects contains exactly the same key-value pairs.
        Overrides:
        equals in class java.lang.Object

      • hashCode

        int hashCode()
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A hash code of elements stored in the map. The hash code is defined as a sum of hash codes of keys and values stored within the set). Because sum is commutative, this ensures that different order of elements in a set does not affect the hash code.

      • indexOf

        int indexOf​(char key)
        Returns a logical "index" of a given key that can be used to speed up follow-up value setters or getters in certain scenarios (conditional logic). The semantics of "indexes" are not strictly defined. Indexes may (and typically won't be) contiguous. The index is valid only between map modifications (it will not be affected by read-only operations like iteration or value retrievals).
        Parameters:
        key - The key to locate in the map.
        Returns:
        A non-negative value of the logical "index" of the key in the map or a negative value if the key did not exist.
        See Also:
        indexExists(int), indexGet(int), indexInsert(int, char, int), indexReplace(int, int)

      • indexExists

        boolean indexExists​(int index)
        Parameters:
        index - The index of a given key, as returned from indexOf(char).
        Returns:
        Returns true if the index corresponds to an existing key or false otherwise. This is equivalent to checking whether the index is a positive value (existing keys) or a negative value (non-existing keys).
        See Also:
        indexOf(char)

      • indexGet

        int indexGet​(int index)
        Returns the value associated with an existing key.
        Parameters:
        index - The index of an existing key.
        Returns:
        Returns the value currently associated with the key.
        Throws:
        java.lang.AssertionError - If assertions are enabled and the index does not correspond to an existing key.
        See Also:
        indexOf(char)

      • indexReplace

        int indexReplace​(int index,
                 int newValue)
        Replaces the value associated with an existing key and returns any previous value stored for that key.
        Parameters:
        index - The index of an existing key.
        Returns:
        Returns the previous value associated with the key.
        Throws:
        java.lang.AssertionError - If assertions are enabled and the index does not correspond to an existing key.
        See Also:
        indexOf(char)

      • indexInsert

        void indexInsert​(int index,
                 char key,
                 int value)
        Inserts a key-value pair for a key that is not present in the map. This method may help in avoiding double recalculation of the key's hash.
        Parameters:
        index - The index of a previously non-existing key, as returned from indexOf(char).
        Throws:
        java.lang.AssertionError - If assertions are enabled and the index corresponds to an existing key.
        See Also:
        indexOf(char)

      • clear

        void clear()
        Clear all keys and values in the container.
        See Also:
        release()

      • release

        void release()
        Removes all elements from the collection and additionally releases any internal buffers. Typically, if the object is to be reused, a simple clear() should be a better alternative since it'll avoid reallocation.
        See Also:
        clear()

      • visualizeKeyDistribution

        java.lang.String visualizeKeyDistribution​(int characters)
        Visually depict the distribution of keys.
        Parameters:
        characters - The number of characters to "squeeze" the entire buffer into.
        Returns:
        Returns a sequence of characters where '.' depicts an empty fragment of the internal buffer and 'X' depicts full or nearly full capacity within the buffer's range and anything between 1 and 9 is between.