de.lmu.ifi.dbs.elki.distance.distancefunction
Class CosineDistanceFunction<V extends FeatureVector<V,?>>
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,DoubleDistance>
de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDoubleDistanceFunction<V>
de.lmu.ifi.dbs.elki.distance.distancefunction.CosineDistanceFunction<V>
- Type Parameters:
V
- the type of FeatureVector to compute the distances in between
- All Implemented Interfaces:
- DistanceFunction<V,DoubleDistance>, MeasurementFunction<V,DoubleDistance>, Parameterizable
public class CosineDistanceFunction<V extends FeatureVector<V,?>>
- extends AbstractDoubleDistanceFunction<V>
Cosine distance function for feature vectors.
The cosine distance is computed from the cosine similarity by 1-(cosine similarity)
.
- Author:
- Arthur Zimek
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable |
addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable, setParameters |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
CosineDistanceFunction
public CosineDistanceFunction()
- Provides a CosineDistanceFunction.
distance
public DoubleDistance distance(V v1,
V v2)
- Computes the cosine distance for two given feature vectors.
The cosine distance is computed from the cosine similarity by
1-(cosine similarity)
.
- Parameters:
v1
- first feature vectorv2
- second feature vector
- Returns:
- the cosine distance for two given feature vectors v1 and v2
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 FeatureVector<V,?>,DoubleDistance>
- Returns:
- Description of the class