com.carrotsearch.hppc

Class LongDoubleHashMap.KeysContainer

java.lang.Object

com.carrotsearch.hppc.LongDoubleHashMap.KeysContainer

All Implemented Interfaces:

LongCollection, LongContainer, LongLookupContainer, java.lang.Iterable<LongCursor>

Enclosing class:

LongDoubleHashMap

public final class LongDoubleHashMap.KeysContainer
extends java.lang.Object
implements LongLookupContainer

A view of the keys inside this hash map.

Constructor Summary

Constructors

Constructor and Description
LongDoubleHashMap.KeysContainer()

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all elements from this collection.
boolean	contains(long e) Lookup a given element in the container.
<T extends LongPredicate> T	forEach(T predicate) Applies a predicate to container elements as long, as the predicate returns true.
<T extends LongProcedure> T	forEach(T procedure) Applies a procedure to all container elements.
boolean	isEmpty() Shortcut for size() == 0.
java.util.Iterator<LongCursor>	iterator() Returns an iterator to a cursor traversing the collection.
void	release() Removes all elements from the collection and additionally releases any internal buffers.
int	removeAll(long e) Removes all occurrences of e from this collection.
int	removeAll(LongLookupContainer c) Default implementation uses a predicate for removal.
int	removeAll(LongPredicate predicate) Removes all elements in this collection for which the given predicate returns true.
int	retainAll(LongLookupContainer c) Default implementation uses a predicate for retaining.
int	retainAll(LongPredicate predicate) Default implementation redirects to LongCollection.removeAll(LongPredicate) and negates the predicate.
int	size() Return the current number of elements in this container.
long[]	toArray() Default implementation of copying to an array.
java.lang.String	toString() Convert the contents of this container to a human-friendly string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.carrotsearch.hppc.LongContainer

toArray

Constructor Detail

LongDoubleHashMap.KeysContainer

public LongDoubleHashMap.KeysContainer()

Method Detail

contains

public boolean contains(long e)

Description copied from interface: LongContainer

Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).

Specified by:

contains in interface LongContainer

Specified by:

contains in interface LongLookupContainer

Returns:

Returns true if this container has an element equal to e.

forEach

public <T extends LongProcedure> T forEach(T procedure)

Description copied from interface: LongContainer

Applies a procedure to all container elements. Returns the argument (any subclass of LongProcedure. 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 (IntContainer):

 int count = container.forEach(new IntProcedure() {
   int count; // this is a field declaration in an anonymous class.
 
   public void apply(int value) {
     count++;
   }
 }).count;
 

Specified by:

forEach in interface LongContainer

forEach

public <T extends LongPredicate> T forEach(T predicate)

Description copied from interface: LongContainer

Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.

Specified by:

forEach in interface LongContainer

isEmpty

public boolean isEmpty()

Description copied from interface: LongContainer

Shortcut for size() == 0.

Specified by:

isEmpty in interface LongContainer

iterator

public java.util.Iterator<LongCursor> iterator()

Description copied from interface: LongContainer

Returns an iterator to a cursor traversing the collection. The order of traversal is not defined. More than one cursor may be active at a time. The behavior of iterators is undefined if structural changes are made to the underlying collection.

The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next() (to avoid boxing of primitive types). To read the current list's value (or index in the list) use the cursor's public fields. An example is shown below.

 for (LongCursor<long> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
 

Specified by:

iterator in interface LongContainer

Specified by:

iterator in interface java.lang.Iterable<LongCursor>

size

public int size()

Description copied from interface: LongContainer

Return the current number of elements in this container. The time for calculating the container's size may take O(n) time, although implementing classes should try to maintain the current size and return in constant time.

Specified by:

size in interface LongContainer

clear

public void clear()

Description copied from interface: LongCollection

Removes all elements from this collection.

Specified by:

clear in interface LongCollection

See Also:

LongCollection.release()

release

public void release()

Description copied from interface: LongCollection

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

Specified by:

release in interface LongCollection

See Also:

LongCollection.clear()

removeAll

public int removeAll(LongPredicate predicate)

Description copied from interface: LongCollection

Removes all elements in this collection for which the given predicate returns true.

Specified by:

removeAll in interface LongCollection

Returns:

Returns the number of removed elements.

removeAll

public int removeAll(long e)

Description copied from interface: LongCollection

Removes all occurrences of e from this collection.

Specified by:

removeAll in interface LongCollection

Parameters:

e - Element to be removed from this collection, if present.

Returns:

The number of removed elements as a result of this call.

removeAll

public int removeAll(LongLookupContainer c)

Default implementation uses a predicate for removal.

Specified by:

removeAll in interface LongCollection

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(LongLookupContainer c)

Default implementation uses a predicate for retaining.

Specified by:

retainAll in interface LongCollection

Returns:

Returns the number of removed elements.

retainAll

public int retainAll(LongPredicate predicate)

Default implementation redirects to LongCollection.removeAll(LongPredicate) and negates the predicate.

Specified by:

retainAll in interface LongCollection

Returns:

Returns the number of removed elements.

toArray

public long[] toArray()

Default implementation of copying to an array.

Specified by:

toArray in interface LongContainer

toString

public java.lang.String toString()

Convert the contents of this container to a human-friendly string.

Overrides:

toString in class java.lang.Object