jsat.linear.vectorcollection

Class RTree<V extends Vec>

java.lang.Object

jsat.linear.vectorcollection.RTree<V>

All Implemented Interfaces:

Serializable, Cloneable, VectorCollection<V>

public class RTree<V extends Vec>
extends Object
implements VectorCollection<V>

Author:

Edward Raff

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RTree.RTreeFactory<V extends Vec>

Constructor Summary

Constructors

Constructor and Description
RTree(int dimensions)
RTree(int dimensions, DistanceMetric dm)
RTree(int dimensions, DistanceMetric dm, int max)
RTree(int dimensions, DistanceMetric dm, int max, int min)
RTree(RTree toCopy) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	add(V v)
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

Methods inherited from class java.lang.Object

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

Constructor Detail

RTree

public RTree(int dimensions)

RTree

public RTree(int dimensions,
             DistanceMetric dm)

RTree

public RTree(int dimensions,
             DistanceMetric dm,
             int max)

RTree

public RTree(int dimensions,
             DistanceMetric dm,
             int max,
             int min)

RTree

public RTree(RTree toCopy)

Copy constructor

Parameters:

toCopy -

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

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 VectorCollection<V> clone()

Specified by:

clone in interface VectorCollection<V extends Vec>

Overrides:

clone in class Object

add

public void add(V v)