de.lmu.ifi.dbs.elki.database.ids.generic

Class GenericHashSetModifiableDBIDs

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet<DBID>

de.lmu.ifi.dbs.elki.database.ids.generic.GenericHashSetModifiableDBIDs

All Implemented Interfaces:

DBIDs, HashSetDBIDs, HashSetModifiableDBIDs, ModifiableDBIDs, SetDBIDs, Serializable, Cloneable, Iterable<DBID>, Collection<DBID>, Set<DBID>

public class GenericHashSetModifiableDBIDs
extends HashSet<DBID>
implements HashSetModifiableDBIDs

Set-oriented implementation of a modifiable DBID collection. This should only be instantiated by a DBIDFactory! Use DBIDUtil.newHashSet()!

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Serial version

Constructor Summary

Constructors

Constructor and Description
GenericHashSetModifiableDBIDs() Constructor without extra hints
GenericHashSetModifiableDBIDs(DBIDs c) Constructor from existing DBIDs.
GenericHashSetModifiableDBIDs(int initialCapacity) Constructor with size hint.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(DBIDRef id) Add a single DBID to the collection.
boolean	addDBIDs(DBIDs ids) Add DBIDs to collection.
boolean	contains(DBIDRef o) Test whether an ID is contained.
DBIDMIter	iter() Get a DBID iterator (a more efficient API).
boolean	remove(DBIDRef id) Remove a single DBID from the collection.
boolean	removeDBIDs(DBIDs ids) Remove DBIDs from collection.
boolean	retainAll(DBIDs ids) Retain all elements that also are in the second set.

Methods inherited from class java.util.HashSet

add, clear, clone, contains, isEmpty, iterator, remove, size

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.database.ids.DBIDs

isEmpty, iterator, size

Methods inherited from interface de.lmu.ifi.dbs.elki.database.ids.ModifiableDBIDs

clear

Methods inherited from interface java.util.Set

addAll, containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version

See Also:

Constant Field Values

Constructor Detail

GenericHashSetModifiableDBIDs

public GenericHashSetModifiableDBIDs(int initialCapacity)

Constructor with size hint.

Parameters:

initialCapacity - Size hint

GenericHashSetModifiableDBIDs

public GenericHashSetModifiableDBIDs()

Constructor without extra hints

GenericHashSetModifiableDBIDs

public GenericHashSetModifiableDBIDs(DBIDs c)

Constructor from existing DBIDs.

Parameters:

c - Existing DBIDs.

Method Detail

addDBIDs

public boolean addDBIDs(DBIDs ids)

Description copied from interface: ModifiableDBIDs

Add DBIDs to collection.

Specified by:

addDBIDs in interface ModifiableDBIDs

Parameters:

ids - IDs to add.

Returns:

true when modified

removeDBIDs

public boolean removeDBIDs(DBIDs ids)

Description copied from interface: ModifiableDBIDs

Remove DBIDs from collection.

Specified by:

removeDBIDs in interface ModifiableDBIDs

Parameters:

ids - IDs to remove.

Returns:

true when modified

add

public boolean add(DBIDRef id)

Description copied from interface: ModifiableDBIDs

Add a single DBID to the collection.

Specified by:

add in interface ModifiableDBIDs

Parameters:

id - ID to add

remove

public boolean remove(DBIDRef id)

Description copied from interface: ModifiableDBIDs

Remove a single DBID from the collection.

Specified by:

remove in interface ModifiableDBIDs

Parameters:

id - ID to remove

retainAll

public boolean retainAll(DBIDs ids)

Description copied from interface: HashSetModifiableDBIDs

Retain all elements that also are in the second set.

Specified by:

retainAll in interface HashSetModifiableDBIDs

Parameters:

ids - second set

Returns:

true when modified

iter

public DBIDMIter iter()

Description copied from interface: DBIDs

Get a DBID iterator (a more efficient API). usage example:

 for(DBIDIter iter = ids.iter(); iter.valid(); iter.advance()) {
   DBID id = iter.getDBID();
 }
 
 

Specified by:

iter in interface DBIDs

Specified by:

iter in interface ModifiableDBIDs

Returns:

iterator

contains

public boolean contains(DBIDRef o)

Description copied from interface: DBIDs

Test whether an ID is contained.

Specified by:

contains in interface DBIDs

Parameters:

o - object to test

Returns:

true when contained