jsat.linear.distancemetrics

Class DistanceCounter

java.lang.Object

jsat.linear.distancemetrics.DistanceCounter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, DistanceMetric

public class DistanceCounter
extends java.lang.Object
implements DistanceMetric

This class exists primarily as a sanity/benchmarking utility. It takes a given base distance metric, which will be used as the actual method of measuring distances. This class will count how many times a distance calculation was queried. This class is thread safe.
NOTE: all clones of this object will share the same counter.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DistanceCounter(DistanceCounter toCopy) Copies the given distance counter, while sharing the same underlying counter between the original and this new object.
DistanceCounter(DistanceMetric base) Creates a new distance counter to wrap the given base metric

Method Summary

Modifier and Type	Method and Description
DistanceCounter	clone()
double	dist(int a, int b, java.util.List<? extends Vec> vecs, java.util.List<java.lang.Double> cache) Computes the distance between 2 vectors in the original list of vectors.
double	dist(int a, Vec b, java.util.List<? extends Vec> vecs, java.util.List<java.lang.Double> cache) Computes the distance between one vector in the original list of vectors with that of another vector not from the original list.
double	dist(int a, Vec b, java.util.List<java.lang.Double> qi, java.util.List<? extends Vec> vecs, java.util.List<java.lang.Double> cache) Computes the distance between one vector in the original list of vectors with that of another vector not from the original list, but had information generated by DistanceMetric.getQueryInfo(jsat.linear.Vec).
double	dist(Vec a, Vec b) Computes the distance between 2 vectors.
java.util.List<java.lang.Double>	getAccelerationCache(java.util.List<? extends Vec> vecs, boolean parallel) Returns a cache of double values associated with the given list of vectors in the given order.
long	getCallCount()
java.util.List<java.lang.Double>	getQueryInfo(Vec q) Pre computes query information that would have be generated if the query was a member of the original list of vectors when calling DistanceMetric.getAccelerationCache(java.util.List) .
boolean	isIndiscemible() Returns true if this distance metric obeys the rule that, for any x and y ∈ S d(x, y) = 0 if and only if x = y
boolean	isSubadditive() Returns true if this distance metric obeys the rule that, for any x, y, and z ∈ S d(x, z) ≤ d(x, y) + d(y, z)
boolean	isSymmetric() Returns true if this distance metric obeys the rule that, for any x, y, and z ∈ S d(x, y) = d(y, x)
double	metricBound() All metrics must return values greater than or equal to 0.
void	resetCounter() Resets the distance counter calls to zero.
boolean	supportsAcceleration() Indicates if this distance metric supports building an acceleration cache using the DistanceMetric.getAccelerationCache(java.util.List) and associated distance methods.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jsat.linear.distancemetrics.DistanceMetric

getAccelerationCache, isValidMetric, toString

Constructor Detail

DistanceCounter

public DistanceCounter(DistanceMetric base)

Creates a new distance counter to wrap the given base metric

Parameters:

base - the base distance measure to use

DistanceCounter

public DistanceCounter(DistanceCounter toCopy)

Copies the given distance counter, while sharing the same underlying counter between the original and this new object.

Parameters:

toCopy - the object to get a copy of

Method Detail

getCallCount

public long getCallCount()

Returns:

the number of distance calls that have occurred

resetCounter

public void resetCounter()

Resets the distance counter calls to zero.

dist

public double dist(Vec a,
                   Vec b)

Description copied from interface: DistanceMetric

Computes the distance between 2 vectors. The smaller the value, the closer, and there for, more similar, the vectors are. 0 indicates the vectors are the same.

Specified by:

dist in interface DistanceMetric

Parameters:

a - the first vector

b - the second vector

Returns:

the distance between them

isSymmetric

public boolean isSymmetric()

Description copied from interface: DistanceMetric

Returns true if this distance metric obeys the rule that, for any x, y, and z ∈ S
d(x, y) = d(y, x)

Specified by:

isSymmetric in interface DistanceMetric

Returns:

true if this distance metric is symmetric, false if it is not

isSubadditive

public boolean isSubadditive()

Description copied from interface: DistanceMetric

Returns true if this distance metric obeys the rule that, for any x, y, and z ∈ S
d(x, z) ≤ d(x, y) + d(y, z)

Specified by:

isSubadditive in interface DistanceMetric

Returns:

true if this distance metric supports the triangle inequality, false if it does not.

isIndiscemible

public boolean isIndiscemible()

Description copied from interface: DistanceMetric

Returns true if this distance metric obeys the rule that, for any x and y ∈ S
d(x, y) = 0 if and only if x = y

Specified by:

isIndiscemible in interface DistanceMetric

Returns:

true if this distance metric is indicemible, false otherwise.

metricBound

public double metricBound()

Description copied from interface: DistanceMetric

All metrics must return values greater than or equal to 0. The upper bound on the value returned is different for different metrics. This method returns the theoretical maximal value that could be returned by this distance metric. That means Double.POSITIVE_INFINITY is a valid return value.

Specified by:

metricBound in interface DistanceMetric

Returns:

the maximal distance for any two points in that could exist by this distance metric.

supportsAcceleration

public boolean supportsAcceleration()

Description copied from interface: DistanceMetric

Indicates if this distance metric supports building an acceleration cache using the DistanceMetric.getAccelerationCache(java.util.List) and associated distance methods. By default this method will return false. If true, then a cache can be obtained from this distance metric and used in conjunction with DistanceMetric.dist(int, jsat.linear.Vec, java.util.List, java.util.List) and DistanceMetric.dist(int, int, java.util.List, java.util.List) to perform distance computations.

Specified by:

supportsAcceleration in interface DistanceMetric

Returns:

true if cache acceleration is supported for this metric, false otherwise.

getAccelerationCache

public java.util.List<java.lang.Double> getAccelerationCache(java.util.List<? extends Vec> vecs,
                                                             boolean parallel)

Description copied from interface: DistanceMetric

Returns a cache of double values associated with the given list of vectors in the given order. This can be used by the distance metric to increase runtime at the cost of memory. This is an optional method.
If this metric does not support acceleration, null will be returned.

Specified by:

getAccelerationCache in interface DistanceMetric

Parameters:

vecs - the list of vectors to build an acceleration cache for

parallel - true if multiple threads should be used to perform clustering. false if it should be done in a single threaded manner.

Returns:

the list of double for the cache

dist

public double dist(int a,
                   int b,
                   java.util.List<? extends Vec> vecs,
                   java.util.List<java.lang.Double> cache)

Description copied from interface: DistanceMetric

Computes the distance between 2 vectors in the original list of vectors.
If the cache input is null, then DistanceMetric.dist(jsat.linear.Vec, jsat.linear.Vec) will be called directly.

Specified by:

dist in interface DistanceMetric

Parameters:

a - the index of the first vector

b - the index of the second vector

vecs - the list of vectors used to build the cache

cache - the cache associated with the given list of vectors

Returns:

the distance between the two vectors

dist

public double dist(int a,
                   Vec b,
                   java.util.List<? extends Vec> vecs,
                   java.util.List<java.lang.Double> cache)

Description copied from interface: DistanceMetric

Computes the distance between one vector in the original list of vectors with that of another vector not from the original list.
If the cache input is null, then DistanceMetric.dist(jsat.linear.Vec, jsat.linear.Vec) will be called directly.

Specified by:

dist in interface DistanceMetric

Parameters:

a - the index of the vector in the cache

b - the other vector

vecs - the list of vectors used to build the cache

cache - the cache associated with the given list of vectors

Returns:

the distance between the two vectors

getQueryInfo

public java.util.List<java.lang.Double> getQueryInfo(Vec q)

Description copied from interface: DistanceMetric

Pre computes query information that would have be generated if the query was a member of the original list of vectors when calling DistanceMetric.getAccelerationCache(java.util.List) . This can then be used if a large number of distance computations are going to be done against points in the original set for a point that is outside the original space.

If this metric does not support acceleration, null will be returned.

Specified by:

getQueryInfo in interface DistanceMetric

Parameters:

q - the query point to generate cache information for

Returns:

the cache information for the query point

dist

public double dist(int a,
                   Vec b,
                   java.util.List<java.lang.Double> qi,
                   java.util.List<? extends Vec> vecs,
                   java.util.List<java.lang.Double> cache)

Description copied from interface: DistanceMetric

Computes the distance between one vector in the original list of vectors with that of another vector not from the original list, but had information generated by DistanceMetric.getQueryInfo(jsat.linear.Vec).
If the cache input is null, then DistanceMetric.dist(jsat.linear.Vec, jsat.linear.Vec) will be called directly.

Specified by:

dist in interface DistanceMetric

Parameters:

a - the index of the vector in the cache

b - the other vector

qi - the query information about b

vecs - the list of vectors used to build the cache

cache - the cache associated with the given list of vectors

Returns:

the distance between the two vectors

clone

public DistanceCounter clone()

Specified by:

clone in interface DistanceMetric

Overrides:

clone in class java.lang.Object