de.lmu.ifi.dbs.elki.utilities.datastructures.hash

Class Unique<E>

java.lang.Object

gnu.trove.impl.hash.THash

gnu.trove.impl.hash.TObjectHash<E>

de.lmu.ifi.dbs.elki.utilities.datastructures.hash.Unique<E>

Type Parameters:

E -

All Implemented Interfaces:

Externalizable, Serializable

public class Unique<E>
extends gnu.trove.impl.hash.TObjectHash<E>

This hash set is designed to keep only a unique copy of each object (hence its name). For this, the method addOrGet(E) is the key API, which allows retrieving existing values.

Since:

0.7.0

Author:

Erich Schubert

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static long	serialVersionUID Serial version number.

Fields inherited from class gnu.trove.impl.hash.TObjectHash

_set, consumeFreeSlot, FREE, REMOVED

Fields inherited from class gnu.trove.impl.hash.THash

_autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR

Constructor Summary

Constructors

Constructor and Description
Unique() Constructor with default size and load factors.
Unique(int initialCapacity) Constructor with desired initial size.
Unique(int initialCapacity, float loadFactor) Constructor with desired initial size, and with the specified load factor.

Method Summary

Methods

Modifier and Type	Method and Description
E	addOrGet(E obj) Inserts a value into the set, unless it is already present.
void	clear()
protected void	rehash(int newCapacity)
boolean	remove(Object obj) Removes an existing object from the set.

Methods inherited from class gnu.trove.impl.hash.TObjectHash

buildObjectContractViolation, capacity, contains, dumpExtraInfo, equals, forEach, hash, index, insertionIndex, insertKey, objectInfo, readExternal, removeAt, reportPotentialConcurrentMod, setUp, throwObjectContractViolation, throwObjectContractViolation, writeExternal

Methods inherited from class gnu.trove.impl.hash.THash

calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, getAutoCompactionFactor, isEmpty, postInsertHook, reenableAutoCompaction, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

static final long serialVersionUID

Serial version number.

See Also:

Constant Field Values

Constructor Detail

Unique

public Unique()

Constructor with default size and load factors.

Unique

public Unique(int initialCapacity)

Constructor with desired initial size.

Parameters:

initialCapacity - desired initial size.

Unique

public Unique(int initialCapacity,
      float loadFactor)

Constructor with desired initial size, and with the specified load factor.

Parameters:

initialCapacity - desired initial size

loadFactor - load factor

Method Detail

addOrGet

public E addOrGet(E obj)

Inserts a value into the set, unless it is already present. This function returns the existing value, if present.

Parameters:

obj - Object to insert or retrieve

Returns:

Existing object if already present, or the new object.

remove

public boolean remove(Object obj)

Removes an existing object from the set.

Parameters:

obj - Object to remove

Returns:

true if the object was found and removed.

clear

public void clear()

Overrides:

clear in class gnu.trove.impl.hash.THash

rehash

protected void rehash(int newCapacity)

Specified by:

rehash in class gnu.trove.impl.hash.THash