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, IntegerDBIDs, SetDBIDs

 class IntegerDBIDVar
extends Object
implements DBIDVar, IntegerDBIDs

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!

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	IntegerDBIDVar.Itr 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
DBIDVar	assignVar(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.
DBIDVar	from(DBIDDataStore store, DBIDRef ref) Update variable from a data store.
DBID	get(int i) Deprecated.
int	internalGetIndex() Get the internal index.
protected void	internalSetIndex(int i) Internal set to integer.
boolean	isEmpty() Test for an empty DBID collection.
boolean	isSet() Test if the variable is well-defined.
IntegerDBIDVar.Itr	iter() Iterable
void	set(DBIDRef ref) Assign a new value for the reference.
void	setFirst(DBIDPair pair) Assign the first pair member to this variable.
void	setSecond(DBIDPair pair) Assign the second pair member to this variable.
int	size() Size of the DBID "collection".
ArrayDBIDs	slice(int begin, int end) Slice a subarray (as view, not copy!)
String	toString()
void	unset() Clear the contents.

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

setFirst

public void setFirst(DBIDPair pair)

Description copied from interface: DBIDVar

Assign the first pair member to this variable.

Specified by:

setFirst in interface DBIDVar

Parameters:

pair - Pair

setSecond

public void setSecond(DBIDPair pair)

Description copied from interface: DBIDVar

Assign the second pair member to this variable.

Specified by:

setSecond in interface DBIDVar

Parameters:

pair - Pair

get

@Deprecated
public DBID get(int i)

Deprecated.

Description copied from interface: ArrayDBIDs

Get the i'th entry (starting at 0) If possible, use an DBIDArrayIter via ArrayDBIDs.iter() instead, or an DBIDVar via ArrayDBIDs.assignVar(int, de.lmu.ifi.dbs.elki.database.ids.DBIDVar)

Specified by:

get in interface ArrayDBIDs

Parameters:

i - Index

Returns:

DBID of i'th entry.

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

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.

unset

public void unset()

Description copied from interface: DBIDVar

Clear the contents.

Specified by:

unset in interface DBIDVar

isSet

public boolean isSet()

Description copied from interface: DBIDVar

Test if the variable is well-defined.

Specified by:

isSet in interface DBIDVar

Returns:

true when assigned.

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 unsorted arrays, the result is undefined. 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

assignVar

public DBIDVar assignVar(int i,
                DBIDVar var)

Description copied from interface: ArrayDBIDs

Assign a DBID variable the value of position index.

Specified by:

assignVar in interface ArrayDBIDs

Parameters:

i - Position

var - Variable to assign the value to.

from

public DBIDVar from(DBIDDataStore store,
           DBIDRef ref)

Description copied from interface: DBIDVar

Update variable from a data store.

Specified by:

from in interface DBIDVar

Parameters:

store - Data store

ref - Reference

Returns:

Self, for inlining.

slice

public ArrayDBIDs slice(int begin,
               int end)

Description copied from interface: ArrayDBIDs

Slice a subarray (as view, not copy!)

Specified by:

slice in interface ArrayDBIDs

Parameters:

begin - Begin (inclusive)

end - End (exclusive)

Returns:

Array slice.

toString

public String toString()

Overrides:

toString in class Object

iter

public IntegerDBIDVar.Itr iter()

Description copied from interface: ArrayDBIDs

Iterable

Specified by:

iter in interface ArrayDBIDs

Specified by:

iter in interface DBIDs

Specified by:

iter in interface IntegerDBIDs

Returns:

Iterator