de.lmu.ifi.dbs.elki.distance.distancefunction
Class HiSCDistanceFunction<O extends RealVector<O,?>,P extends Preprocessor<O>>

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<O,P,D>
                      de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractCorrelationDistanceFunction<O,P,PreferenceVectorBasedCorrelationDistance>
                          de.lmu.ifi.dbs.elki.distance.distancefunction.PreferenceVectorBasedCorrelationDistanceFunction<O,P>
                              de.lmu.ifi.dbs.elki.distance.distancefunction.HiSCDistanceFunction<O,P>

All Implemented Interfaces:

DistanceFunction<O,PreferenceVectorBasedCorrelationDistance>, MeasurementFunction<O,PreferenceVectorBasedCorrelationDistance>, Loggable, Parameterizable

public class HiSCDistanceFunction<O extends RealVector<O,?>,P extends Preprocessor<O>>
extends PreferenceVectorBasedCorrelationDistanceFunction<O,P>

Distance function used in the HiSC algorithm.

Author:

Elke Achtert

Field Summary

static String	DEFAULT_PREPROCESSOR_CLASS The default preprocessor class name.
static String	PREPROCESSOR_CLASS_D Description for parameter preprocessor.

Fields inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.PreferenceVectorBasedCorrelationDistanceFunction

ASSOCIATION_ID, DEFAULT_EPSILON, EPSILON_D, EPSILON_P, PREPROCESSOR_SUPER_CLASS

Fields inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractCorrelationDistanceFunction

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

Constructor Summary

HiSCDistanceFunction()

Method Summary

PreferenceVectorBasedCorrelationDistance	correlationDistance(O v1, O v2, BitSet pv1, BitSet pv2) Computes the correlation distance between the two specified vectors according to the specified preference vectors.
(package private) String	getDefaultPreprocessorClassName() Returns the name of the default preprocessor.
(package private) String	getPreprocessorClassDescription() Returns the description for parameter preprocessor.

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

correlationDistance, getAssociationID, getEpsilon, getPreprocessorSuperClassName, infiniteDistance, nullDistance, setParameters, undefinedDistance, valueOf, weightedDistance, weightedDistance, weightedPrefereneceVectorDistance, weightedPrefereneceVectorDistance

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

description, distance

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

getAttributeSettings, getPreprocessor, setDatabase

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, checkGlobalParameterConstraints, deleteOption, description, description, getParameters, getParameterValue, getPossibleOptions, inlineDescription, isSet, setParameters

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

debugFine, debugFiner, debugFinest, exception, message, progress, progress, progress, verbose, 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

requiredInputPattern

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

checkGlobalParameterConstraints, getParameters, getPossibleOptions, inlineDescription

Field Detail

DEFAULT_PREPROCESSOR_CLASS

public static final String DEFAULT_PREPROCESSOR_CLASS

The default preprocessor class name.

PREPROCESSOR_CLASS_D

public static final String PREPROCESSOR_CLASS_D

Description for parameter preprocessor.

Constructor Detail

HiSCDistanceFunction

public HiSCDistanceFunction()

Method Detail

correlationDistance

public PreferenceVectorBasedCorrelationDistance correlationDistance(O v1,
                                                                    O v2,
                                                                    BitSet pv1,
                                                                    BitSet pv2)

Computes the correlation distance between the two specified vectors according to the specified preference vectors.

Specified by:

correlationDistance in class PreferenceVectorBasedCorrelationDistanceFunction<O extends RealVector<O,?>,P extends Preprocessor<O>>

Parameters:

v1 - first RealVector

v2 - second RealVector

pv1 - the first preference vector

pv2 - the second preference vector

Returns:

the correlation distance between the two specified vectors

getDefaultPreprocessorClassName

String getDefaultPreprocessorClassName()

Returns the name of the default preprocessor.

Specified by:

getDefaultPreprocessorClassName in class AbstractCorrelationDistanceFunction<O extends RealVector<O,?>,P extends Preprocessor<O>,PreferenceVectorBasedCorrelationDistance>

getPreprocessorClassDescription

String getPreprocessorClassDescription()

Returns the description for parameter preprocessor.

Specified by:

getPreprocessorClassDescription in class AbstractCorrelationDistanceFunction<O extends RealVector<O,?>,P extends Preprocessor<O>,PreferenceVectorBasedCorrelationDistance>