Package com.carrotsearch.hppc

Interface ShortByteMap

All Superinterfaces:

java.lang.Iterable<ShortByteCursor>, ShortByteAssociativeContainer

All Known Implementing Classes:

ShortByteHashMap, ShortByteWormMap

@Generated(date="2020-09-07T17:20:15+0200",
           value="KTypeVTypeMap.java")
public interface ShortByteMap
extends ShortByteAssociativeContainer

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

Method Summary

Modifier and Type	Method	Description
byte	addTo(short key, byte 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.
byte	get(short key)
byte	getOrDefault(short key, byte defaultValue)
int	hashCode()
boolean	indexExists(int index)
byte	indexGet(int index)	Returns the value associated with an existing key.
void	indexInsert(int index, short key, byte value)	Inserts a key-value pair for a key that is not present in the map.
int	indexOf(short 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).
byte	indexReplace(int index, byte newValue)	Replaces the value associated with an existing key and returns any previous value stored for that key.
byte	put(short key, byte value)	Place a given key and value in the container.
int	putAll(ShortByteAssociativeContainer 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 ShortByteCursor> iterable)	Puts all keys from an iterable cursor to this map, replacing the values of existing keys, if such keys are present.
byte	putOrAdd(short key, byte putValue, byte 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.
byte	remove(short 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

Methods inherited from interface com.carrotsearch.hppc.ShortByteAssociativeContainer

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

Method Detail

get

byte get(short 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

byte getOrDefault(short key,
                  byte 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

byte put(short key,
         byte 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(ShortByteAssociativeContainer 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 ShortByteCursor> 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

byte putOrAdd(short key,
              byte putValue,
              byte 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

byte addTo(short key,
           byte 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

byte remove(short 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 ShortByteMap 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(short 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, short, byte), indexReplace(int, byte)

indexExists

boolean indexExists(int index)

Parameters:

index - The index of a given key, as returned from indexOf(short).

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(short)

indexGet

byte 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(short)

indexReplace

byte indexReplace(int index,
                  byte 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(short)

indexInsert

void indexInsert(int index,
                 short key,
                 byte 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(short).

Throws:

java.lang.AssertionError - If assertions are enabled and the index corresponds to an existing key.

See Also:

indexOf(short)

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.