de.lmu.ifi.dbs.elki.distance.distancefunction.correlation

Class UncenteredCorrelationDistanceFunction

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction<NumberVector>

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractNumberVectorDistanceFunction

de.lmu.ifi.dbs.elki.distance.distancefunction.correlation.UncenteredCorrelationDistanceFunction

All Implemented Interfaces:

DistanceFunction<NumberVector>, NumberVectorDistanceFunction<NumberVector>, PrimitiveDistanceFunction<NumberVector>

public class UncenteredCorrelationDistanceFunction
extends AbstractNumberVectorDistanceFunction

Uncentered correlation distance. This is highly similar to PearsonCorrelationDistanceFunction, but uses a fixed mean of 0 instead of the sample mean.

Since:

0.3

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UncenteredCorrelationDistanceFunction.Parameterizer Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
static UncenteredCorrelationDistanceFunction	STATIC Static instance.

Constructor Summary

Constructors

Constructor and Description
UncenteredCorrelationDistanceFunction() Deprecated. Use static instance!

Method Summary

Methods

Modifier and Type	Method and Description
double	distance(NumberVector v1, NumberVector v2) Computes the Pearson correlation distance for two given feature vectors.
boolean	equals(Object obj)
String	toString()
static double	uncenteredCorrelation(NumberVector x, NumberVector y) Compute the uncentered correlation of two vectors.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractNumberVectorDistanceFunction

dimensionality, dimensionality, dimensionality, dimensionality, getInputTypeRestriction

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction

instantiate, isMetric, isSymmetric

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction

instantiate, isMetric, isSymmetric

Field Detail

STATIC

public static final UncenteredCorrelationDistanceFunction STATIC

Static instance.

Constructor Detail

UncenteredCorrelationDistanceFunction

@Deprecated
public UncenteredCorrelationDistanceFunction()

Deprecated. Use static instance!

Constructor - use STATIC instead.

Method Detail

uncenteredCorrelation

public static double uncenteredCorrelation(NumberVector x,
                           NumberVector y)

Compute the uncentered correlation of two vectors.

Parameters:

x - first NumberVector

y - second NumberVector

Returns:

the uncentered correlation coefficient for x and y

distance

public double distance(NumberVector v1,
              NumberVector v2)

Computes the Pearson correlation distance for two given feature vectors. The Pearson correlation distance is computed from the Pearson correlation coefficient r as: 1-r. Hence, possible values of this distance are between 0 and 2.

Specified by:

distance in interface NumberVectorDistanceFunction<NumberVector>

Specified by:

distance in interface PrimitiveDistanceFunction<NumberVector>

Specified by:

distance in class AbstractPrimitiveDistanceFunction<NumberVector>

Parameters:

v1 - first feature vector

v2 - second feature vector

Returns:

the Pearson correlation distance for two given feature vectors v1 and v2

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object