jsat.linear.vectorcollection

Class RandomBallCover<V extends Vec>

java.lang.Object

jsat.linear.vectorcollection.RandomBallCover<V>

All Implemented Interfaces:

Serializable, Cloneable, IncrementalCollection<V>, VectorCollection<V>

public class RandomBallCover<V extends Vec>
extends Object
implements IncrementalCollection<V>

An implementation of the exact search for the Random Ball Cover algorithm. Unlike most algorithms, it attempts to satisfy queries in O(sqrt(n)) time. It does this to be more efficient in its computation and easily parallelizable. Construction time is O(n^3/2).
Unlike the original paper, which assumes single queries will be run in parallel, the algorithm has been modified to perform additional pruning and to support range queries.

See: Cayton, L. (2012). Accelerating Nearest Neighbor Search on Manycore Systems. 2012 IEEE 26th International Parallel and Distributed Processing Symposium, 402–413. doi:10.1109/IPDPS.2012.45

Author:

Edward Raff

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RandomBallCover.RandomBallCoverFactory<V extends Vec>

Constructor Summary

Constructors

Constructor and Description
RandomBallCover(DistanceMetric dm)
RandomBallCover(List<V> vecs, DistanceMetric dm) Creates a new Random Ball Cover
RandomBallCover(List<V> vecs, DistanceMetric dm, ExecutorService execServ) Creates a new Random Ball Cover

Method Summary

Modifier and Type	Method and Description
RandomBallCover<V>	clone()
void	insert(V x) Incrementally adds the given datapoint into the collection
List<? extends VecPaired<V,Double>>	search(Vec query, double range) Searches the space for all vectors that are within a given range of the query vector.
List<? extends VecPaired<V,Double>>	search(Vec query, int neighbors) Searches the space for the k neighbors that are closest to the given query vector
int	size() Returns the number of vectors stored in the collection

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomBallCover

public RandomBallCover(List<V> vecs,
                       DistanceMetric dm,
                       ExecutorService execServ)

Creates a new Random Ball Cover

Parameters:

vecs - the vectors to place into the RBC

dm - the distance metric to use

execServ - the source of threads for parallel construction

RandomBallCover

public RandomBallCover(List<V> vecs,
                       DistanceMetric dm)

Creates a new Random Ball Cover

Parameters:

vecs - the vectors to place into the RBC

dm - the distance metric to use

RandomBallCover

public RandomBallCover(DistanceMetric dm)

Method Detail

search

public List<? extends VecPaired<V,Double>> search(Vec query,
                                                  double range)

Description copied from interface: VectorCollection

Searches the space for all vectors that are within a given range of the query vector.

Specified by:

search in interface VectorCollection<V extends Vec>

Parameters:

query - the vector we want to find others near

range - the search range around our query

Returns:

the list of all vectors within the range of our query. The paired value contains the distance to the query vector.

search

public List<? extends VecPaired<V,Double>> search(Vec query,
                                                  int neighbors)

Description copied from interface: VectorCollection

Searches the space for the k neighbors that are closest to the given query vector

Specified by:

search in interface VectorCollection<V extends Vec>

Parameters:

query - the vector we want to find neighbors of

neighbors - the maximum number of neighbors to return

Returns:

the list the k nearest neighbors, in sorted order from closest to farthest. The paired value contains the distance to the query vector

insert

public void insert(V x)

Description copied from interface: IncrementalCollection

Incrementally adds the given datapoint into the collection

Specified by:

insert in interface IncrementalCollection<V extends Vec>

Parameters:

x - the vector to add to the collection

size

public int size()

Description copied from interface: VectorCollection

Returns the number of vectors stored in the collection

Specified by:

size in interface VectorCollection<V extends Vec>

Returns:

the size of the collection

clone

public RandomBallCover<V> clone()

Specified by:

clone in interface IncrementalCollection<V extends Vec>

Specified by:

clone in interface VectorCollection<V extends Vec>

Overrides:

clone in class Object