com.carrotsearch.hppc
Class DoubleObjectOpenHashMap.KeysContainer

java.lang.Object
  extended by com.carrotsearch.hppc.DoubleObjectOpenHashMap.KeysContainer
All Implemented Interfaces:
DoubleCollection, DoubleContainer, DoubleLookupContainer, java.lang.Iterable<DoubleCursor>
Enclosing class:
DoubleObjectOpenHashMap<VType>

public final class DoubleObjectOpenHashMap.KeysContainer
extends java.lang.Object
implements DoubleLookupContainer

A view of the keys inside this hash map.


Constructor Summary
DoubleObjectOpenHashMap.KeysContainer()
           
 
Method Summary
 void clear()
          Removes all elements from this collection.
 boolean contains(double e)
          Lookup a given element in the container.
<T extends DoublePredicate>
T
forEach(T predicate)
          Applies a predicate to container elements as long, as the predicate returns true.
<T extends DoubleProcedure>
T
forEach(T procedure)
          Applies a procedure to all container elements.
 boolean isEmpty()
          Shortcut for size() == 0.
 java.util.Iterator<DoubleCursor> iterator()
          Returns an iterator to a cursor traversing the collection.
 int removeAll(DoubleLookupContainer c)
          Default implementation uses a predicate for removal.
 int removeAll(DoublePredicate predicate)
          Removes all elements in this collection for which the given predicate returns true.
 int removeAllOccurrences(double e)
          Removes all occurrences of e from this collection.
 int retainAll(DoubleLookupContainer c)
          Default implementation uses a predicate for retaining.
 int retainAll(DoublePredicate predicate)
          Default implementation redirects to DoubleCollection.removeAll(DoublePredicate) and negates the predicate.
 int size()
          Return the current number of elements in this container.
 double[] 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.DoubleContainer
toArray
 

Constructor Detail

DoubleObjectOpenHashMap.KeysContainer

public DoubleObjectOpenHashMap.KeysContainer()
Method Detail

contains

public boolean contains(double e)
Description copied from interface: DoubleContainer
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 DoubleContainer
Specified by:
contains in interface DoubleLookupContainer
Returns:
Returns true if this container has an element equal to e.

forEach

public <T extends DoubleProcedure> T forEach(T procedure)
Description copied from interface: DoubleContainer
Applies a procedure to all container elements. Returns the argument (any subclass of DoubleProcedure. 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 DoubleContainer

forEach

public <T extends DoublePredicate> T forEach(T predicate)
Description copied from interface: DoubleContainer
Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.

Specified by:
forEach in interface DoubleContainer

isEmpty

public boolean isEmpty()
Description copied from interface: DoubleContainer
Shortcut for size() == 0.

Specified by:
isEmpty in interface DoubleContainer

iterator

public java.util.Iterator<DoubleCursor> iterator()
Description copied from interface: DoubleContainer
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 (DoubleCursor<double> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
 

Specified by:
iterator in interface DoubleContainer
Specified by:
iterator in interface java.lang.Iterable<DoubleCursor>

size

public int size()
Description copied from interface: DoubleContainer
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 DoubleContainer

clear

public void clear()
Description copied from interface: DoubleCollection
Removes all elements from this collection.

Specified by:
clear in interface DoubleCollection

removeAll

public int removeAll(DoublePredicate predicate)
Description copied from interface: DoubleCollection
Removes all elements in this collection for which the given predicate returns true.

Specified by:
removeAll in interface DoubleCollection

removeAllOccurrences

public int removeAllOccurrences(double e)
Description copied from interface: DoubleCollection
Removes all occurrences of e from this collection.

Specified by:
removeAllOccurrences in interface DoubleCollection
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(DoubleLookupContainer c)
Default implementation uses a predicate for removal.

Specified by:
removeAll in interface DoubleCollection
Returns:
Returns the number of removed elements.

retainAll

public int retainAll(DoubleLookupContainer c)
Default implementation uses a predicate for retaining.

Specified by:
retainAll in interface DoubleCollection
Returns:
Returns the number of removed elements.

retainAll

public int retainAll(DoublePredicate predicate)
Default implementation redirects to DoubleCollection.removeAll(DoublePredicate) and negates the predicate.

Specified by:
retainAll in interface DoubleCollection

toArray

public double[] toArray()
Default implementation of copying to an array.

Specified by:
toArray in interface DoubleContainer

toString

public java.lang.String toString()
Convert the contents of this container to a human-friendly string.

Overrides:
toString in class java.lang.Object


Copyright © 2011 Carrot Search s.c.. All Rights Reserved.