ShortByteAssociativeContainer (HPPC-RT v0.7.5 API Documentation)

All Superinterfaces:

java.lang.Iterable<ShortByteCursor>

All Known Subinterfaces:

ShortByteMap

All Known Implementing Classes:

ShortByteHashMap
```
@Generated(date="2017-07-11T19:16:24+0200",
           value="KTypeVTypeAssociativeContainer.java")
public interface ShortByteAssociativeContainer
extends java.lang.Iterable<ShortByteCursor>
```
An associative container (alias: map, dictionary) from keys to (one or possibly more) values. Object keys must fulfill the contract of Object.hashCode() and Object.equals(Object).
Note that certain associative containers (like multimaps) may return the same key-value pair multiple times from iterators.

See Also:

ShortContainer

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`capacity()` Return the maximum number of keys this container is guaranteed to hold without reallocating.
`boolean`	`containsKey(short key)` Returns `true` if this container has an association to a value for the given key.
`<T extends ShortBytePredicate> T`	`forEach(T predicate)` Applies a `predicate` to container elements, as long as the predicate returns `true`.
`<T extends ShortByteProcedure> T`	`forEach(T procedure)` Applies a given procedure to all keys-value pairs in this container.
`boolean`	`isEmpty()`
`java.util.Iterator<ShortByteCursor>`	`iterator()` Returns a cursor over the entries (key-value pairs) in this map.
`ShortCollection`	`keys()` Returns a collection view of keys of this container.
`int`	`removeAll(ShortBytePredicate predicate)` Removes all keys (and associated values) for which the predicate on (key, value) pairs returns `true`.
`int`	`removeAll(ShortContainer container)` Removes all keys (and associated values) present in a given container.
`int`	`removeAll(ShortPredicate predicate)` Removes all keys (and associated values) for which the predicate on keys returns `true`.
`int`	`size()`
`ByteCollection`	`values()` Returns a collection view of all values present in this container.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - iterator
```
java.util.Iterator<ShortByteCursor> iterator()
```
    Returns a cursor over the entries (key-value pairs) in this map. The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next(). To read the current key and value use the cursor's public fields. An example is shown below.
```
 for (IntShortCursor c : intShortMap)
 {
     System.out.println("index=" + c.index
       + " key=" + c.key
       + " value=" + c.value);
 }
 
```
    The index field inside the cursor gives the internal index inside the container's implementation. The interpretation of this index depends on to the container.
    Specified by:
    
    iterator in interface java.lang.Iterable<ShortByteCursor>
  - containsKey
```
boolean containsKey(short key)
```
    Returns true if this container has an association to a value for the given key.
  - size
```
int size()
```
    Returns:
    
    Returns the current size (number of assigned keys) in the container.
  - capacity
```
int capacity()
```
    Return the maximum number of keys this container is guaranteed to hold without reallocating. The time for calculating the container's capacity may take O(n) time.
  - isEmpty
```
boolean isEmpty()
```
    Returns:
    
    Return true if this hash map contains no assigned keys.
  - removeAll
```
int removeAll(ShortContainer container)
```
    Removes all keys (and associated values) present in a given container.
    
    Returns:
    
    Returns the number of elements actually removed as a result of this call.
  - removeAll
```
int removeAll(ShortPredicate predicate)
```
    Removes all keys (and associated values) for which the predicate on keys returns true.
    
    Returns:
    
    Returns the number of elements actually removed as a result of this call.
  - removeAll
```
int removeAll(ShortBytePredicate predicate)
```
    Removes all keys (and associated values) for which the predicate on (key, value) pairs returns true.
    
    Returns:
    
    Returns the number of elements actually removed as a result of this call.
  - forEach
```
<T extends ShortByteProcedure> T forEach(T procedure)
```
    Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of ShortByteProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example.
  - forEach
```
<T extends ShortBytePredicate> T forEach(T predicate)
```
    Applies a predicate to container elements, as long as the predicate returns true. The iteration is interrupted otherwise. Returns the argument (any subclass of ShortBytePredicate. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example. The iteration is continued as long as the predicate returns true.
  - keys
```
ShortCollection keys()
```
    Returns a collection view of keys of this container. The returned collection is a view over the key set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.
  - values
```
ByteCollection values()
```
    Returns a collection view of all values present in this container. The returned collection is a view over the value set and any modifications (if allowed) introduced to the collection will propagate to the associative container immediately.

Interface ShortByteAssociativeContainer

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

iterator

containsKey

size

capacity

isEmpty

removeAll

removeAll

removeAll

forEach

forEach

keys

values