de.lmu.ifi.dbs.elki.distance.distancefunction.correlation
Class AbstractCorrelationDistanceFunction<V extends RealVector<V,?>,P extends Preprocessor<V>,D extends CorrelationDistance<D>>
java.lang.Object
de.lmu.ifi.dbs.elki.logging.AbstractLoggable
de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction<O,D>
de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPreprocessorBasedDistanceFunction<V,P,D>
de.lmu.ifi.dbs.elki.distance.distancefunction.correlation.AbstractCorrelationDistanceFunction<V,P,D>
- Type Parameters:
V
- the type of RealVector usedP
- the type of Preprocessor usedD
- the type of CorrelationDistance used
- All Implemented Interfaces:
- DistanceFunction<V,D>, MeasurementFunction<V,D>, PreprocessorBasedMeasurementFunction<V,P,D>, PreprocessorClient<P,V>, Parameterizable
- Direct Known Subclasses:
- AbstractPreferenceVectorBasedCorrelationDistanceFunction, PCABasedCorrelationDistanceFunction
public abstract class AbstractCorrelationDistanceFunction<V extends RealVector<V,?>,P extends Preprocessor<V>,D extends CorrelationDistance<D>>
- extends AbstractPreprocessorBasedDistanceFunction<V,P,D>
Abstract super class for correlation based distance functions. Provides the
correlation distance for real valued vectors.
- Author:
- Elke Achtert
Constructor Summary |
AbstractCorrelationDistanceFunction()
Provides a CorrelationDistanceFunction with a pattern defined to accept
Strings that define an Integer followed by a separator followed by a
Double. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SEPARATOR
public static final Pattern SEPARATOR
- Indicates a separator.
AbstractCorrelationDistanceFunction
public AbstractCorrelationDistanceFunction()
- Provides a CorrelationDistanceFunction with a pattern defined to accept
Strings that define an Integer followed by a separator followed by a
Double.
distance
public final D distance(V v1,
V v2)
- Provides the Correlation distance between the given two vectors by
calling
correlationDistance(v1, v2)
.
- Parameters:
v1
- first DatabaseObjectv2
- second DatabaseObject
- Returns:
- the Correlation distance between the given two vectors as an
instance of
CorrelationDistance
.
shortDescription
public String shortDescription()
- Description copied from class:
AbstractMeasurementFunction
- Returns the required input pattern.
- Specified by:
shortDescription
in interface Parameterizable
- Overrides:
shortDescription
in class AbstractMeasurementFunction<V extends RealVector<V,?>,D extends CorrelationDistance<D>>
- Returns:
- Description of the class
correlationDistance
abstract D correlationDistance(V v1,
V v2)
- Computes the correlation distance between the two specified vectors.
- Parameters:
v1
- first RealVectorv2
- second RealVector
- Returns:
- the correlation distance between the two specified vectors