de.lmu.ifi.dbs.elki.distance.distancefunction
Class SharedUnitedDistanceFunction
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,DoubleDistance>
de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDoubleDistanceFunction<BitVector>
de.lmu.ifi.dbs.elki.distance.distancefunction.SharingDependentItemsetDistanceFunction
de.lmu.ifi.dbs.elki.distance.distancefunction.SharedUnitedDistanceFunction
- All Implemented Interfaces:
- DistanceFunction<BitVector,DoubleDistance>, MeasurementFunction<BitVector,DoubleDistance>, Loggable, Parameterizable
public class SharedUnitedDistanceFunction
- extends SharingDependentItemsetDistanceFunction
Provides a DistanceFunction to compute
a Distance between BitVectors based on the number of shared bits.
- Author:
- Arthur Zimek
Constructor Summary |
SharedUnitedDistanceFunction()
Provides a DistanceFunction to compute
a Distance between BitVectors based on the number of shared bits. |
Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable |
addOption, checkGlobalParameterConstraints, deleteOption, 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 |
SharedUnitedDistanceFunction
public SharedUnitedDistanceFunction()
- Provides a DistanceFunction to compute
a Distance between BitVectors based on the number of shared bits.
distance
public DoubleDistance distance(BitVector o1,
BitVector o2)
- Returns a distance between two Bitvectors.
Distance is 1-ratio(i,cardUnited),
where i is the number of bits shared by both BitVectors,
cardUnited is the cardinality (number of set bits)
of the union of both BitVector's BitSets,
and ratio(i,cardUnited) is 1 if cardUnited is 0, i/cardUnited otherwise.
- Parameters:
o1
- first BitVectoro2
- second BitVector
- Returns:
- Distance between o1 and o2
description
public String description()
- Description copied from interface:
Parameterizable
- Returns a description of the class and the required parameters.
This description should be suitable for a usage description as for a standalone application.
- Specified by:
description
in interface Parameterizable
- Overrides:
description
in class AbstractParameterizable
- Returns:
- String a description of the class and the required parameters
- See Also:
Parameterizable.description()