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 used

P - the type of Preprocessor used

D - 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

Field Summary

static Pattern

SEPARATOR Indicates a separator.

Fields inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

INFINITY_PATTERN

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable

optionHandler

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug, logger

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.

Method Summary

(package private) abstract D	correlationDistance(V v1, V v2) Computes the correlation distance between the two specified vectors.
D	distance(V v1, V v2) Provides the Correlation distance between the given two vectors by calling correlationDistance(v1, v2).
String	shortDescription() Returns the required input pattern.

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

getPreprocessor, setDatabase, setParameters

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

distance, distance, isInfiniteDistance, isNullDistance, isUndefinedDistance

Methods inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

getDatabase, matches, requiredInputPattern, setRequiredInputPattern

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable

addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, progress, verbose, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.MeasurementFunction

infiniteDistance, isInfiniteDistance, isNullDistance, isUndefinedDistance, nullDistance, requiredInputPattern, undefinedDistance, valueOf

Methods inherited from interface de.lmu.ifi.dbs.elki.preprocessing.PreprocessorClient

getAssociationID, getDefaultPreprocessorClassName, getPreprocessorDescription, getPreprocessorSuperClass

Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable

checkGlobalParameterConstraints, collectOptions, getParameters

Field Detail

SEPARATOR

public static final Pattern SEPARATOR

Indicates a separator.

Constructor Detail

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.

Method Detail

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 DatabaseObject

v2 - 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 RealVector

v2 - second RealVector

Returns:

the correlation distance between the two specified vectors