de.lmu.ifi.dbs.elki.distance.distancefunction.subspace

Class DimensionSelectingDistanceFunction

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractVectorDoubleDistanceFunction

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractVectorDoubleDistanceNorm

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractSpatialDoubleDistanceNorm

de.lmu.ifi.dbs.elki.distance.distancefunction.subspace.DimensionSelectingDistanceFunction

All Implemented Interfaces:

DistanceFunction<NumberVector<?>,DoubleDistance>, DoubleNorm<NumberVector<?>>, Norm<NumberVector<?>,DoubleDistance>, NumberVectorDistanceFunction<DoubleDistance>, PrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>, PrimitiveDoubleDistanceFunction<NumberVector<?>>, SpatialPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>, SpatialPrimitiveDoubleDistanceFunction<NumberVector<?>>, DimensionSelectingSubspaceDistanceFunction<NumberVector<?>,DoubleDistance>, Parameterizable

public class DimensionSelectingDistanceFunction
extends AbstractSpatialDoubleDistanceNorm
implements DimensionSelectingSubspaceDistanceFunction<NumberVector<?>,DoubleDistance>

Provides a distance function that computes the distance between feature vectors as the absolute difference of their values in a specified dimension.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DimensionSelectingDistanceFunction.Parameterizer Parameterization class.

Field Summary

Fields

Modifier and Type	Field and Description
private int	dim The dimension to be considered for distance computation.
static OptionID	DIM_ID Parameter for dimensionality.

Constructor Summary

Constructors

Constructor and Description
DimensionSelectingDistanceFunction(int dim) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
double	doubleDistance(NumberVector<?> v1, NumberVector<?> v2) Computes the distance between two given DatabaseObjects according to this distance function.
double	doubleMinDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
double	doubleNorm(NumberVector<?> obj) Compute the norm of object obj as double value.
boolean	equals(Object obj)
DoubleDistance	getDistanceFactory() Method to get the distance functions factory.
VectorTypeInformation<? super NumberVector<?>>	getInputTypeRestriction() Get the input data type of the function.
int	getSelectedDimension() Returns the selected dimension.
BitSet	getSelectedDimensions() Deprecated.
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.AbstractSpatialDoubleDistanceNorm

instantiate, minDist

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

norm

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

dimensionality, dimensionality, dimensionality, dimensionality, distance

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

isMetric, isSymmetric

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction

instantiate, isMetric, isSymmetric

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.PrimitiveDistanceFunction

distance

Field Detail

DIM_ID

public static final OptionID DIM_ID

Parameter for dimensionality.

dim

private int dim

The dimension to be considered for distance computation.

Constructor Detail

DimensionSelectingDistanceFunction

public DimensionSelectingDistanceFunction(int dim)

Constructor.

Parameters:

dim - Dimension

Method Detail

doubleDistance

public double doubleDistance(NumberVector<?> v1,
                    NumberVector<?> v2)

Computes the distance between two given DatabaseObjects according to this distance function.

Specified by:

doubleDistance in interface PrimitiveDoubleDistanceFunction<NumberVector<?>>

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

doubleMinDist

public double doubleMinDist(SpatialComparable mbr1,
                   SpatialComparable mbr2)

Description copied from interface: SpatialPrimitiveDoubleDistanceFunction

Computes the distance between the two given MBRs according to this distance function.

Specified by:

doubleMinDist in interface SpatialPrimitiveDoubleDistanceFunction<NumberVector<?>>

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

the distance between the two given MBRs according to this distance function

doubleNorm

public double doubleNorm(NumberVector<?> obj)

Description copied from interface: DoubleNorm

Compute the norm of object obj as double value.

Specified by:

doubleNorm in interface DoubleNorm<NumberVector<?>>

Parameters:

obj - Object

Returns:

Double

getSelectedDimension

public int getSelectedDimension()

Returns the selected dimension.

Returns:

the selected dimension

getSelectedDimensions

@Deprecated
public BitSet getSelectedDimensions()

Deprecated.

Description copied from interface: DimensionSelectingSubspaceDistanceFunction

Returns a bit set representing the selected dimensions.

Specified by:

getSelectedDimensions in interface DimensionSelectingSubspaceDistanceFunction<NumberVector<?>,DoubleDistance>

Returns:

a bit set representing the selected dimensions

setSelectedDimensions

public void setSelectedDimensions(BitSet dimensions)

Description copied from interface: DimensionSelectingSubspaceDistanceFunction

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

Specified by:

setSelectedDimensions in interface DimensionSelectingSubspaceDistanceFunction<NumberVector<?>,DoubleDistance>

Parameters:

dimensions - a BitSet designating the new selected dimensions

getInputTypeRestriction

public VectorTypeInformation<? super NumberVector<?>> getInputTypeRestriction()

Description copied from interface: DistanceFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface DistanceFunction<NumberVector<?>,DoubleDistance>

Specified by:

getInputTypeRestriction in interface PrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>

Overrides:

getInputTypeRestriction in class AbstractVectorDoubleDistanceFunction

Returns:

Type restriction

getDistanceFactory

public DoubleDistance getDistanceFactory()

Description copied from interface: DistanceFunction

Method to get the distance functions factory.

Specified by:

getDistanceFactory in interface DistanceFunction<NumberVector<?>,DoubleDistance>

Overrides:

getDistanceFactory in class AbstractVectorDoubleDistanceFunction

Returns:

Factory for distance objects

equals

public boolean equals(Object obj)

Overrides:

equals in class Object