KDEuclideanMetricSpace

java.lang.Object
- edu.stanford.math.plex4.metric.impl.ObjectSearchableFiniteMetricSpace<double[]>
- - edu.stanford.math.plex4.kd.KDEuclideanMetricSpace

All Implemented Interfaces:

AbstractIntMetricSpace, AbstractObjectMetric<double[]>, AbstractObjectMetricSpace<double[]>, AbstractSearchableMetricSpace<double[]>
```
public class KDEuclideanMetricSpace
extends ObjectSearchableFiniteMetricSpace<double[]>
```
This class implements the AbstractSearchableMetricSpace interface for providing query functions for a Euclidean metric space. The underlying search operations are performed with the help of a KD-tree.

Author:

Andrew Tausz

Field Summary
- Fields inherited from class edu.stanford.math.plex4.metric.impl.ObjectSearchableFiniteMetricSpace
  elements

Constructor Summary

Constructors
Constructor and Description

KDEuclideanMetricSpace(double[][] dataPoints)

Constructors
Constructor and Description
`KDEuclideanMetricSpace(double[][] dataPoints)`

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`distance(double[] a, double[] b)` This function returns the distance between two points.
`double`	`distance(int i, int j)` This function returns the distance between the object at index i and the object at index j.
`gnu.trove.TIntHashSet`	`getClosedNeighborhood(double[] 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.
`double[]`	`getMaximumCoordinates()`
`double[]`	`getMinimumCoordinates()`
`int`	`getNearestPointIndex(double[] queryPoint)` This function returns the index of the point within the metric space nearest to the given query point.
`gnu.trove.TIntHashSet`	`getOpenNeighborhood(double[] 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.
`double[]`	`getPoint(int index)` This function returns the point at the specified index.
`double[][]`	`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 edu.stanford.math.plex4.metric.impl.ObjectSearchableFiniteMetricSpace
getKNearestNeighbors

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

- Constructor Detail
  - KDEuclideanMetricSpace
```
public KDEuclideanMetricSpace(double[][] dataPoints)
```
- Method Detail
  - getPoints
```
public double[][] 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<double[]>
    
    Overrides:
    
    getPoints in class ObjectSearchableFiniteMetricSpace<double[]>
    
    Returns:
    an array containing the points of the metric space
  - getNearestPointIndex
```
public int getNearestPointIndex(double[] 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<double[]>
    
    Overrides:
    
    getNearestPointIndex in class ObjectSearchableFiniteMetricSpace<double[]>
    
    Parameters:
    queryPoint - the query point
    
    Returns:
    the index of the nearest point in the metric space
  - getOpenNeighborhood
```
public gnu.trove.TIntHashSet getOpenNeighborhood(double[] 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<double[]>
    
    Overrides:
    
    getOpenNeighborhood in class ObjectSearchableFiniteMetricSpace<double[]>
    
    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(double[] 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<double[]>
    
    Overrides:
    
    getClosedNeighborhood in class ObjectSearchableFiniteMetricSpace<double[]>
    
    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
  - 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
    
    Overrides:
    
    size in class ObjectSearchableFiniteMetricSpace<double[]>
    
    Returns:
    the number of points in the metric space.
  - distance
```
public double distance(double[] a,
              double[] b)
```
    Description copied from interface: AbstractObjectMetric
    
    This function returns the distance between two points.
    
    Specified by:
    
    distance in interface AbstractObjectMetric<double[]>
    
    Specified by:
    
    distance in class ObjectSearchableFiniteMetricSpace<double[]>
    
    Parameters:
    a - the first point
    b - the second point
    
    Returns:
    the distance between the two points
  - getPoint
```
public double[] getPoint(int index)
```
    Description copied from interface: AbstractObjectMetricSpace
    
    This function returns the point at the specified index.
    
    Specified by:
    
    getPoint in interface AbstractObjectMetricSpace<double[]>
    
    Overrides:
    
    getPoint in class ObjectSearchableFiniteMetricSpace<double[]>
    
    Parameters:
    index - the index of the point to retrieve
    
    Returns:
    the point at the given index
  - 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
    
    Overrides:
    
    distance in class ObjectSearchableFiniteMetricSpace<double[]>
    
    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
  - getMaximumCoordinates
```
public double[] getMaximumCoordinates()
```
  - getMinimumCoordinates
```
public double[] getMinimumCoordinates()
```

Class KDEuclideanMetricSpace

Field Summary

Fields inherited from class edu.stanford.math.plex4.metric.impl.ObjectSearchableFiniteMetricSpace

Constructor Summary

Method Summary

Methods inherited from class edu.stanford.math.plex4.metric.impl.ObjectSearchableFiniteMetricSpace

Methods inherited from class java.lang.Object

Constructor Detail

KDEuclideanMetricSpace

Method Detail

getPoints

getNearestPointIndex

getOpenNeighborhood

getClosedNeighborhood

size

distance

getPoint

distance

getMaximumCoordinates

getMinimumCoordinates