Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.distance.distancefunction
Class AbstractFloatDistanceFunction<O extends DatabaseObject>

java.lang.Object
  extended by de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      extended by de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          extended by de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
              extended by de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction<O,FloatDistance>
                  extended by 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

Field Summary
 
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
protected AbstractFloatDistanceFunction()
          Provides a FloatDistanceFunction with a pattern defined to accept Strings that define a non-negative Float.
 
Method Summary
 FloatDistance infiniteDistance()
          An infinite FloatDistance is based on Float.POSITIVE_INFINITY.
 FloatDistance nullDistance()
          A null FloatDistance is based on 0.
 FloatDistance undefinedDistance()
          An undefined FloatDistance is based on Float.NaN.
 FloatDistance valueOf(String pattern)
          As pattern is required a String defining a Float.
 
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, setDatabase, setRequiredInputPattern, shortDescription
 
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 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.distancefunction.DistanceFunction
distance
 
Methods inherited from interface de.lmu.ifi.dbs.elki.distance.MeasurementFunction
requiredInputPattern, setDatabase
 
Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable
checkGlobalParameterConstraints, collectOptions, getParameters, setParameters, shortDescription
 

Constructor Detail

AbstractFloatDistanceFunction

protected AbstractFloatDistanceFunction()
Provides a FloatDistanceFunction with a pattern defined to accept Strings that define a non-negative Float.

Method Detail

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

Release 0.2.1 (2009-07-13_1605)