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

Class AbstractDimensionsSelectingDistanceFunction<V extends FeatureVector<?>>

java.lang.Object

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

Type Parameters:

V - the type of FeatureVector to compute the distances in between

All Implemented Interfaces:

DistanceFunction<V>, PrimitiveDistanceFunction<V>, DimensionSelectingSubspaceDistanceFunction<V>

Direct Known Subclasses:

SubspaceLPNormDistanceFunction

public abstract class AbstractDimensionsSelectingDistanceFunction<V extends FeatureVector<?>>
extends java.lang.Object
implements PrimitiveDistanceFunction<V>, DimensionSelectingSubspaceDistanceFunction<V>

Abstract base class for distances computed only in subspaces. Selected dimensions are encuded as bits in a long[].

Since:

0.1

Author:

Elke Achtert

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected long[]	dimensions The dimensions to be considered for distance computation.

Constructor Summary

Constructors

Constructor and Description
AbstractDimensionsSelectingDistanceFunction(long[] dimensions) Constructor.

Method Summary

Modifier and Type	Method and Description
double	distance(V o1, V o2) Computes the distance between two given DatabaseObjects according to this distance function.
boolean	equals(java.lang.Object obj)
long[]	getSelectedDimensions() Returns a bit set representing the selected dimensions.
int	hashCode()
void	setSelectedDimensions(long[] dimensions) Sets the selected dimensions according to the set bits in the given BitSet.

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.PrimitiveDistanceFunction

getInputTypeRestriction, instantiate

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

isMetric, isSquared, isSymmetric

Field Detail

dimensions

protected long[] dimensions

The dimensions to be considered for distance computation.

Constructor Detail

AbstractDimensionsSelectingDistanceFunction

public AbstractDimensionsSelectingDistanceFunction(long[] dimensions)

Constructor.

Parameters:

dimensions -

Method Detail

distance

public double distance(V o1,
                       V o2)

Description copied from interface: PrimitiveDistanceFunction

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

Specified by:

distance in interface PrimitiveDistanceFunction<V extends FeatureVector<?>>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

getSelectedDimensions

public long[] getSelectedDimensions()

Description copied from interface: DimensionSelectingSubspaceDistanceFunction

Returns a bit set representing the selected dimensions.

Warning: no defensive copy is performed.

Specified by:

getSelectedDimensions in interface DimensionSelectingSubspaceDistanceFunction<V extends FeatureVector<?>>

Returns:

a bit set representing the selected dimensions

setSelectedDimensions

public void setSelectedDimensions(long[] dimensions)

Description copied from interface: DimensionSelectingSubspaceDistanceFunction

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

Warning: no defensive copy is performed.

Specified by:

setSelectedDimensions in interface DimensionSelectingSubspaceDistanceFunction<V extends FeatureVector<?>>

Parameters:

dimensions - a bit set designating the new selected dimensions

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object