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

Class GenericKNNList<D extends Distance<D>>

java.lang.Object

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

Type Parameters:

D - Distance type

All Implemented Interfaces:

DBIDs, DistanceDBIDResult<D>, KNNResult<D>

public class GenericKNNList<D extends Distance<D>>
extends Object
implements KNNResult<D>

Finalized KNN List.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	GenericKNNList(Heap<? extends DistanceDBIDPair<D>> heap, int k) Constructor.
protected	GenericKNNList(KNNHeap<D> heap) 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.
DistanceDBIDPair<D>	get(int index) Direct object access.
int	getK() Get the K parameter (note: this may be less than the size of the list!)
D	getKNNDistance() Get the distance to the k nearest neighbor, or maxdist otherwise.
boolean	isEmpty() Test for an empty DBID collection.
DistanceDBIDResultIter<D>	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 Object[] data

The actual data array.

Constructor Detail

GenericKNNList

protected GenericKNNList(KNNHeap<D> heap)

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

Parameters:

heap - Calling heap

GenericKNNList

public GenericKNNList(Heap<? extends DistanceDBIDPair<D>> heap,
              int k)

Constructor. With a KNNHeap, use KNNHeap.toKNNList() instead!

Parameters:

heap - Calling heap

k - K value

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<D extends Distance<D>>

Returns:

K

getKNNDistance

public D getKNNDistance()

Description copied from interface: KNNResult

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

Specified by:

getKNNDistance in interface KNNResult<D extends Distance<D>>

Returns:

Maximum distance

toString

public String toString()

Overrides:

toString in class Object

get

public DistanceDBIDPair<D> get(int index)

Description copied from interface: KNNResult

Direct object access.

Specified by:

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

Specified by:

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

Parameters:

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

size

public int size()

Description copied from interface: KNNResult

Size

Specified by:

size in interface DBIDs

Specified by:

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

Specified by:

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

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.