jsat.linear.vectorcollection

Interface VectorCollection<V extends Vec>

All Superinterfaces:

Cloneable, Serializable

All Known Subinterfaces:

IncrementalCollection<V>

All Known Implementing Classes:

CoverTree, EuclideanCollection, KDTree, RandomBallCover, RandomBallCoverOneShot, RandomProjectionLSH, RTree, VectorArray, VPTree, VPTreeMV

public interface VectorCollection<V extends Vec>
extends Cloneable, Serializable

A Vector Collection is a collection of vectors that is meant to be used to obtain a subset of the collection via a query vector. A query can be for the nearest neighbors, or for all vectors within a given range.
Different vector collections have different performance properties for both training and execution time.

Author:

Edward Raff

Method Summary

Modifier and Type	Method and Description
VectorCollection<V>	clone()
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

Method Detail

search

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.

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

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

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

size

int size()

Returns the number of vectors stored in the collection

Returns:

the size of the collection

clone

VectorCollection<V> clone()