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

Class DoubleDistanceDBIDList

java.lang.Object

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

All Implemented Interfaces:

DBIDs, DistanceDBIDResult<DoubleDistance>, ModifiableDistanceDBIDResult<DoubleDistance>

public class DoubleDistanceDBIDList
extends Object
implements ModifiableDistanceDBIDResult<DoubleDistance>

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	add(double dist, DBIDRef id) Add an element.
void	add(DoubleDistanceDBIDPair pair) Add an element.
void	add(DoubleDistance dist, DBIDRef id) Deprecated. Pass a double value instead.
boolean	contains(DBIDRef o) Test whether an ID is contained.
DoubleDistanceDBIDPair	get(int off) Access a single pair.
boolean	isEmpty() Test for an empty DBID collection.
DoubleDistanceDBIDResultIter	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<DoubleDistanceDBIDPair> storage

Actual storage.

Constructor Detail

DoubleDistanceDBIDList

public DoubleDistanceDBIDList()

Constructor.

DoubleDistanceDBIDList

public DoubleDistanceDBIDList(int initialCapacity)

Constructor.

Parameters:

initialCapacity - Capacity

Method Detail

add

@Deprecated
public void add(DoubleDistance dist,
                  DBIDRef id)

Deprecated. Pass a double value instead.

Add an element.

Specified by:

add in interface ModifiableDistanceDBIDResult<DoubleDistance>

Parameters:

dist - Distance

id - ID

add

public void add(double dist,
       DBIDRef id)

Add an element.

Parameters:

dist - Distance

id - ID

add

public void add(DoubleDistanceDBIDPair pair)

Add an element.

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<DoubleDistance>

size

public int size()

Description copied from interface: DistanceDBIDResult

Size of list.

Specified by:

size in interface DBIDs

Specified by:

size in interface DistanceDBIDResult<DoubleDistance>

Returns:

Size

get

public DoubleDistanceDBIDPair get(int off)

Description copied from interface: DistanceDBIDResult

Access a single pair.

Specified by:

get in interface DistanceDBIDResult<DoubleDistance>

Parameters:

off - Offset

Returns:

Pair

iter

public DoubleDistanceDBIDResultIter iter()

Description copied from interface: DistanceDBIDResult

Get an iterator

Specified by:

iter in interface DBIDs

Specified by:

iter in interface DistanceDBIDResult<DoubleDistance>

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