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

Class SparseLPNormDistanceFunction

java.lang.Object

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

de.lmu.ifi.dbs.elki.distance.distancefunction.minkowski.SparseLPNormDistanceFunction

All Implemented Interfaces:

DistanceFunction<SparseNumberVector<?>,DoubleDistance>, DoubleNorm<SparseNumberVector<?>>, Norm<SparseNumberVector<?>,DoubleDistance>, PrimitiveDistanceFunction<SparseNumberVector<?>,DoubleDistance>, PrimitiveDoubleDistanceFunction<SparseNumberVector<?>>, Parameterizable

Direct Known Subclasses:

SparseEuclideanDistanceFunction, SparseManhattanDistanceFunction, SparseMaximumDistanceFunction

public class SparseLPNormDistanceFunction
extends AbstractPrimitiveDistanceFunction<SparseNumberVector<?>,DoubleDistance>
implements DoubleNorm<SparseNumberVector<?>>

Provides a LP-Norm for FeatureVectors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SparseLPNormDistanceFunction.Parameterizer Parameterizer

Field Summary

Fields

Modifier and Type	Field and Description
private double	invp Keeps the currently set p.
private double	p Keeps the currently set p.

Constructor Summary

Constructors

Constructor and Description
SparseLPNormDistanceFunction(double p) Provides a LP-Norm for FeatureVectors.

Method Summary

Methods

Modifier and Type	Method and Description
DoubleDistance	distance(SparseNumberVector<?> v1, SparseNumberVector<?> v2) Computes the distance between two given DatabaseObjects according to this distance function.
double	doubleDistance(SparseNumberVector<?> v1, SparseNumberVector<?> v2) Computes the distance between two given Objects according to this distance function.
double	doubleNorm(SparseNumberVector<?> v1) Compute the norm of object obj as double value.
DoubleDistance	getDistanceFactory() Method to get the distance functions factory.
SimpleTypeInformation<? super SparseNumberVector<?>>	getInputTypeRestriction() Get the input data type of the function.
boolean	isMetric() Is this distance function metric (in particular, does it satisfy the triangle equation?)
DoubleDistance	norm(SparseNumberVector<?> obj) Compute the norm of object obj.

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

instantiate, isSymmetric

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

instantiate, isSymmetric

Field Detail

p

private double p

Keeps the currently set p.

invp

private double invp

Keeps the currently set p.

Constructor Detail

SparseLPNormDistanceFunction

public SparseLPNormDistanceFunction(double p)

Provides a LP-Norm for FeatureVectors.

Method Detail

doubleDistance

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

Description copied from interface: PrimitiveDoubleDistanceFunction

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

Specified by:

doubleDistance in interface PrimitiveDoubleDistanceFunction<SparseNumberVector<?>>

Parameters:

v1 - first Object

v2 - second Object

Returns:

the distance between two given Objects according to this distance function

doubleNorm

public double doubleNorm(SparseNumberVector<?> v1)

Description copied from interface: DoubleNorm

Compute the norm of object obj as double value.

Specified by:

doubleNorm in interface DoubleNorm<SparseNumberVector<?>>

Parameters:

v1 - Object

Returns:

Double

norm

public DoubleDistance norm(SparseNumberVector<?> obj)

Description copied from interface: Norm

Compute the norm of object obj.

Specified by:

norm in interface Norm<SparseNumberVector<?>,DoubleDistance>

Parameters:

obj - Object

Returns:

Norm

distance

public DoubleDistance distance(SparseNumberVector<?> v1,
                      SparseNumberVector<?> v2)

Description copied from interface: PrimitiveDistanceFunction

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

Specified by:

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

Specified by:

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

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

getDistanceFactory

public DoubleDistance getDistanceFactory()

Description copied from interface: DistanceFunction

Method to get the distance functions factory.

Specified by:

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

Specified by:

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

Returns:

Factory for distance objects

getInputTypeRestriction

public SimpleTypeInformation<? super SparseNumberVector<?>> getInputTypeRestriction()

Description copied from interface: DistanceFunction

Get the input data type of the function.

Specified by:

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

Specified by:

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

Returns:

Type restriction

isMetric

public boolean isMetric()

Description copied from interface: DistanceFunction

Is this distance function metric (in particular, does it satisfy the triangle equation?)

Specified by:

isMetric in interface DistanceFunction<SparseNumberVector<?>,DoubleDistance>

Overrides:

isMetric in class AbstractPrimitiveDistanceFunction<SparseNumberVector<?>,DoubleDistance>

Returns:

true when metric.