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

Class DoubleDistanceKNNSubList

java.lang.Object

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

All Implemented Interfaces:

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

public class DoubleDistanceKNNSubList
extends Object
implements DoubleDistanceKNNList

Sublist of an existing result to contain only the first k elements. TOOD: can be optimized slightly better.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private DoubleDistanceKNNList	inner Wrapped inner result.
private int	k Parameter k.
private int	size Actual size, including ties.

Constructor Summary

Constructors

Constructor and Description
DoubleDistanceKNNSubList(DoubleDistanceKNNList inner, int k) Constructor.

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

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

Wrapped inner result.

Constructor Detail

DoubleDistanceKNNSubList

public DoubleDistanceKNNSubList(DoubleDistanceKNNList 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<DoubleDistance>

Returns:

K

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

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

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

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

Specified by:

size in interface KNNList<DoubleDistance>

Returns:

Size