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

Class IntegerDBIDVar

java.lang.Object

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

All Implemented Interfaces:

ArrayDBIDs, DBIDRef, DBIDs, DBIDVar, SetDBIDs

 class IntegerDBIDVar
extends Object
implements DBIDVar

Variable for storing a single DBID reference. TODO: what is the actual memory cost for adding a flag to indicate "null" values, to allow the variable to be unset? Given 8-byte alignment of Java, it should come for free!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	IntegerDBIDVar.DBIDItr Pseudo iterator for DBIDs interface.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	id The actual value.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntegerDBIDVar() Constructor.
protected	IntegerDBIDVar(DBIDRef val) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(int i, 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!
int	internalGetIndex() Get the internal index.
protected void	internalSetIndex(int i) Internal set to integer.
boolean	isEmpty() Test for an empty DBID collection.
DBIDArrayIter	iter() Iterable
void	set(DBIDRef ref) Assign a new value for the reference.
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

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

equals, hashCode

Field Detail

id

int id

The actual value.

Constructor Detail

IntegerDBIDVar

protected IntegerDBIDVar()

Constructor.

IntegerDBIDVar

protected IntegerDBIDVar(DBIDRef val)

Constructor.

Parameters:

val -

Method Detail

internalGetIndex

public int internalGetIndex()

Description copied from interface: DBIDRef

Get the internal index. NOT FOR PUBLIC USE - ELKI Optimization engine only

Specified by:

internalGetIndex in interface DBIDRef

Returns:

Internal index

internalSetIndex

protected void internalSetIndex(int i)

Internal set to integer.

Parameters:

i - integer value

set

public void set(DBIDRef ref)

Description copied from interface: DBIDVar

Assign a new value for the reference.

Specified by:

set in interface DBIDVar

Parameters:

ref - Reference

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.

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

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

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.

assign

public void assign(int i,
          DBIDVar var)

Description copied from interface: ArrayDBIDs

Assign a DBID variable the value of position index.

Specified by:

assign in interface ArrayDBIDs

Parameters:

i - Position

var - Variable to assign the value to.

toString

public String toString()

Overrides:

toString in class Object