de.lmu.ifi.dbs.elki.distance.similarityfunction.cluster

Class ClusterIntersectionSimilarityFunction

java.lang.Object

de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractPrimitiveSimilarityFunction<Cluster<?>>

de.lmu.ifi.dbs.elki.distance.similarityfunction.cluster.ClusterIntersectionSimilarityFunction

All Implemented Interfaces:

DistanceFunction<Cluster<?>>, PrimitiveDistanceFunction<Cluster<?>>, PrimitiveSimilarityFunction<Cluster<?>>, SimilarityFunction<Cluster<?>>

public class ClusterIntersectionSimilarityFunction
extends AbstractPrimitiveSimilarityFunction<Cluster<?>>
implements PrimitiveDistanceFunction<Cluster<?>>

Measure the similarity of clusters via the intersection size.

Author:

Erich Schubert

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static ClusterIntersectionSimilarityFunction	STATIC Static instance.

Constructor Summary

Constructors

Constructor and Description
ClusterIntersectionSimilarityFunction() Constructor - use the static instance STATIC!

Method Summary

Methods

Modifier and Type	Method and Description
double	distance(Cluster<?> o1, Cluster<?> o2) Computes the distance between two given DatabaseObjects according to this distance function.
SimpleTypeInformation<? super Cluster<?>>	getInputTypeRestriction() Get the input data type of the function.
<T extends Cluster<?>> DistanceSimilarityQuery<T>	instantiate(Relation<T> relation) Instantiate with a representation to get the actual similarity query.
boolean	isMetric() Is this distance function metric (in particular, does it satisfy the triangle equation?)
double	similarity(Cluster<?> o1, Cluster<?> o2) Computes the similarity between two given DatabaseObjects according to this similarity function.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.similarityfunction.AbstractPrimitiveSimilarityFunction

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

isSymmetric

Field Detail

STATIC

public static final ClusterIntersectionSimilarityFunction STATIC

Static instance.

Constructor Detail

ClusterIntersectionSimilarityFunction

public ClusterIntersectionSimilarityFunction()

Constructor - use the static instance STATIC!

Method Detail

similarity

public double similarity(Cluster<?> o1,
                Cluster<?> o2)

Description copied from interface: PrimitiveSimilarityFunction

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

Specified by:

similarity in interface PrimitiveSimilarityFunction<Cluster<?>>

Specified by:

similarity in class AbstractPrimitiveSimilarityFunction<Cluster<?>>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the similarity between two given DatabaseObjects according to this similarity function

distance

public double distance(Cluster<?> o1,
              Cluster<?> o2)

Description copied from interface: PrimitiveDistanceFunction

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

Specified by:

distance in interface PrimitiveDistanceFunction<Cluster<?>>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

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<Cluster<?>>

Returns:

true when metric.

instantiate

public <T extends Cluster<?>> DistanceSimilarityQuery<T> instantiate(Relation<T> relation)

Description copied from interface: SimilarityFunction

Instantiate with a representation to get the actual similarity query.

Specified by:

instantiate in interface DistanceFunction<Cluster<?>>

Specified by:

instantiate in interface SimilarityFunction<Cluster<?>>

Overrides:

instantiate in class AbstractPrimitiveSimilarityFunction<Cluster<?>>

Parameters:

relation - Representation to use

Returns:

Actual distance query.

getInputTypeRestriction

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

Description copied from interface: SimilarityFunction

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface DistanceFunction<Cluster<?>>

Specified by:

getInputTypeRestriction in interface PrimitiveDistanceFunction<Cluster<?>>

Specified by:

getInputTypeRestriction in interface PrimitiveSimilarityFunction<Cluster<?>>

Specified by:

getInputTypeRestriction in interface SimilarityFunction<Cluster<?>>

Specified by:

getInputTypeRestriction in class AbstractPrimitiveSimilarityFunction<Cluster<?>>

Returns:

Type restriction