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

Class DoubleDistanceDBIDPairKNNList

java.lang.Object

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

All Implemented Interfaces:

DBIDs, DistanceDBIDList<DoubleDistance>, DoubleDistanceKNNList, KNNList<DoubleDistance>

public class DoubleDistanceDBIDPairKNNList
extends Object
implements DoubleDistanceKNNList

Finalized KNN List.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DoubleDistanceDBIDPairKNNList.Itr Iterator.

Field Summary

Fields

Modifier and Type	Field and Description
private DoubleDistanceDBIDPair[]	data The actual data array.
private int	k The value of k this was materialized for.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DoubleDistanceDBIDPairKNNList(Collection<DoubleDistanceDBIDPair> col, int k) Constructor.
protected	DoubleDistanceDBIDPairKNNList(DoubleDistanceDBIDPairKNNHeap heap) Constructor, to be called from KNNHeap only.
	DoubleDistanceDBIDPairKNNList(Heap<DoubleDistanceDBIDPair> heap, int k) Constructor, to be called from KNNHeap only.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(DBIDRef o) Test whether an ID is contained.
double	doubleKNNDistance() Get the kNN distance as double value.
DoubleDistanceDBIDPair	get(int index) Direct object access.
int	getK() Get the K parameter (note: this may be less than the size of the list!)
DoubleDistance	getKNNDistance() Deprecated.
boolean	isEmpty() Test for an empty DBID collection.
DoubleDistanceDBIDListIter	iter() Get an iterator
int	size() Size
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

k

private final int k

The value of k this was materialized for.

data

private final DoubleDistanceDBIDPair[] data

The actual data array.

Constructor Detail

DoubleDistanceDBIDPairKNNList

public DoubleDistanceDBIDPairKNNList(Collection<DoubleDistanceDBIDPair> col,
                             int k)

Constructor. This will clone the given collection!

Parameters:

col - Existing collection

k - K parameter

DoubleDistanceDBIDPairKNNList

protected DoubleDistanceDBIDPairKNNList(DoubleDistanceDBIDPairKNNHeap heap)

Constructor, to be called from KNNHeap only. Use KNNHeap.toKNNList() instead!

Parameters:

heap - Calling heap

DoubleDistanceDBIDPairKNNList

public DoubleDistanceDBIDPairKNNList(Heap<DoubleDistanceDBIDPair> heap,
                             int k)

Constructor, to be called from KNNHeap only. Use KNNHeap.toKNNList() instead!

Parameters:

heap - Calling heap

k - Target number of neighbors (before ties)

Method Detail

getK

public int getK()

Description copied from interface: KNNList

Get the K parameter (note: this may be less than the size of the list!)

Specified by:

getK in interface KNNList<DoubleDistance>

Returns:

K

getKNNDistance

@Deprecated
public DoubleDistance getKNNDistance()

Deprecated.

Description copied from interface: DoubleDistanceKNNList

Get the distance to the k nearest neighbor, or maxdist otherwise.

Specified by:

getKNNDistance in interface DoubleDistanceKNNList

Specified by:

getKNNDistance in interface KNNList<DoubleDistance>

Returns:

Maximum distance

doubleKNNDistance

public double doubleKNNDistance()

Description copied from interface: DoubleDistanceKNNList

Get the kNN distance as double value.

Specified by:

doubleKNNDistance in interface DoubleDistanceKNNList

Returns:

Distance

toString

public String toString()

Overrides:

toString in class Object

get

public DoubleDistanceDBIDPair get(int index)

Description copied from interface: KNNList

Direct object access.

Specified by:

get in interface DistanceDBIDList<DoubleDistance>

Specified by:

get in interface DoubleDistanceKNNList

Specified by:

get in interface KNNList<DoubleDistance>

Parameters:

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

Returns:

New iterator

size

public int size()

Description copied from interface: KNNList

Size

Specified by:

size in interface DBIDs

Specified by:

size in interface DistanceDBIDList<DoubleDistance>

Specified by:

size in interface KNNList<DoubleDistance>

Returns:

Size

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.