com.carrotsearch.hppc

Interface DoubleCharMap

All Superinterfaces:

DoubleCharAssociativeContainer, java.lang.Iterable<DoubleCharCursor>

All Known Implementing Classes:

DoubleCharOpenHashMap

@Generated(date="2014-04-08T14:32:52+0200",
           value="HPPC generated from: DoubleCharMap.java")
public interface DoubleCharMap
extends DoubleCharAssociativeContainer

An associative container with unique binding from keys to a single value.

Method Summary

Methods

Modifier and Type	Method and Description
char	addTo(double key, char additionValue) An equivalent of calling
boolean	equals(java.lang.Object obj) Compares the specified object with this set for equality.
char	get(double key)
char	getOrDefault(double key, char defaultValue)
int	hashCode()
char	put(double key, char value) Place a given key and value in the container.
int	putAll(DoubleCharAssociativeContainer 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 DoubleCharCursor> iterable) Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
char	putOrAdd(double key, char putValue, char additionValue) Trove-inspired API method.
char	remove(double key) Remove all values at the given key.

Methods inherited from interface com.carrotsearch.hppc.DoubleCharAssociativeContainer

clear, containsKey, forEach, isEmpty, iterator, keys, removeAll, removeAll, size, values

Method Detail

put

char put(double key,
       char value)

Place a given key and value in the container.

Returns:

The value previously stored under the given key in the map is returned.

addTo

char addTo(double key,
         char 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).

putOrAdd

char putOrAdd(double key,
            char putValue,
            char additionValue)

Trove-inspired API method. A logical equivalent of the following code (but does not update #lastSlot):

  if (containsKey(key))
  {
      char v = (char) (lget() + additionValue);
      lset(v);
      return v;
  }
  else
  {
     put(key, putValue);
     return putValue;
  }
 

Parameters:

key - The key of the value to adjust.

putValue - The value to put if key does not exist.

additionValue - The value to add to the existing value if key exists.

Returns:

Returns the current value associated with key (after changes).

get

char get(double key)

Returns:

Returns the value associated with the given key or the default value for the key type, if the key is not associated with any value. Important note: For primitive type values, the value returned for a non-existing key may not be the default value of the primitive type (it may be any value previously assigned to that slot).

getOrDefault

char getOrDefault(double key,
                char defaultValue)

Returns:

Returns the value associated with the given key or the provided default value if the key is not associated with any value.

putAll

int putAll(DoubleCharAssociativeContainer 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 DoubleCharCursor> 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.

remove

char remove(double 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 DoubleCharMap 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.