ObjectSearchableFiniteMetricSpace

java.lang.Object
- edu.stanford.math.plex4.metric.impl.ObjectSearchableFiniteMetricSpace<T>

Type Parameters:
T -

All Implemented Interfaces:

AbstractIntMetricSpace, AbstractObjectMetric<T>, AbstractObjectMetricSpace<T>, AbstractSearchableMetricSpace<T>

Direct Known Subclasses:

EuclideanMetricSpace, KDEuclideanMetricSpace
```
public abstract class ObjectSearchableFiniteMetricSpace<T>
extends java.lang.Object
implements AbstractSearchableMetricSpace<T>
```
This class implements the AbstractSearchableMetricSpace interface over type T. It stores the elements of the metric space as an array.

Author:

Andrew Tausz

Field Summary

Fields
Modifier and Type Field and Description

protected T[] elements
This array stores the elements in the metric space

Fields
Modifier and Type	Field and Description
`protected T[]`	`elements` This array stores the elements in the metric space

Constructor Summary

Constructors
Constructor and Description

ObjectSearchableFiniteMetricSpace(T[] array)
This constructor initializes the class with an array of elements.

Constructors
Constructor and Description
`ObjectSearchableFiniteMetricSpace(T[] array)` This constructor initializes the class with an array of elements.

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`distance(int i, int j)` This function returns the distance between the object at index i and the object at index j.
`abstract double`	`distance(T a, T b)` This function returns the distance between two points.
`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.
`T`	`getPoint(int index)` This function returns the point at the specified index.
`T[]`	`getPoints()` This function returns the set of points in the metric space as an array.
`int`	`size()` This function returns the number of points in the metric space.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - elements
```
protected final T[] elements
```
    This array stores the elements in the metric space
- Constructor Detail
  - ObjectSearchableFiniteMetricSpace
```
public ObjectSearchableFiniteMetricSpace(T[] array)
```
    This constructor initializes the class with an array of elements.
    
    Parameters:
    array - the array of elements that will be the points in the metric space
- Method Detail
  - getKNearestNeighbors
```
public gnu.trove.TIntHashSet getKNearestNeighbors(T queryPoint,
                                         int k)
```
    Description copied from interface: AbstractSearchableMetricSpace
    
    This function returns the indices of the k points that are closest to the given query point.
    
    Specified by:
    
    getKNearestNeighbors in interface AbstractSearchableMetricSpace<T>
    
    Parameters:
    queryPoint - the reference point
    k - the number of nearest neighbors to get
    
    Returns:
    the k-nearest neighbors of the query point
  - getNearestPointIndex
```
public int getNearestPointIndex(T queryPoint)
```
    Description copied from interface: AbstractSearchableMetricSpace
    
    This function returns the index of the point within the metric space nearest to the given query point.
    
    Specified by:
    
    getNearestPointIndex in interface AbstractSearchableMetricSpace<T>
    
    Parameters:
    queryPoint - the query point
    
    Returns:
    the index of the nearest point in the metric space
  - getOpenNeighborhood
```
public gnu.trove.TIntHashSet getOpenNeighborhood(T queryPoint,
                                        double epsilon)
```
    Description copied from interface: AbstractSearchableMetricSpace
    
    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.
    
    Specified by:
    
    getOpenNeighborhood in interface AbstractSearchableMetricSpace<T>
    
    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
```
public gnu.trove.TIntHashSet getClosedNeighborhood(T queryPoint,
                                          double epsilon)
```
    Description copied from interface: AbstractSearchableMetricSpace
    
    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.
    
    Specified by:
    
    getClosedNeighborhood in interface AbstractSearchableMetricSpace<T>
    
    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
  - distance
```
public abstract double distance(T a,
              T b)
```
    Description copied from interface: AbstractObjectMetric
    
    This function returns the distance between two points.
    
    Specified by:
    
    distance in interface AbstractObjectMetric<T>
    
    Parameters:
    a - the first point
    b - the second point
    
    Returns:
    the distance between the two points
  - getPoint
```
public T getPoint(int index)
```
    Description copied from interface: AbstractObjectMetricSpace
    
    This function returns the point at the specified index.
    
    Specified by:
    
    getPoint in interface AbstractObjectMetricSpace<T>
    
    Parameters:
    index - the index of the point to retrieve
    
    Returns:
    the point at the given index
  - getPoints
```
public T[] getPoints()
```
    Description copied from interface: AbstractObjectMetricSpace
    
    This function returns the set of points in the metric space as an array. The returned array satisfies the requirement that the indices of the points in the array are equal to the indices of the points within the metric space.
    
    Specified by:
    
    getPoints in interface AbstractObjectMetricSpace<T>
    
    Returns:
    an array containing the points of the metric space
  - distance
```
public double distance(int i,
              int j)
```
    Description copied from interface: AbstractIntMetricSpace
    
    This function returns the distance between the object at index i and the object at index j.
    
    Specified by:
    
    distance in interface AbstractIntMetricSpace
    
    Parameters:
    i - the index of the first object
    j - the index of the second object
    
    Returns:
    the distance between the objects at the two given indices
  - size
```
public int size()
```
    Description copied from interface: AbstractIntMetricSpace
    
    This function returns the number of points in the metric space.
    
    Specified by:
    
    size in interface AbstractIntMetricSpace
    
    Returns:
    the number of points in the metric space.

Class ObjectSearchableFiniteMetricSpace<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

elements

Constructor Detail

ObjectSearchableFiniteMetricSpace

Method Detail

getKNearestNeighbors

getNearestPointIndex

getOpenNeighborhood

getClosedNeighborhood

distance

getPoint

getPoints

distance

size