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.subspace.DimensionSelectingDistanceFunction

All Implemented Interfaces:

DistanceFunction<NumberVector<?>,DoubleDistance>, PrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>, PrimitiveDoubleDistanceFunction<NumberVector<?>>, SpatialPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>, SpatialPrimitiveDoubleDistanceFunction<NumberVector<?>>, InspectionUtilFrequentlyScanned, Parameterizable

public class DimensionSelectingDistanceFunction
extends AbstractPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>
implements SpatialPrimitiveDoubleDistanceFunction<NumberVector<?>>

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
DoubleDistance	distance(NumberVector<?> o1, NumberVector<?> o2) Computes the distance between two given DatabaseObjects according to this distance function.
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.
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.
<T extends NumberVector<?>> SpatialPrimitiveDistanceQuery<T,DoubleDistance>	instantiate(Relation<T> database) Instantiate with a database to get the actual distance query.
DoubleDistance	minDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.

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

isMetric, isSymmetric

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

distance

public DoubleDistance distance(NumberVector<?> o1,
                      NumberVector<?> o2)

Description copied from interface: PrimitiveDistanceFunction

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

Specified by:

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

Specified by:

distance in class AbstractPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

minDist

public DoubleDistance minDist(SpatialComparable mbr1,
                     SpatialComparable mbr2)

Description copied from interface: SpatialPrimitiveDistanceFunction

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

Specified by:

minDist in interface SpatialPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

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

getSelectedDimension

public int getSelectedDimension()

Returns the selected dimension.

Returns:

the selected dimension

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>

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>

Specified by:

getDistanceFactory in class AbstractPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>

Returns:

Factory for distance objects

instantiate

public <T extends NumberVector<?>> SpatialPrimitiveDistanceQuery<T,DoubleDistance> instantiate(Relation<T> database)

Description copied from class: AbstractPrimitiveDistanceFunction

Instantiate with a database to get the actual distance query.

Specified by:

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

Specified by:

instantiate in interface SpatialPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>

Overrides:

instantiate in class AbstractPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>

Parameters:

database - Representation

Returns:

Actual distance query.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object