de.lmu.ifi.dbs.elki.distance.distancefunction.subspace
Class AbstractDimensionsSelectingDoubleDistanceFunction<V extends FeatureVector<V,?>>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
          de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction<V,DoubleDistance>
              de.lmu.ifi.dbs.elki.distance.distancefunction.subspace.AbstractDimensionsSelectingDoubleDistanceFunction<V>

Type Parameters:

V - the type of FeatureVector to compute the distances in between

All Implemented Interfaces:

DistanceFunction<V,DoubleDistance>, MeasurementFunction<V,DoubleDistance>, Parameterizable

Direct Known Subclasses:

DimensionsSelectingEuclideanDistanceFunction

public abstract class AbstractDimensionsSelectingDoubleDistanceFunction<V extends FeatureVector<V,?>>
extends AbstractDistanceFunction<V,DoubleDistance>

Provides a distance function that computes the distance (which is a double distance) between feature vectors only in specified dimensions.

Author:

Elke Achtert

Field Summary

private BitSet	dimensions The dimensions to be considered for distance computation.
static OptionID	DIMS_ID OptionID for DIMS_PARAM
private IntListParameter	DIMS_PARAM Dimensions parameter.

Fields inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

distanceFactory

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug, logger

Constructor Summary

AbstractDimensionsSelectingDoubleDistanceFunction(Parameterization config)
Constructor, adhering to Parameterizable

Method Summary

BitSet	getSelectedDimensions() Returns a bit set representing the selected dimensions.
void	setSelectedDimensions(BitSet dimensions) Sets the selected dimensions according to the set bits in the given BitSet.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction

distance, distance

Methods inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

getDatabase, getDistanceFactory, infiniteDistance, nullDistance, setDatabase, undefinedDistance, valueOf

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

getDistanceFactory, infiniteDistance, nullDistance, setDatabase, undefinedDistance, valueOf

Field Detail

DIMS_ID

public static final OptionID DIMS_ID

OptionID for DIMS_PARAM

DIMS_PARAM

private final IntListParameter DIMS_PARAM

Dimensions parameter.

dimensions

private BitSet dimensions

The dimensions to be considered for distance computation.

Constructor Detail

AbstractDimensionsSelectingDoubleDistanceFunction

public AbstractDimensionsSelectingDoubleDistanceFunction(Parameterization config)

Constructor, adhering to Parameterizable

Parameters:

config - Parameterization

Method Detail

getSelectedDimensions

public BitSet getSelectedDimensions()

Returns a bit set representing the selected dimensions.

Returns:

a bit set representing the selected dimensions

setSelectedDimensions

public void setSelectedDimensions(BitSet dimensions)

Sets the selected dimensions according to the set bits in the given BitSet.

Parameters:

dimensions - a BitSet designating the new selected dimensions