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

Interface DBIDs

All Superinterfaces:

Iterable<DBID>

All Known Subinterfaces:

ArrayDBIDs, ArrayModifiableDBIDs, ArrayStaticDBIDs, DBID, DBIDRange, HashSetDBIDs, HashSetModifiableDBIDs, ModifiableDBIDs, SetDBIDs, StaticDBIDs

All Known Implementing Classes:

EmptyDBIDs, GenericArrayModifiableDBIDs, GenericHashSetModifiableDBIDs, IntegerArrayStaticDBIDs, IntegerDBID, IntegerDBIDRange, KNNUtil.DBIDView, MaskedDBIDs, MergedDBIDs, TroveArrayDBIDs, TroveArrayModifiableDBIDs, TroveArrayStaticDBIDs, TroveHashSetModifiableDBIDs, UnmodifiableDBIDs

public interface DBIDs
extends Iterable<DBID>

Interface for a collection of database references (IDs).

Method Summary

Methods

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

Method Detail

iterator

Iterator<DBID> iterator()

Retrieve Iterator access to the IDs.

Specified by:

iterator in interface Iterable<DBID>

Returns:

an iterator for the IDs

iter

DBIDIter iter()

Get a DBIDIterator (a more efficient API).

Returns:

iterator

size

int size()

Retrieve the collection / data size.

Returns:

collection size

contains

boolean contains(DBID 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.