edu.stanford.math.plex4.metric.interfaces

Interface AbstractSearchableMetricSpace<T>

Type Parameters:

T - the type of the points in the metric space

All Superinterfaces:

AbstractIntMetricSpace, AbstractObjectMetric<T>, AbstractObjectMetricSpace<T>

All Known Implementing Classes:

EuclideanMetricSpace, ExplicitLandmarkSelector, ExplicitMetricSpace, KDEuclideanMetricSpace, LandmarkSelector, MaxMinLandmarkSelector, ObjectSearchableFiniteMetricSpace, RandomLandmarkSelector

public interface AbstractSearchableMetricSpace<T>
extends AbstractObjectMetricSpace<T>

This interface defines the functionality of a metric space with various querying capabilities.

Author:

Andrew Tausz

Method Summary

Methods

Modifier and Type	Method and Description
gnu.trove.TIntHashSet	getClosedNeighborhood(T queryPoint, double epsilon) This function returns the set of indices of points that are contained in the closed ball of radius epsilon, centered at the specified query point.
gnu.trove.TIntHashSet	getKNearestNeighbors(T queryPoint, int k) This function returns the indices of the k points that are closest to the given query point.
int	getNearestPointIndex(T queryPoint) This function returns the index of the point within the metric space nearest to the given query point.
gnu.trove.TIntHashSet	getOpenNeighborhood(T queryPoint, double epsilon) This function returns the set of indices of points that are contained in the open ball of radius epsilon, centered at the specified query point.

Methods inherited from interface edu.stanford.math.plex4.metric.interfaces.AbstractObjectMetricSpace

getPoint, getPoints

Methods inherited from interface edu.stanford.math.plex4.metric.interfaces.AbstractIntMetricSpace

distance, size

Methods inherited from interface edu.stanford.math.plex4.metric.interfaces.AbstractObjectMetric

distance

Method Detail

getNearestPointIndex

int getNearestPointIndex(T queryPoint)

This function returns the index of the point within the metric space nearest to the given query point.

Parameters:

queryPoint - the query point

Returns:

the index of the nearest point in the metric space

getOpenNeighborhood

gnu.trove.TIntHashSet getOpenNeighborhood(T queryPoint,
                                        double epsilon)

This function returns the set of indices of points that are contained in the open ball of radius epsilon, centered at the specified query point. That is it returns all points satisfying d(p_i, q) < epsilon, where q is the query point.

Parameters:

queryPoint - the center of the open ball

epsilon - the radius of the open ball

Returns:

the set of indices of points contained in the open ball

getClosedNeighborhood

gnu.trove.TIntHashSet getClosedNeighborhood(T queryPoint,
                                          double epsilon)

This function returns the set of indices of points that are contained in the closed ball of radius epsilon, centered at the specified query point. That is it returns all points satisfying d(p_i, q) <= epsilon, where q is the query point.

Parameters:

queryPoint - the center of the closed ball

epsilon - the radius of the closed ball

Returns:

the set of indices of points contained in the closed ball

getKNearestNeighbors

gnu.trove.TIntHashSet getKNearestNeighbors(T queryPoint,
                                         int k)

This function returns the indices of the k points that are closest to the given query point.

Parameters:

queryPoint - the reference point

k - the number of nearest neighbors to get

Returns:

the k-nearest neighbors of the query point