ambit2.similarity.knn

Class NearestNeighborsSearch<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<DistanceComparable<T>>

ambit2.similarity.knn.NearestNeighborsSearch<T>

All Implemented Interfaces:

INearestNeighborsSearch<T>, Serializable, Cloneable, Iterable<DistanceComparable<T>>, Collection<DistanceComparable<T>>, List<DistanceComparable<T>>, RandomAccess

public class NearestNeighborsSearch<T>
extends ArrayList<DistanceComparable<T>>
implements INearestNeighborsSearch<T>

Brute force implementation of nearest neighbors. (uses TreeSet)

Author:

Nina Jeliazkova nina@acad.bg Modified Feb 4, 2007

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IDistanceFunction<T>	distanceFunction
protected static Logger	logger
protected boolean	lowestDistanceIsClosest

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
NearestNeighborsSearch()
NearestNeighborsSearch(IDistanceFunction<T> distanceFunction)

Method Summary

Modifier and Type	Method and Description
boolean	add(DistanceComparable<T> o)
boolean	addObject(T o) null property
boolean	addObject(T o, Object property)
IDistanceFunction<T>	getDistanceFunction()
List<DistanceComparable<T>>	getNearestNeighbors(T query, int k) Returns k nearest neighbors, encapsulated in DistanceComparable.
boolean	isLowestDistanceIsClosest()
void	setDistanceFunction(IDistanceFunction<T> distanceFunction)
void	setLowestDistanceIsClosest(boolean lowestDistanceIsClosest)

Methods inherited from class java.util.ArrayList

add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, 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 java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Field Detail

distanceFunction

protected IDistanceFunction<T> distanceFunction

lowestDistanceIsClosest

protected boolean lowestDistanceIsClosest

logger

protected static Logger logger

Constructor Detail

NearestNeighborsSearch

public NearestNeighborsSearch()

NearestNeighborsSearch

public NearestNeighborsSearch(IDistanceFunction<T> distanceFunction)

Method Detail

add

public boolean add(DistanceComparable<T> o)

Specified by:

add in interface Collection<DistanceComparable<T>>

Specified by:

add in interface List<DistanceComparable<T>>

Overrides:

add in class ArrayList<DistanceComparable<T>>

addObject

public boolean addObject(T o)

null property

Parameters:

o - Object

Returns:

true if successful

addObject

public boolean addObject(T o,
                         Object property)

Parameters:

o - Object

property - property to be predicted

Returns:

boolean

getNearestNeighbors

public List<DistanceComparable<T>> getNearestNeighbors(T query,
                                                       int k)
                                                throws Exception

Returns k nearest neighbors, encapsulated in DistanceComparable. The closest neighbors come first.

Specified by:

getNearestNeighbors in interface INearestNeighborsSearch<T>

Throws:

Exception

getDistanceFunction

public IDistanceFunction<T> getDistanceFunction()

Specified by:

getDistanceFunction in interface INearestNeighborsSearch<T>

setDistanceFunction

public void setDistanceFunction(IDistanceFunction<T> distanceFunction)

Specified by:

setDistanceFunction in interface INearestNeighborsSearch<T>

isLowestDistanceIsClosest

public boolean isLowestDistanceIsClosest()

setLowestDistanceIsClosest

public void setLowestDistanceIsClosest(boolean lowestDistanceIsClosest)