Environment for
DeveLoping
KDD-Applications
Supported by Index-Structures

de.lmu.ifi.dbs.elki.distance.similarityfunction.kernel
Class AbstractKernelFunction<O extends DatabaseObject,D extends Distance<D>>

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,D>
                  extended by de.lmu.ifi.dbs.elki.distance.similarityfunction.kernel.AbstractKernelFunction<O,D>
Type Parameters:
O - object type
D - distance type
All Implemented Interfaces:
DistanceFunction<O,D>, MeasurementFunction<O,D>, KernelFunction<O,D>, SimilarityFunction<O,D>, Parameterizable
Direct Known Subclasses:
AbstractDoubleKernelFunction

public abstract class AbstractKernelFunction<O extends DatabaseObject,D extends Distance<D>>
extends AbstractDistanceFunction<O,D>
implements KernelFunction<O,D>

AbstractKernelFunction provides some methods valid for any extending class.

Author:
Elke Achtert

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 AbstractKernelFunction()
          Provides an abstract KernelFunction.
protected AbstractKernelFunction(Pattern pattern)
          Provides an abstract KernelFunction based on the given pattern.
 
Method Summary
 D similarity(Integer id1, Integer id2)
          Returns the similarity between the two objects specified by their object ids.
 D similarity(Integer id1, O o2)
          Returns the similarity between the two specified objects.
 
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.similarityfunction.SimilarityFunction
similarity
 
Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction
distance, distance, distance
 
Methods inherited from interface de.lmu.ifi.dbs.elki.distance.MeasurementFunction
infiniteDistance, isInfiniteDistance, isNullDistance, isUndefinedDistance, nullDistance, requiredInputPattern, setDatabase, undefinedDistance, valueOf
 
Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable
checkGlobalParameterConstraints, collectOptions, getParameters, setParameters, shortDescription
 

Constructor Detail

AbstractKernelFunction

protected AbstractKernelFunction(Pattern pattern)
Provides an abstract KernelFunction based on the given pattern.

Parameters:
pattern - a pattern to define the required input format

AbstractKernelFunction

protected AbstractKernelFunction()
Provides an abstract KernelFunction. This constructor can be used if the required input pattern is not yet known at instantiation time and will therefore be set later.

Method Detail

similarity

public final D similarity(Integer id1,
                          Integer id2)
Description copied from interface: SimilarityFunction
Returns the similarity between the two objects specified by their object ids.

Specified by:
similarity in interface SimilarityFunction<O extends DatabaseObject,D extends Distance<D>>
Parameters:
id1 - first object id
id2 - second object id
Returns:
the similarity between the two objects specified by their object ids

similarity

public final D similarity(Integer id1,
                          O o2)
Description copied from interface: SimilarityFunction
Returns the similarity between the two specified objects.

Specified by:
similarity in interface SimilarityFunction<O extends DatabaseObject,D extends Distance<D>>
Parameters:
id1 - first object id
o2 - second DatabaseObject
Returns:
the similarity between the two objects specified by their object ids

Release 0.2.1 (2009-07-13_1605)