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

Class GenericArrayModifiableDBIDs

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<DBID>

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

All Implemented Interfaces:

ArrayDBIDs, ArrayModifiableDBIDs, DBIDs, ModifiableDBIDs, Serializable, Cloneable, Iterable<DBID>, Collection<DBID>, List<DBID>, RandomAccess

public class GenericArrayModifiableDBIDs
extends ArrayList<DBID>
implements ArrayModifiableDBIDs

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

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
GenericArrayModifiableDBIDs() Constructor without extra hints
GenericArrayModifiableDBIDs(DBIDs c) Constructor from existing DBIDs.
GenericArrayModifiableDBIDs(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.
int	binarySearch(DBIDRef key) Search for the position of the given key, assuming that the data set is sorted.
boolean	contains(DBIDRef o) Test whether an ID is contained.
DBIDMIter	iter() Get a modifiable 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.
void	sort() Sort the DBID set.
void	sort(Comparator<? super DBID> comparator) Sort the DBID set.
void	swap(int a, int b) Swap DBIDs add positions a and b.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, 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.ArrayModifiableDBIDs

remove, set

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

clear

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

get, size

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

isEmpty, iterator

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial version

See Also:

Constant Field Values

Constructor Detail

GenericArrayModifiableDBIDs

public GenericArrayModifiableDBIDs(int initialCapacity)

Constructor with size hint.

Parameters:

initialCapacity - Size hint

GenericArrayModifiableDBIDs

public GenericArrayModifiableDBIDs()

Constructor without extra hints

GenericArrayModifiableDBIDs

public GenericArrayModifiableDBIDs(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

sort

public void sort()

Description copied from interface: ArrayModifiableDBIDs

Sort the DBID set.

Specified by:

sort in interface ArrayModifiableDBIDs

sort

public void sort(Comparator<? super DBID> comparator)

Description copied from interface: ArrayModifiableDBIDs

Sort the DBID set.

Specified by:

sort in interface ArrayModifiableDBIDs

Parameters:

comparator - Comparator to use

iter

public DBIDMIter iter()

Description copied from interface: ModifiableDBIDs

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

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

Specified by:

iter in interface ArrayDBIDs

Specified by:

iter in interface DBIDs

Specified by:

iter in interface ModifiableDBIDs

Returns:

modifiable iterator

binarySearch

public int binarySearch(DBIDRef key)

Description copied from interface: ArrayDBIDs

Search for the position of the given key, assuming that the data set is sorted. For keys not found, -(1+insertion position) is returned, as for Java Collections.binarySearch(java.util.List<? extends java.lang.Comparable<? super T>>, T)

Specified by:

binarySearch in interface ArrayDBIDs

Parameters:

key - Key to search for

Returns:

Offset of key

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

swap

public void swap(int a,
        int b)

Description copied from interface: ArrayModifiableDBIDs

Swap DBIDs add positions a and b.

Specified by:

swap in interface ArrayModifiableDBIDs

Parameters:

a - First position

b - Second position