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

Class TroveArrayDBIDs

java.lang.Object

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

All Implemented Interfaces:

ArrayDBIDs, DBIDs, IntegerArrayDBIDs, IntegerDBIDs

Direct Known Subclasses:

TroveArrayModifiableDBIDs

public abstract class TroveArrayDBIDs
extends Object
implements IntegerArrayDBIDs

Abstract base class for GNU Trove array based lists.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TroveArrayDBIDs.DBIDItr Iterate over a Trove IntList, ELKI/C-style.

Constructor Summary

Constructors

Constructor and Description
TroveArrayDBIDs()

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 index) Get the i'th entry (starting at 0) If possible, use an DBIDArrayIter via ArrayDBIDs.iter() instead!
protected abstract gnu.trove.list.TIntList	getStore() Get the array store.
boolean	isEmpty() Test for an empty DBID collection.
IntegerDBIDArrayMIter	iter() Get a DBID iterator (a more efficient API).
int	size() Retrieve the collection / data size.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TroveArrayDBIDs

public TroveArrayDBIDs()

Method Detail

getStore

protected abstract gnu.trove.list.TIntList getStore()

Get the array store.

Returns:

the store

iter

public IntegerDBIDArrayMIter iter()

Description copied from interface: DBIDs

Get a DBID iterator (a more efficient API). usage example:

 for(DBIDIter iter = ids.iter(); iter.valid(); iter.advance()) {
   DBID id = iter.getDBID();
 }
 
 

Specified by:

iter in interface ArrayDBIDs

Specified by:

iter in interface DBIDs

Specified by:

iter in interface IntegerArrayDBIDs

Specified by:

iter in interface IntegerDBIDs

Returns:

iterator

get

public DBID get(int index)

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:

index - 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.

size

public int size()

Description copied from interface: DBIDs

Retrieve the collection / data size.

Specified by:

size in interface ArrayDBIDs

Specified by:

size in interface DBIDs

Returns:

collection 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.

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

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

toString

public String toString()

Overrides:

toString in class Object