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

Class KNNSubList

java.lang.Object

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

All Implemented Interfaces:

DBIDs, DoubleDBIDList, KNNList

public class KNNSubList
extends Object
implements KNNList

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

Author:

Erich Schubert

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	inner Wrapped inner result.
private int	k Parameter k.
private int	size Actual size, including ties.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(DBIDRef o) Test whether an ID is contained.
DoubleDBIDPair	get(int index) Direct object access.
int	getK() Get the K parameter (note: this may be less than the size of the list!)
double	getKNNDistance() Get the distance to the k nearest neighbor, or maxdist otherwise.
boolean	isEmpty() Test for an empty DBID collection.
DoubleDBIDListIter	iter() Get a DBID iterator (a more efficient API).
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 inner

Wrapped inner result.

Constructor Detail

KNNSubList

public KNNSubList(KNNList 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

Returns:

K

get

public DoubleDBIDPair get(int index)

Description copied from interface: KNNList

Direct object access.

Specified by:

get in interface DoubleDBIDList

Specified by:

get in interface KNNList

Parameters:

index - Offset

Returns:

Pair

getKNNDistance

public double getKNNDistance()

Description copied from interface: KNNList

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

Specified by:

getKNNDistance in interface KNNList

Returns:

Maximum distance

iter

public DoubleDBIDListIter iter()

Description copied from interface: DBIDs

Get a DBID iterator (a more efficient API). usage example:

 for(DBIDIter iter = ids.iter(); iter.valid(); iter.advance()) {
   DBID id = iter.getDBID();
 }
 
 

Specified by:

iter in interface DBIDs

Specified by:

iter in interface DoubleDBIDList

Returns:

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 DoubleDBIDList

Specified by:

size in interface KNNList

Returns:

collection size