|
|
|||||||||||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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,PreferenceVectorBasedCorrelationDistance> de.lmu.ifi.dbs.elki.distance.distancefunction.correlation.AbstractPreferenceVectorBasedCorrelationDistanceFunction<V,P>
V
- the type of RealVector to compute the distances in betweenP
- the type of Preprocessor usedpublic abstract class AbstractPreferenceVectorBasedCorrelationDistanceFunction<V extends RealVector<V,?>,P extends PreferenceVectorPreprocessor<V>>
Abstract super class for all preference vector based correlation distance functions.
Field Summary | |
---|---|
private double |
epsilon
Holds the value of EPSILON_PARAM . |
static OptionID |
EPSILON_ID
OptionID for EPSILON_PARAM |
private DoubleParameter |
EPSILON_PARAM
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.correlation.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, logger |
Constructor Summary | |
---|---|
AbstractPreferenceVectorBasedCorrelationDistanceFunction()
Provides a preference vector based CorrelationDistanceFunction, adding parameter EPSILON_PARAM
to the option handler
additionally to parameters of super class. |
Method Summary | |
---|---|
protected PreferenceVectorBasedCorrelationDistance |
correlationDistance(V v1,
V v2)
Computes the correlation distance between the two specified vectors. |
abstract PreferenceVectorBasedCorrelationDistance |
correlationDistance(V v1,
V v2,
BitSet pv1,
BitSet pv2)
Computes the correlation distance between the two specified vectors according to the specified preference vectors. |
private int |
dimensionality()
Returns the dimensionality of the database. |
AssociationID<?> |
getAssociationID()
Returns the association ID for the association to be set by the preprocessor. |
double |
getEpsilon()
Returns epsilon. |
String |
getPreprocessorDescription()
Returns the description for the preprocessor parameter. |
Class<P> |
getPreprocessorSuperClass()
Returns the super class for the preprocessor parameter. |
PreferenceVectorBasedCorrelationDistance |
infiniteDistance()
Provides an infinite distance. |
PreferenceVectorBasedCorrelationDistance |
nullDistance()
Provides a null distance. |
List<String> |
setParameters(List<String> args)
Calls the super method and sets additionally the value of the parameter EPSILON_PARAM . |
PreferenceVectorBasedCorrelationDistance |
undefinedDistance()
Provides an undefined distance. |
PreferenceVectorBasedCorrelationDistance |
valueOf(String pattern)
Provides a measurement suitable to this measurement function based on the given pattern. |
double |
weightedDistance(Integer id1,
Integer id2,
BitSet weightVector)
Computes the weighted distance between the two specified vectors according to the given preference vector. |
double |
weightedDistance(V v1,
V v2,
BitSet weightVector)
Computes the weighted distance between the two specified vectors according to the given preference vector. |
double |
weightedPrefereneceVectorDistance(Integer id1,
Integer id2)
Computes the weighted distance between the two specified data vectors according to their preference vectors. |
double |
weightedPrefereneceVectorDistance(V v1,
V v2)
Computes the weighted distance between the two specified data vectors according to their preference vectors. |
Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.correlation.AbstractCorrelationDistanceFunction |
---|
distance, shortDescription |
Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPreprocessorBasedDistanceFunction |
---|
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, 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 |
---|
isInfiniteDistance, isNullDistance, isUndefinedDistance, requiredInputPattern |
Methods inherited from interface de.lmu.ifi.dbs.elki.preprocessing.PreprocessorClient |
---|
getDefaultPreprocessorClassName |
Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable |
---|
checkGlobalParameterConstraints, collectOptions, getParameters |
Field Detail |
---|
public static final OptionID EPSILON_ID
EPSILON_PARAM
private final DoubleParameter EPSILON_PARAM
Default value: 0.001
Key: -pvbasedcorrelationdf.epsilon
private double epsilon
EPSILON_PARAM
.
Constructor Detail |
---|
public AbstractPreferenceVectorBasedCorrelationDistanceFunction()
EPSILON_PARAM
to the option handler
additionally to parameters of super class.
Method Detail |
---|
public PreferenceVectorBasedCorrelationDistance valueOf(String pattern) throws IllegalArgumentException
MeasurementFunction
pattern
- a pattern defining a similarity suitable to this
measurement function
IllegalArgumentException
- if the given pattern is not compatible with the requirements
of this measurement functionpublic PreferenceVectorBasedCorrelationDistance infiniteDistance()
MeasurementFunction
public PreferenceVectorBasedCorrelationDistance nullDistance()
MeasurementFunction
public PreferenceVectorBasedCorrelationDistance undefinedDistance()
MeasurementFunction
protected PreferenceVectorBasedCorrelationDistance correlationDistance(V v1, V v2)
AbstractCorrelationDistanceFunction
correlationDistance
in class AbstractCorrelationDistanceFunction<V extends RealVector<V,?>,P extends PreferenceVectorPreprocessor<V>,PreferenceVectorBasedCorrelationDistance>
v1
- first RealVectorv2
- second RealVector
public abstract PreferenceVectorBasedCorrelationDistance correlationDistance(V v1, V v2, BitSet pv1, BitSet pv2)
v1
- first RealVectorv2
- second RealVectorpv1
- the first preference vectorpv2
- the second preference vector
public double weightedDistance(V v1, V v2, BitSet weightVector)
v1
- the first vectorv2
- the second vectorweightVector
- the preference vector
public double weightedDistance(Integer id1, Integer id2, BitSet weightVector)
id1
- the id of the first vectorid2
- the id of the second vectorweightVector
- the preference vector
public double weightedPrefereneceVectorDistance(V v1, V v2)
v1
- the first vectorv2
- the the second vector
public double weightedPrefereneceVectorDistance(Integer id1, Integer id2)
id1
- the id of the first vectorid2
- the id of the second vector
public List<String> setParameters(List<String> args) throws ParameterException
EPSILON_PARAM
.
setParameters
in interface Parameterizable
setParameters
in class AbstractPreprocessorBasedDistanceFunction<V extends RealVector<V,?>,P extends PreferenceVectorPreprocessor<V>,PreferenceVectorBasedCorrelationDistance>
args
- parameters to set the attributes accordingly to
ParameterException
- in case of wrong parameter-settingpublic double getEpsilon()
public final AssociationID<?> getAssociationID()
AssociationID.PREFERENCE_VECTOR
public final Class<P> getPreprocessorSuperClass()
PreprocessorClient
PreferenceVectorPreprocessor
public final String getPreprocessorDescription()
PreprocessorClient
private int dimensionality()
|
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |