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

Class KNNSubList<D extends Distance<D>>

java.lang.Object

de.lmu.ifi.dbs.elki.database.ids.generic.KNNSubList<D>

Type Parameters:

D - Distance

All Implemented Interfaces:

DBIDs, DistanceDBIDList<D>, KNNList<D>

public class KNNSubList<D extends Distance<D>>
extends Object
implements KNNList<D>

Sublist of an existing result to contain only the first k elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	KNNSubList.Itr Iterator for the sublist.

Field Summary

Fields

Modifier and Type	Field and Description
private KNNList<D>	inner Wrapped inner result.
private int	k Parameter k.
private int	size Actual size, including ties.

Constructor Summary

Constructors

Constructor and Description
KNNSubList(KNNList<D> inner, int k) Constructor.

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.
DistanceDBIDListIter<D>	iter() Get an iterator
int	size() Size

Methods inherited from class java.lang.Object

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

Field Detail

k

private final int k

Parameter k.

size

private final int size

Actual size, including ties.

inner

private final KNNList<D extends Distance<D>> inner

Wrapped inner result.

Constructor Detail

KNNSubList

public KNNSubList(KNNList<D> inner,
          int k)

Constructor.

Parameters:

inner - Inner instance

k - k value

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

Returns:

K

get

public DistanceDBIDPair<D> get(int index)

Description copied from interface: KNNList

Direct object access.

Specified by:

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

Specified by:

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

Parameters:

index - Offset

Returns:

Pair

getKNNDistance

public D getKNNDistance()

Description copied from interface: KNNList

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

Specified by:

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

Returns:

Maximum distance

iter

public DistanceDBIDListIter<D> iter()

Description copied from interface: DistanceDBIDList

Get an iterator

Specified by:

iter in interface DBIDs

Specified by:

iter in interface DistanceDBIDList<D extends Distance<D>>

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.

size

public int size()

Description copied from interface: KNNList

Size

Specified by:

size in interface DBIDs

Specified by:

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

Specified by:

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

Returns:

Size