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

Interface DBIDFactory

All Known Implementing Classes:

AbstractIntegerDBIDFactory, ReusingDBIDFactory, SimpleDBIDFactory, TrivialDBIDFactory

public interface DBIDFactory

Factory interface for generating DBIDs. See FACTORY for the static instance to use.

Field Summary

Fields

Modifier and Type	Field and Description
static DBIDFactory	FACTORY Static DBID factory to use.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignVar(DBIDVar var, int val) Assign an integer value to a DBID variable.
int	compare(DBIDRef a, DBIDRef b) Compare two DBIDs, for sorting.
void	deallocateDBIDRange(DBIDRange range) Deallocate a static DBID range.
void	deallocateSingleDBID(DBIDRef id) Return a single DBID for reuse.
boolean	equal(DBIDRef a, DBIDRef b) Compare two DBIDs, for equality testing.
DBID	generateSingleDBID() Generate a single DBID.
DBIDRange	generateStaticDBIDRange(int size) Generate a static DBID range.
ByteBufferSerializer<DBID>	getDBIDSerializer() Get a serializer for DBIDs.
FixedSizeByteBufferSerializer<DBID>	getDBIDSerializerStatic() Get a serializer for DBIDs with static size.
Class<? extends DBID>	getTypeRestriction() Get type restriction.
DBID	importInteger(int id) Import and integer as DBID.
DBIDRef	invalid() Get the invalid DBID value, usable as "undefined" placeholder.
ArrayModifiableDBIDs	newArray() Make a new (modifiable) array of DBIDs.
ArrayModifiableDBIDs	newArray(DBIDs existing) Make a new (modifiable) array of DBIDs.
ArrayModifiableDBIDs	newArray(int size) Make a new (modifiable) array of DBIDs.
<D extends Distance<D>> DistanceDBIDPair<D>	newDistancePair(D val, DBIDRef id) Make a new distance-DBID pair.
DoubleDistanceDBIDPair	newDistancePair(double val, DBIDRef id) Make a new distance-DBID pair.
DoubleDistanceKNNHeap	newDoubleDistanceHeap(int k) Create an appropriate heap for double distances.
HashSetModifiableDBIDs	newHashSet() Make a new (modifiable) hash set of DBIDs.
HashSetModifiableDBIDs	newHashSet(DBIDs existing) Make a new (modifiable) hash set of DBIDs.
HashSetModifiableDBIDs	newHashSet(int size) Make a new (modifiable) hash set of DBIDs.
<D extends Distance<D>> KNNHeap<D>	newHeap(D factory, int k) Create an appropriate heap for the distance function.
<D extends Distance<D>> KNNHeap<D>	newHeap(KNNList<D> exist) Build a new heap from a given list.
DBIDPair	newPair(DBIDRef id1, DBIDRef id2) Make a DBID pair from two existing DBIDs.
DoubleDBIDPair	newPair(double val, DBIDRef id) Make a double-DBID pair.
DBIDVar	newVar(DBIDRef val) Make a new DBID variable.
String	toString(DBIDRef id) Print a DBID as string.

Field Detail

FACTORY

static final DBIDFactory FACTORY

Static DBID factory to use.

Method Detail

newVar

DBIDVar newVar(DBIDRef val)

Make a new DBID variable.

Parameters:

val - Initial value.

Returns:

Variable

importInteger

DBID importInteger(int id)

Import and integer as DBID. Note: this may not be possible for some factories!

Parameters:

id - Integer ID to import

Returns:

DBID

assignVar

void assignVar(DBIDVar var,
             int val)

Assign an integer value to a DBID variable. Note: this may not be possible for some factories!

Parameters:

var - Variable

val - Integer value

generateSingleDBID

DBID generateSingleDBID()

Generate a single DBID.

Returns:

A single DBID

deallocateSingleDBID

void deallocateSingleDBID(DBIDRef id)

Return a single DBID for reuse.

Parameters:

id - DBID to deallocate

generateStaticDBIDRange

DBIDRange generateStaticDBIDRange(int size)

Generate a static DBID range.

Parameters:

size - Requested size

Returns:

DBID range

deallocateDBIDRange

void deallocateDBIDRange(DBIDRange range)

Deallocate a static DBID range.

Parameters:

range - Range to deallocate

newPair

DBIDPair newPair(DBIDRef id1,
               DBIDRef id2)

Make a DBID pair from two existing DBIDs.

Parameters:

id1 - first DBID

id2 - second DBID

Returns:

new pair.

newPair

DoubleDBIDPair newPair(double val,
                     DBIDRef id)

Make a double-DBID pair.

Parameters:

val - Double value

id - DBID

Returns:

New pair

newDistancePair

<D extends Distance<D>> DistanceDBIDPair<D> newDistancePair(D val,
                                                          DBIDRef id)

Make a new distance-DBID pair.

Type Parameters:

D - Distance type

Parameters:

val - Distance value

id - Object ID

Returns:

New pair

newDistancePair

DoubleDistanceDBIDPair newDistancePair(double val,
                                     DBIDRef id)

Make a new distance-DBID pair.

Parameters:

val - Distance value

id - Object ID

Returns:

New pair

newArray

ArrayModifiableDBIDs newArray()

Make a new (modifiable) array of DBIDs.

Returns:

New array

newHashSet

HashSetModifiableDBIDs newHashSet()

Make a new (modifiable) hash set of DBIDs.

Returns:

New hash set

newArray

ArrayModifiableDBIDs newArray(int size)

Make a new (modifiable) array of DBIDs.

Parameters:

size - Size hint

Returns:

New array

newHashSet

HashSetModifiableDBIDs newHashSet(int size)

Make a new (modifiable) hash set of DBIDs.

Parameters:

size - Size hint

Returns:

New hash set

newArray

ArrayModifiableDBIDs newArray(DBIDs existing)

Make a new (modifiable) array of DBIDs.

Parameters:

existing - existing DBIDs to use

Returns:

New array

newHashSet

HashSetModifiableDBIDs newHashSet(DBIDs existing)

Make a new (modifiable) hash set of DBIDs.

Parameters:

existing - existing DBIDs to use

Returns:

New hash set

newHeap

<D extends Distance<D>> KNNHeap<D> newHeap(D factory,
                                         int k)

Create an appropriate heap for the distance function. This will use a double heap if appropriate.

Type Parameters:

D - distance type

Parameters:

factory - distance prototype

k - K value

Returns:

New heap of size k, appropriate for this distance type.

newHeap

<D extends Distance<D>> KNNHeap<D> newHeap(KNNList<D> exist)

Build a new heap from a given list.

Type Parameters:

D - Distance type

Parameters:

exist - Existing result

Returns:

New heap

newDoubleDistanceHeap

DoubleDistanceKNNHeap newDoubleDistanceHeap(int k)

Create an appropriate heap for double distances.

Parameters:

k - K value

Returns:

New heap of size k, appropriate for this distance type.

getDBIDSerializer

ByteBufferSerializer<DBID> getDBIDSerializer()

Get a serializer for DBIDs.

Returns:

DBID serializer

getDBIDSerializerStatic

FixedSizeByteBufferSerializer<DBID> getDBIDSerializerStatic()

Get a serializer for DBIDs with static size.

Returns:

DBID serializer

getTypeRestriction

Class<? extends DBID> getTypeRestriction()

Get type restriction.

Returns:

type restriction for DBIDs

compare

int compare(DBIDRef a,
          DBIDRef b)

Compare two DBIDs, for sorting.

Parameters:

a - First

b - Second

Returns:

Comparison result

equal

boolean equal(DBIDRef a,
            DBIDRef b)

Compare two DBIDs, for equality testing.

Parameters:

a - First

b - Second

Returns:

Comparison result

toString

String toString(DBIDRef id)

Print a DBID as string.

Parameters:

id - DBID reference

Returns:

Formatted ID

invalid

DBIDRef invalid()

Get the invalid DBID value, usable as "undefined" placeholder.

Returns:

Invalid value