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

Class SubspaceLPNormDistanceFunction

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distancefunction.subspace.AbstractDimensionsSelectingDistanceFunction<NumberVector>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SubspaceEuclideanDistanceFunction, SubspaceManhattanDistanceFunction, SubspaceMaximumDistanceFunction

public class SubspaceLPNormDistanceFunction
extends AbstractDimensionsSelectingDistanceFunction<NumberVector>
implements SpatialPrimitiveDistanceFunction<NumberVector>, Norm<NumberVector>, NumberVectorDistanceFunction<NumberVector>

L_p-Norm distance function between NumberVectors only in specified dimensions.

Since:

0.1

Author:

Elke Achtert

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private double	p Value of p

Fields inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.subspace.AbstractDimensionsSelectingDistanceFunction

dimensions

Constructor Summary

Constructors

Constructor and Description
SubspaceLPNormDistanceFunction(double p, long[] dimensions) Constructor.

Method Summary

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(java.lang.Object obj)
VectorFieldTypeInformation<? super NumberVector>	getInputTypeRestriction() Get the input data type of the function.
double	getP() Get the value of p.
int	hashCode()
<T extends NumberVector> SpatialPrimitiveDistanceQuery<T>	instantiate(Relation<T> database) Instantiate with a database to get the actual distance query.
boolean	isMetric() Is this distance function metric (satisfy the triangle inequality)
double	minDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
protected double	minDistObject(SpatialComparable mbr, NumberVector v)
double	norm(NumberVector obj) Compute the norm of object obj.

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

getSelectedDimensions, setSelectedDimensions

Methods inherited from class java.lang.Object

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

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

isSquared, isSymmetric

Field Detail

p

private double p

Value of p

Constructor Detail

SubspaceLPNormDistanceFunction

public SubspaceLPNormDistanceFunction(double p,
                                      long[] dimensions)

Constructor.

Parameters:

dimensions - Selected dimensions

p - p value

Method Detail

getP

public double getP()

Get the value of p.

Returns:

p

distance

public double distance(NumberVector v1,
                       NumberVector v2)

Description copied from interface: PrimitiveDistanceFunction

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>

Overrides:

distance in class AbstractDimensionsSelectingDistanceFunction<NumberVector>

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

minDistObject

protected double minDistObject(SpatialComparable mbr,
                               NumberVector v)

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

instantiate

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

Description copied from interface: DistanceFunction

Instantiate with a database to get the actual distance query.

Specified by:

instantiate in interface DistanceFunction<NumberVector>

Specified by:

instantiate in interface PrimitiveDistanceFunction<NumberVector>

Specified by:

instantiate in interface SpatialPrimitiveDistanceFunction<NumberVector>

Parameters:

database - The representation to use

Returns:

Actual distance query.

getInputTypeRestriction

public VectorFieldTypeInformation<? 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>

Returns:

Type restriction

isMetric

public boolean isMetric()

Description copied from interface: DistanceFunction

Is this distance function metric (satisfy the triangle inequality)

Specified by:

isMetric in interface DistanceFunction<NumberVector>

Returns:

true when metric.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractDimensionsSelectingDistanceFunction<NumberVector>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDimensionsSelectingDistanceFunction<NumberVector>