de.lmu.ifi.dbs.elki.distance.distanceresultlist

Class GenericDistanceDBIDList<D extends Distance<D>>

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distanceresultlist.GenericDistanceDBIDList<D>

Type Parameters:

D - Distance type

All Implemented Interfaces:

DBIDs, DistanceDBIDResult<D>, ModifiableDistanceDBIDResult<D>

public class GenericDistanceDBIDList<D extends Distance<D>>
extends Object
implements ModifiableDistanceDBIDResult<D>

Default class to keep a list of distance-object pairs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GenericDistanceDBIDList.Iter Iterator class.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ArrayList<DistanceDBIDPair<D>>	storage Actual storage.

Constructor Summary

Constructors

Constructor and Description
GenericDistanceDBIDList() Constructor.
GenericDistanceDBIDList(int initialCapacity) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(D dist, DBIDRef id) Add an object to this result.
void	add(DistanceDBIDPair<D> pair) Add a prepared pair.
boolean	contains(DBIDRef o) Test whether an ID is contained.
DistanceDBIDPair<D>	get(int off) Access a single pair.
boolean	isEmpty() Test for an empty DBID collection.
DistanceDBIDResultIter<D>	iter() Get an iterator
int	size() Size of list.
void	sort() Sort the result in ascending order
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

storage

final ArrayList<DistanceDBIDPair<D extends Distance<D>>> storage

Actual storage.

Constructor Detail

GenericDistanceDBIDList

public GenericDistanceDBIDList()

Constructor.

GenericDistanceDBIDList

public GenericDistanceDBIDList(int initialCapacity)

Constructor.

Parameters:

initialCapacity - Capacity

Method Detail

add

public void add(D dist,
       DBIDRef id)

Description copied from interface: ModifiableDistanceDBIDResult

Add an object to this result.

Specified by:

add in interface ModifiableDistanceDBIDResult<D extends Distance<D>>

Parameters:

dist - Distance to add

id - DBID to add

add

public void add(DistanceDBIDPair<D> pair)

Add a prepared pair.

Parameters:

pair - Pair to add

sort

public void sort()

Description copied from interface: ModifiableDistanceDBIDResult

Sort the result in ascending order

Specified by:

sort in interface ModifiableDistanceDBIDResult<D extends Distance<D>>

size

public int size()

Description copied from interface: DistanceDBIDResult

Size of list.

Specified by:

size in interface DBIDs

Specified by:

size in interface DistanceDBIDResult<D extends Distance<D>>

Returns:

Size

get

public DistanceDBIDPair<D> get(int off)

Description copied from interface: DistanceDBIDResult

Access a single pair.

Specified by:

get in interface DistanceDBIDResult<D extends Distance<D>>

Parameters:

off - Offset

Returns:

Pair

iter

public DistanceDBIDResultIter<D> iter()

Description copied from interface: DistanceDBIDResult

Get an iterator

Specified by:

iter in interface DBIDs

Specified by:

iter in interface DistanceDBIDResult<D extends Distance<D>>

Returns:

New iterator

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.

toString

public String toString()

Overrides:

toString in class Object