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

Class OnedimensionalDistanceFunction

java.lang.Object

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

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

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

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

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

All Implemented Interfaces:

DistanceFunction<NumberVector>, Norm<NumberVector>, NumberVectorDistanceFunction<NumberVector>, PrimitiveDistanceFunction<NumberVector>, SpatialPrimitiveDistanceFunction<NumberVector>, DimensionSelectingSubspaceDistanceFunction<NumberVector>

@Alias(value="de.lmu.ifi.dbs.elki.distance.distancefunction.subspace.DimensionSelectingDistanceFunction")
public class OnedimensionalDistanceFunction
extends AbstractSpatialNorm
implements DimensionSelectingSubspaceDistanceFunction<NumberVector>

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

Since:

0.2

Author:

Elke Achtert

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private int	dim The dimension to be considered for distance computation.

Constructor Summary

Constructors

Constructor and Description
OnedimensionalDistanceFunction(int dim) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
double	distance(NumberVector v1, NumberVector v2) Computes the distance between two given DatabaseObjects according to this distance function.
boolean	equals(Object obj)
VectorTypeInformation<? super NumberVector>	getInputTypeRestriction() Get the input data type of the function.
int	getSelectedDimension() Returns the selected dimension.
long[]	getSelectedDimensions() Deprecated.
double	minDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
double	norm(NumberVector obj) Compute the norm of object obj.
void	setSelectedDimensions(long[] dimensions) Deprecated.

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

instantiate

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

dimensionality, dimensionality, dimensionality, dimensionality

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

Field Detail

dim

private int dim

The dimension to be considered for distance computation.

Constructor Detail

OnedimensionalDistanceFunction

public OnedimensionalDistanceFunction(int dim)

Constructor.

Parameters:

dim - Dimension

Method Detail

distance

public double distance(NumberVector v1,
              NumberVector v2)

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

Specified by:

distance in interface NumberVectorDistanceFunction<NumberVector>

Specified by:

distance in interface PrimitiveDistanceFunction<NumberVector>

Specified by:

distance in class AbstractPrimitiveDistanceFunction<NumberVector>

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

minDist

public double 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>

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

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

norm

public double norm(NumberVector obj)

Description copied from interface: Norm

Compute the norm of object obj.

Specified by:

norm in interface Norm<NumberVector>

Parameters:

obj - Object

Returns:

Norm

getSelectedDimension

public int getSelectedDimension()

Returns the selected dimension.

Returns:

the selected dimension

getSelectedDimensions

@Deprecated
public long[] getSelectedDimensions()

Deprecated.

Description copied from interface: DimensionSelectingSubspaceDistanceFunction

Returns a bit set representing the selected dimensions.

Specified by:

getSelectedDimensions in interface DimensionSelectingSubspaceDistanceFunction<NumberVector>

Returns:

a bit set representing the selected dimensions

setSelectedDimensions

@Deprecated
public void setSelectedDimensions(long[] dimensions)

Deprecated.

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>

Parameters:

dimensions - a bit set 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>

Specified by:

getInputTypeRestriction in interface PrimitiveDistanceFunction<NumberVector>

Overrides:

getInputTypeRestriction in class AbstractNumberVectorDistanceFunction

Returns:

Type restriction

equals

public boolean equals(Object obj)

Overrides:

equals in class Object