jsat.linear.vectorcollection

Class VectorArray<V extends Vec>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<V>

jsat.linear.vectorcollection.VectorArray<V>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<V>, Collection<V>, List<V>, RandomAccess, IncrementalCollection<V>, VectorCollection<V>

public class VectorArray<V extends Vec>
extends ArrayList<V>
implements IncrementalCollection<V>

This is the naive implementation of a Vector collection. Construction time is O(n) only to clone the n elements, and all queries are O(n)

Removing elements from the vector array will result in the destruction of any acceleration cache

Author:

Edward Raff

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VectorArray.VectorArrayFactory<V extends Vec>

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
VectorArray(DistanceMetric distanceMetric)
VectorArray(DistanceMetric distanceMetric, Collection<? extends V> c)
VectorArray(DistanceMetric distanceMetric, int initialCapacity)

Method Summary

Modifier and Type	Method and Description
boolean	add(V e)
boolean	addAll(Collection<? extends V> c)
VectorArray<V>	clone()
DistanceMetric	getDistanceMetric()
void	insert(V x) Incrementally adds the given datapoint into the collection
V	remove(int index)
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
void	setDistanceMetric(DistanceMetric distanceMetric)

Methods inherited from class java.util.ArrayList

add, addAll, clear, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jsat.linear.vectorcollection.VectorCollection

size

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

VectorArray

public VectorArray(DistanceMetric distanceMetric,
                   int initialCapacity)

VectorArray

public VectorArray(DistanceMetric distanceMetric,
                   Collection<? extends V> c)

VectorArray

public VectorArray(DistanceMetric distanceMetric)

Method Detail

getDistanceMetric

public DistanceMetric getDistanceMetric()

setDistanceMetric

public void setDistanceMetric(DistanceMetric distanceMetric)

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

add

public boolean add(V e)

Specified by:

add in interface Collection<V extends Vec>

Specified by:

add in interface List<V extends Vec>

Overrides:

add in class ArrayList<V extends Vec>

addAll

public boolean addAll(Collection<? extends V> c)

Specified by:

addAll in interface Collection<V extends Vec>

Specified by:

addAll in interface List<V extends Vec>

Overrides:

addAll in class ArrayList<V extends Vec>

remove

public V remove(int index)

Specified by:

remove in interface List<V extends Vec>

Overrides:

remove in class ArrayList<V extends Vec>

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

clone

public VectorArray<V> clone()

Specified by:

clone in interface IncrementalCollection<V extends Vec>

Specified by:

clone in interface VectorCollection<V extends Vec>

Overrides:

clone in class ArrayList<V extends Vec>