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

Class DoubleDistanceKNNList

java.lang.Object

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

All Implemented Interfaces:

DBIDs, DistanceDBIDResult<DoubleDistance>, KNNResult<DoubleDistance>

public class DoubleDistanceKNNList
extends Object
implements KNNResult<DoubleDistance>

Finalized KNN List.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DoubleDistanceKNNList.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
	DoubleDistanceKNNList(Collection<DoubleDistanceDBIDPair> col, int k) Constructor.
protected	DoubleDistanceKNNList(DoubleDistanceKNNHeap heap) Constructor, to be called from KNNHeap only.
	DoubleDistanceKNNList(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. use doubleKNNDistance()!
boolean	isEmpty() Test for an empty DBID collection.
DoubleDistanceDBIDResultIter	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

DoubleDistanceKNNList

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

Constructor. This will clone the given collection!

Parameters:

col - Existing collection

k - K parameter

DoubleDistanceKNNList

protected DoubleDistanceKNNList(DoubleDistanceKNNHeap heap)

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

Parameters:

heap - Calling heap

DoubleDistanceKNNList

public DoubleDistanceKNNList(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: KNNResult

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

Specified by:

getK in interface KNNResult<DoubleDistance>

Returns:

K

getKNNDistance

@Deprecated
public DoubleDistance getKNNDistance()

Deprecated. use doubleKNNDistance()!

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

Specified by:

getKNNDistance in interface KNNResult<DoubleDistance>

Returns:

Maximum distance

doubleKNNDistance

public double doubleKNNDistance()

Get the kNN distance as double value.

Returns:

Distance

toString

public String toString()

Overrides:

toString in class Object

get

public DoubleDistanceDBIDPair get(int index)

Description copied from interface: KNNResult

Direct object access.

Specified by:

get in interface DistanceDBIDResult<DoubleDistance>

Specified by:

get in interface KNNResult<DoubleDistance>

Parameters:

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

size

public int size()

Description copied from interface: KNNResult

Size

Specified by:

size in interface DBIDs

Specified by:

size in interface DistanceDBIDResult<DoubleDistance>

Specified by:

size in interface KNNResult<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.