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

Interface DBIDs

All Known Subinterfaces:

ArrayDBIDs, ArrayModifiableDBIDs, ArrayStaticDBIDs, DBID, DBIDRange, DBIDVar, DistanceDBIDList<D>, DoubleDistanceDBIDList, DoubleDistanceKNNList, HashSetDBIDs, HashSetModifiableDBIDs, IntegerArrayDBIDs, IntegerArrayStaticDBIDs, IntegerDBIDs, KNNList<D>, ModifiableDBIDs, ModifiableDistanceDBIDList<D>, ModifiableDoubleDistanceDBIDList, SetDBIDs, StaticDBIDs

All Known Implementing Classes:

ArrayModifiableIntegerDBIDs, ArrayModifiableIntegerDBIDs.Slice, ArrayStaticIntegerDBIDs, ArrayStaticIntegerDBIDs.Slice, DistanceDBIDPairKNNList, DoubleDistanceDBIDPairKNNList, DoubleDistanceDBIDPairKNNListHeap, DoubleDistanceDBIDPairList, DoubleDistanceIntegerDBIDKNNList, DoubleDistanceIntegerDBIDList, DoubleDistanceIntegerDBIDPairKNNListHeap, DoubleDistanceIntegerDBIDPairList, DoubleDistanceIntegerDBIDSortedKNNList, DoubleDistanceKNNSubList, EmptyDBIDs, GenericDistanceDBIDList, IntegerDBID, IntegerDBIDRange, IntegerDBIDVar, KNNSubList, MaskedDBIDs, MergedDBIDs, TroveHashSetModifiableDBIDs, UnmodifiableArrayDBIDs, UnmodifiableDBIDs, UnmodifiableIntegerArrayDBIDs, UnmodifiableIntegerDBIDs

public interface DBIDs

Interface for a collection of database references (IDs).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(DBIDRef o) Test whether an ID is contained.
boolean	isEmpty() Test for an empty DBID collection.
DBIDIter	iter() Get a DBID iterator (a more efficient API).
int	size() Retrieve the collection / data size.

Method Detail

iter

DBIDIter iter()

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

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

Returns:

iterator

size

int size()

Retrieve the collection / data size.

Returns:

collection size

contains

boolean contains(DBIDRef o)

Test whether an ID is contained.

Parameters:

o - object to test

Returns:

true when contained

isEmpty

boolean isEmpty()

Test for an empty DBID collection.

Returns:

true when empty.