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

Interface DBIDVar

All Superinterfaces:

ArrayDBIDs, DBIDRef, DBIDs, SetDBIDs

All Known Implementing Classes:

IntegerDBIDVar

public interface DBIDVar
extends DBIDRef, ArrayDBIDs, SetDBIDs

(Persistent) variable storing a DBID reference.

In contrast to the DBIDRef API, which are read-only references, this variable can be updated to point to a different DBID, e.g. the current best candidate.

Since:

0.5.5

Author:

Erich Schubert

Method Summary

Modifier and Type	Method and Description
DBIDVar	from(DBIDDataStore store, DBIDRef ref) Update variable from a data store.
boolean	isSet() Test if the variable is well-defined.
DBIDVar	set(DBIDRef ref) Assign a new value for the reference.
void	unset() Clear the contents.

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

equals, hashCode, internalGetIndex

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

assignVar, binarySearch, get, iter, size, slice

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

contains, forEach, isEmpty

Method Detail

set

DBIDVar set(DBIDRef ref)

Assign a new value for the reference.

Parameters:

ref - Reference

Returns:

this, for inlining.

from

DBIDVar from(DBIDDataStore store,
             DBIDRef ref)

Update variable from a data store.

Parameters:

store - Data store

ref - Reference

Returns:

this, for inlining.

unset

void unset()

Clear the contents.

isSet

boolean isSet()

Test if the variable is well-defined.

Returns:

true when assigned.