de.lmu.ifi.dbs.elki.distance.distancefunction
Class AbstractFloatDistanceFunction<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,FloatDistance>
de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractFloatDistanceFunction<O>
- Type Parameters:
O
- the type of DatabaseObject to compute the distances in between
- All Implemented Interfaces:
- DistanceFunction<O,FloatDistance>, MeasurementFunction<O,FloatDistance>, Parameterizable
- Direct Known Subclasses:
- DiskCacheBasedFloatDistanceFunction, FileBasedFloatDistanceFunction
public abstract class AbstractFloatDistanceFunction<O extends DatabaseObject>
- extends AbstractDistanceFunction<O,FloatDistance>
Provides a DistanceFunction that is based on FloatDistance.
- Author:
- Arthur Zimek
Constructor Summary |
protected |
AbstractFloatDistanceFunction()
Provides a FloatDistanceFunction with a pattern defined to accept Strings
that define a non-negative Float. |
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 |
AbstractFloatDistanceFunction
protected AbstractFloatDistanceFunction()
- Provides a FloatDistanceFunction with a pattern defined to accept Strings
that define a non-negative Float.
infiniteDistance
public FloatDistance infiniteDistance()
- An infinite FloatDistance is based on
Float.POSITIVE_INFINITY
.
- Returns:
- an infinite distance
nullDistance
public FloatDistance nullDistance()
- A null FloatDistance is based on 0.
- Returns:
- a null distance
undefinedDistance
public FloatDistance undefinedDistance()
- An undefined FloatDistance is based on
Float.NaN
.
- Returns:
- an undefined distance
valueOf
public FloatDistance valueOf(String pattern)
throws IllegalArgumentException
- As pattern is required a String defining a Float.
- 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