de.lmu.ifi.dbs.elki.distance.similarityfunction.kernel
Class AbstractDoubleKernelFunction<O extends DatabaseObject>
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.similarityfunction.kernel.AbstractKernelFunction<O,DoubleDistance>
de.lmu.ifi.dbs.elki.distance.similarityfunction.kernel.AbstractDoubleKernelFunction<O>
- All Implemented Interfaces:
- DistanceFunction<O,DoubleDistance>, MeasurementFunction<O,DoubleDistance>, KernelFunction<O,DoubleDistance>, SimilarityFunction<O,DoubleDistance>, Loggable, Parameterizable
- Direct Known Subclasses:
- ArbitraryKernelFunctionWrapper, FooKernelFunction, LinearKernelFunction, PolynomialKernelFunction
public abstract class AbstractDoubleKernelFunction<O extends DatabaseObject>
- extends AbstractKernelFunction<O,DoubleDistance>
Provides an abstract superclass for KernelFunctions that are based on DoubleDistance.
- Author:
- Elke Achtert
Constructor Summary |
protected |
AbstractDoubleKernelFunction()
Provides a AbstractDoubleKernelFunction with a pattern defined to accept
Strings that define a non-negative Double. |
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable |
addOption, checkGlobalParameterConstraints, deleteOption, description, description, description, getAttributeSettings, getParameters, getParameterValue, getPossibleOptions, inlineDescription, isSet, setParameters, 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 |
AbstractDoubleKernelFunction
protected AbstractDoubleKernelFunction()
- Provides a AbstractDoubleKernelFunction with a pattern defined to accept
Strings that define a non-negative Double.
infiniteDistance
public DoubleDistance infiniteDistance()
- An infinite DoubleDistance is based on
Double.POSITIVE_INFINITY
.
- Returns:
- an infinite distance
- See Also:
MeasurementFunction.infiniteDistance()
nullDistance
public DoubleDistance nullDistance()
- A null DoubleDistance is based on 0.
- Returns:
- a null distance
- See Also:
MeasurementFunction.nullDistance()
undefinedDistance
public DoubleDistance undefinedDistance()
- An undefined DoubleDistance is based on
Double.NaN
.
- Returns:
- an undefined distance
- See Also:
MeasurementFunction.undefinedDistance()
valueOf
public DoubleDistance valueOf(String pattern)
throws IllegalArgumentException
- As pattern is required a String defining a Double.
- Parameters:
pattern
- a pattern defining a similarity suitable to this
measurement function
- Returns:
- a measurement suitable to this measurement function based on the given
pattern
- Throws:
IllegalArgumentException
- if the given pattern is not compatible with the requirements
of this measurement function- See Also:
MeasurementFunction.valueOf(String)
distance
public DoubleDistance distance(O fv1,
O fv2)
- Description copied from interface:
DistanceFunction
- Computes the distance between two given DatabaseObjects according to this
distance function.
- Parameters:
fv1
- first DatabaseObjectfv2
- second DatabaseObject
- Returns:
- the distance between two given DatabaseObjects according to this
distance function
- See Also:
DistanceFunction.distance(DatabaseObject, DatabaseObject)