de.jstacs.clustering.distances

Class PearsonCorrelationDistanceMetric

java.lang.Object

de.jstacs.clustering.distances.DistanceMetric<double[]>

de.jstacs.clustering.distances.PearsonCorrelationDistanceMetric

public class PearsonCorrelationDistanceMetric
extends DistanceMetric<double[]>

Implements a distance metric based on the Pearson correlation of two double vectors.

Author:

Jan Grau

Constructor Summary

Constructors

Constructor and Description
PearsonCorrelationDistanceMetric(boolean abs) Creates a new distance based on the Pearson correlation.

Method Summary

Modifier and Type	Method and Description
double	getDistance(double[] o1, double[] o2) Returns the distance according to the metric of the two supplied objects.

Methods inherited from class de.jstacs.clustering.distances.DistanceMetric

getPairwiseDistanceMatrix

Methods inherited from class java.lang.Object

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

Constructor Detail

PearsonCorrelationDistanceMetric

public PearsonCorrelationDistanceMetric(boolean abs)

Creates a new distance based on the Pearson correlation.

Parameters:

abs - if true, the distance is computed as , otherwise as .

Method Detail

getDistance

public double getDistance(double[] o1,
                          double[] o2)
                   throws Exception

Description copied from class: DistanceMetric

Returns the distance according to the metric of the two supplied objects.

Specified by:

getDistance in class DistanceMetric<double[]>

Parameters:

o1 - the first object

o2 - the second object

Returns:

the distance

Throws:

Exception - if the distance could not be computed