Package com.carrotsearch.hppc

Interface DoubleObjectAssociativeContainer<VType>

All Superinterfaces:

java.lang.Iterable<DoubleObjectCursor<VType>>

@Generated(date="2018-05-21T11:30:39+0200",
           value="KTypeVTypeAssociativeContainer.java")
public interface DoubleObjectAssociativeContainer<VType>
extends java.lang.Iterable<DoubleObjectCursor<VType>>

An associative container from keys to (one or possibly more) values.

See Also:

DoubleContainer

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(double key)	Returns true if this container has an association to a value for the given key.
<T extends DoubleObjectProcedure<? super VType>> T	forEach(T procedure)	Applies a given procedure to all keys-value pairs in this container.
boolean	isEmpty()
java.util.Iterator<DoubleObjectCursor<VType>>	iterator()	Returns a cursor over the entries (key-value pairs) in this map.
DoubleCollection	keys()	Returns a collection of keys of this container.
int	removeAll(DoubleContainer container)	Removes all keys (and associated values) present in a given container.
int	removeAll(DoubleObjectPredicate<? super VType> predicate)	Removes all keys (and associated values) for which the predicate returns true.
int	removeAll(DoublePredicate predicate)	Removes all keys (and associated values) for which the predicate returns true.
int	size()
ObjectContainer<VType>	values()	Returns a container view of all values present in this container.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

java.util.Iterator<DoubleObjectCursor<VType>> 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<VType>

containsKey

boolean containsKey(double 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.

isEmpty

boolean isEmpty()

Returns:

Return true if this hash map contains no assigned keys.

removeAll

int removeAll(DoubleContainer container)

Removes all keys (and associated values) present in a given container. An alias to:

 keys().removeAll(container)
 

but with no additional overhead.

Returns:

Returns the number of elements actually removed as a result of this call.

removeAll

int removeAll(DoublePredicate predicate)

Removes all keys (and associated values) for which the predicate returns true.

Returns:

Returns the number of elements actually removed as a result of this call.

removeAll

int removeAll(DoubleObjectPredicate<? super VType> predicate)

Removes all keys (and associated values) for which the predicate returns true.

Returns:

Returns the number of elements actually removed as a result of this call.

forEach

<T extends DoubleObjectProcedure<? super VType>> T forEach(T procedure)

Applies a given procedure to all keys-value pairs in this container. Returns the argument (any subclass of DoubleObjectProcedure. 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 DoubleObjectPredicate<? super VType>> T forEach(T predicate)

Applies a given predicate to all keys-value pairs in this container. Returns the argument (any subclass of DoubleObjectPredicate. 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

DoubleCollection keys()

Returns a collection 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

ObjectContainer<VType> values()

Returns a container view of all values present in 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.