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

Class DoubleDistanceDBIDPairList

java.lang.Object

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

All Implemented Interfaces:

DBIDs, DistanceDBIDList<DoubleDistance>, DoubleDistanceDBIDList, ModifiableDistanceDBIDList<DoubleDistance>, ModifiableDoubleDistanceDBIDList

public class DoubleDistanceDBIDPairList
extends Object
implements ModifiableDoubleDistanceDBIDList

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DoubleDistanceDBIDPairList.Itr Iterator class.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DoubleDistanceDBIDPairList() Constructor.
DoubleDistanceDBIDPairList(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.
void	clear() Clear the list contents.
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.
DoubleDistanceDBIDListIter	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

DoubleDistanceDBIDPairList

public DoubleDistanceDBIDPairList()

Constructor.

DoubleDistanceDBIDPairList

public DoubleDistanceDBIDPairList(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 ModifiableDistanceDBIDList<DoubleDistance>

Specified by:

add in interface ModifiableDoubleDistanceDBIDList

Parameters:

dist - Distance

id - ID

add

public void add(double dist,
       DBIDRef id)

Add an element.

Specified by:

add in interface ModifiableDoubleDistanceDBIDList

Parameters:

dist - Distance

id - ID

add

public void add(DoubleDistanceDBIDPair pair)

Add an element.

Specified by:

add in interface ModifiableDoubleDistanceDBIDList

Parameters:

pair - Pair to add

clear

public void clear()

Description copied from interface: ModifiableDoubleDistanceDBIDList

Clear the list contents.

Specified by:

clear in interface ModifiableDoubleDistanceDBIDList

sort

public void sort()

Description copied from interface: ModifiableDistanceDBIDList

Sort the result in ascending order

Specified by:

sort in interface ModifiableDistanceDBIDList<DoubleDistance>

size

public int size()

Description copied from interface: DistanceDBIDList

Size of list.

Specified by:

size in interface DBIDs

Specified by:

size in interface DistanceDBIDList<DoubleDistance>

Returns:

Size

get

public DoubleDistanceDBIDPair get(int off)

Description copied from interface: DistanceDBIDList

Access a single pair.

Specified by:

get in interface DistanceDBIDList<DoubleDistance>

Specified by:

get in interface DoubleDistanceDBIDList

Parameters:

off - Offset

Returns:

Pair

iter

public DoubleDistanceDBIDListIter iter()

Description copied from interface: DistanceDBIDList

Get an iterator

Specified by:

iter in interface DBIDs

Specified by:

iter in interface DistanceDBIDList<DoubleDistance>

Specified by:

iter in interface DoubleDistanceDBIDList

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