de.lmu.ifi.dbs.elki.distance.similarityfunction
Class AbstractIntegerSimilarityFunction<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.similarityfunction.AbstractSimilarityFunction<O,IntegerDistance>
de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractIntegerSimilarityFunction<O>
- Type Parameters:
O
- object type
- All Implemented Interfaces:
- MeasurementFunction<O,IntegerDistance>, SimilarityFunction<O,IntegerDistance>, Parameterizable
public abstract class AbstractIntegerSimilarityFunction<O extends DatabaseObject>
- extends AbstractSimilarityFunction<O,IntegerDistance>
- 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 |
AbstractIntegerSimilarityFunction
protected AbstractIntegerSimilarityFunction()
infiniteDistance
public IntegerDistance infiniteDistance()
- Description copied from interface:
MeasurementFunction
- Provides an infinite distance.
- Returns:
- an infinite distance
isInfiniteDistance
public boolean isInfiniteDistance(IntegerDistance distance)
- Description copied from interface:
MeasurementFunction
- Returns true, if the given distance is an infinite distance, false
otherwise.
- Parameters:
distance
- the distance to be tested on infinity
- Returns:
- true, if the given distance is an infinite distance, false
otherwise
isNullDistance
public boolean isNullDistance(IntegerDistance distance)
- Description copied from interface:
MeasurementFunction
- Returns true, if the given distance is a null distance, false otherwise.
- Parameters:
distance
- the distance to be tested whether it is a null distance
- Returns:
- true, if the given distance is a null distance, false otherwise
isUndefinedDistance
public boolean isUndefinedDistance(IntegerDistance distance)
- Description copied from interface:
MeasurementFunction
- Returns true, if the given distance is an undefined distance, false
otherwise.
- Parameters:
distance
- the distance to be tested whether it is undefined
- Returns:
- true, if the given distance is an undefined distance, false
otherwise
nullDistance
public IntegerDistance nullDistance()
- Description copied from interface:
MeasurementFunction
- Provides a null distance.
- Returns:
- a null distance
undefinedDistance
public IntegerDistance undefinedDistance()
- Description copied from interface:
MeasurementFunction
- Provides an undefined distance.
- Returns:
- an undefined distance
valueOf
public IntegerDistance valueOf(String pattern)
throws IllegalArgumentException
- Description copied from interface:
MeasurementFunction
- Provides a measurement suitable to this measurement function based on the given
pattern.
- 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