org.openimaj.knn

Class CoordinateBruteForce<T extends Coordinate>

java.lang.Object

org.openimaj.knn.CoordinateBruteForce<T>

Type Parameters:

T - the type of Coordinate

All Implemented Interfaces:

CoordinateIndex<T>

public class CoordinateBruteForce<T extends Coordinate>
extends Object
implements CoordinateIndex<T>

Implementation of a CoordinateIndex that performs searching by brute-force comparison over the indexed coordinates.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
CoordinateBruteForce() Default constructor.
CoordinateBruteForce(List<T> data) Construct the index and populate it with the given data.

Method Summary

Methods

Modifier and Type	Method and Description
void	insert(T point) Insert a single coordinate into the index.
void	kNearestNeighbour(Collection<T> result, Coordinate query, int k) Find the k nearest neighbour points in the index to the query coordinate.
T	nearestNeighbour(Coordinate query) Find the nearest coordinate in the index to the query coordinate.
void	rangeSearch(Collection<T> results, Coordinate lowerExtreme, Coordinate upperExtreme) Search for all the coordinates in the index that lie in the hyper-rectangle defined by the lower and upper bound coordinates.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoordinateBruteForce

public CoordinateBruteForce()

Default constructor. Creates an empty index.

CoordinateBruteForce

public CoordinateBruteForce(List<T> data)

Construct the index and populate it with the given data.

Parameters:

data - the data to add to the index.

Method Detail

insert

public void insert(T point)

Description copied from interface: CoordinateIndex

Insert a single coordinate into the index.

Specified by:

insert in interface CoordinateIndex<T extends Coordinate>

Parameters:

point - coordinate to add.

rangeSearch

public void rangeSearch(Collection<T> results,
               Coordinate lowerExtreme,
               Coordinate upperExtreme)

Description copied from interface: CoordinateIndex

Search for all the coordinates in the index that lie in the hyper-rectangle defined by the lower and upper bound coordinates. Store found coordinates in the results collection.

Specified by:

rangeSearch in interface CoordinateIndex<T extends Coordinate>

Parameters:

results - Collection to hold the found coordinates.

lowerExtreme - Lower bound of the hyper-rectangle.

upperExtreme - Upper bound of the hyper-rectangle.

nearestNeighbour

public T nearestNeighbour(Coordinate query)

Description copied from interface: CoordinateIndex

Find the nearest coordinate in the index to the query coordinate.

Specified by:

nearestNeighbour in interface CoordinateIndex<T extends Coordinate>

Parameters:

query - The query coordinate.

Returns:

the closest coordinate in the index.

kNearestNeighbour

public void kNearestNeighbour(Collection<T> result,
                     Coordinate query,
                     int k)

Description copied from interface: CoordinateIndex

Find the k nearest neighbour points in the index to the query coordinate. Store found coordinates in the results collection.

Specified by:

kNearestNeighbour in interface CoordinateIndex<T extends Coordinate>

Parameters:

result - Collection to hold the found coordinates.

query - The query coordinate.

k - The number of neighbours to find.