de.lmu.ifi.dbs.elki.distance.distancefunction.subspace
Class AbstractPreferenceVectorBasedCorrelationDistanceFunction<V extends NumberVector<?,?>,P extends PreferenceVectorIndex<V>>

java.lang.Object
  de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDatabaseDistanceFunction<O,D>
      de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractIndexBasedDistanceFunction<V,P,PreferenceVectorBasedCorrelationDistance>
          de.lmu.ifi.dbs.elki.distance.distancefunction.subspace.AbstractPreferenceVectorBasedCorrelationDistanceFunction<V,P>

Type Parameters:

V - the type of NumberVector to compute the distances in between

P - the type of Preprocessor used

All Implemented Interfaces:

DistanceFunction<V,PreferenceVectorBasedCorrelationDistance>, IndexBasedDistanceFunction<V,PreferenceVectorBasedCorrelationDistance>, InspectionUtilFrequentlyScanned, Parameterizable

Direct Known Subclasses:

DiSHDistanceFunction, HiSCDistanceFunction

public abstract class AbstractPreferenceVectorBasedCorrelationDistanceFunction<V extends NumberVector<?,?>,P extends PreferenceVectorIndex<V>>
extends AbstractIndexBasedDistanceFunction<V,P,PreferenceVectorBasedCorrelationDistance>

Abstract super class for all preference vector based correlation distance functions.

Nested Class Summary

static class	AbstractPreferenceVectorBasedCorrelationDistanceFunction.Instance<V extends NumberVector<?,?>,P extends PreferenceVectorIndex<V>> Instance to compute the distances on an actual database.
static class	AbstractPreferenceVectorBasedCorrelationDistanceFunction.Parameterizer<F extends IndexFactory<?,?>> Parameterization class.

Field Summary

private double	epsilon Holds the value of EPSILON_ID.
static OptionID	EPSILON_ID Parameter to specify the maximum distance between two vectors with equal preference vectors before considering them as parallel, must be a double equal to or greater than 0.

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

indexFactory

Fields inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.IndexBasedDistanceFunction

INDEX_ID

Constructor Summary

AbstractPreferenceVectorBasedCorrelationDistanceFunction(IndexFactory<V,P> indexFactory, double epsilon)
Constructor.

Method Summary

boolean	equals(Object obj)
PreferenceVectorBasedCorrelationDistance	getDistanceFactory() Method to get the distance functions factory.
double	getEpsilon() Returns epsilon.

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

getInputTypeRestriction, isMetric, isSymmetric

Methods inherited from class java.lang.Object

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

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

instantiate

Field Detail

EPSILON_ID

public static final OptionID EPSILON_ID

Parameter to specify the maximum distance between two vectors with equal preference vectors before considering them as parallel, must be a double equal to or greater than 0.

Default value: 0.001

Key: -pvbasedcorrelationdf.epsilon

epsilon

private double epsilon

Holds the value of EPSILON_ID.

Constructor Detail

AbstractPreferenceVectorBasedCorrelationDistanceFunction

public AbstractPreferenceVectorBasedCorrelationDistanceFunction(IndexFactory<V,P> indexFactory,
                                                                double epsilon)

Constructor.

Parameters:

indexFactory - Index factory

epsilon - Epsilon value

Method Detail

getDistanceFactory

public PreferenceVectorBasedCorrelationDistance getDistanceFactory()

Description copied from interface: DistanceFunction

Method to get the distance functions factory.

Specified by:

getDistanceFactory in interface DistanceFunction<V extends NumberVector<?,?>,PreferenceVectorBasedCorrelationDistance>

Specified by:

getDistanceFactory in class AbstractDatabaseDistanceFunction<V extends NumberVector<?,?>,PreferenceVectorBasedCorrelationDistance>

Returns:

Factory for distance objects

getEpsilon

public double getEpsilon()

Returns epsilon.

Returns:

epsilon

equals

public boolean equals(Object obj)

Overrides:

equals in class Object