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

Class UnmodifiableArrayDBIDs

java.lang.Object

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

All Implemented Interfaces:

ArrayDBIDs, ArrayStaticDBIDs, DBIDs, StaticDBIDs

public class UnmodifiableArrayDBIDs
extends Object
implements ArrayStaticDBIDs

Unmodifiable wrapper for DBIDs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	UnmodifiableArrayDBIDs.UnmodifiableDBIDArrayIter Make an existing DBIDMIter unmodifiable.

Field Summary

Fields

Modifier and Type	Field and Description
private ArrayDBIDs	inner The DBIDs we wrap.

Constructor Summary

Constructors

Constructor and Description
UnmodifiableArrayDBIDs(ArrayDBIDs inner) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignVar(int index, DBIDVar var) Assign a DBID variable the value of position index.
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.
DBID	get(int i) Get the i'th entry (starting at 0) If possible, use an DBIDArrayIter via ArrayDBIDs.iter() instead!
boolean	isEmpty() Test for an empty DBID collection.
DBIDArrayIter	iter() Iterable
int	size() Size of the DBID "collection".
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

inner

private final ArrayDBIDs inner

The DBIDs we wrap.

Constructor Detail

UnmodifiableArrayDBIDs

public UnmodifiableArrayDBIDs(ArrayDBIDs inner)

Constructor.

Parameters:

inner - Inner DBID collection.

Method Detail

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

isEmpty

public boolean isEmpty()

Description copied from interface: DBIDs

Test for an empty DBID collection.

Specified by:

isEmpty in interface DBIDs

Returns:

true when empty.

iter

public DBIDArrayIter iter()

Description copied from interface: ArrayDBIDs

Iterable

Specified by:

iter in interface ArrayDBIDs

Specified by:

iter in interface DBIDs

Returns:

Iterator

size

public int size()

Description copied from interface: ArrayDBIDs

Size of the DBID "collection".

Specified by:

size in interface ArrayDBIDs

Specified by:

size in interface DBIDs

Returns:

size

toString

public String toString()

Overrides:

toString in class Object

get

public DBID get(int i)

Description copied from interface: ArrayDBIDs

Get the i'th entry (starting at 0) If possible, use an DBIDArrayIter via ArrayDBIDs.iter() instead!

Specified by:

get in interface ArrayDBIDs

Parameters:

i - Index

Returns:

DBID of i'th entry.

assignVar

public void assignVar(int index,
             DBIDVar var)

Description copied from interface: ArrayDBIDs

Assign a DBID variable the value of position index.

Specified by:

assignVar in interface ArrayDBIDs

Parameters:

index - Position

var - Variable to assign the value to.

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