Package elki.similarity.cluster

Class ClusteringBCubedF1Similarity

java.lang.Object

elki.similarity.cluster.ClusteringBCubedF1Similarity

All Implemented Interfaces:

Distance<Clustering<?>>, PrimitiveDistance<Clustering<?>>, ClusteringDistanceSimilarity, NormalizedSimilarity<Clustering<?>>, PrimitiveSimilarity<Clustering<?>>, Similarity<Clustering<?>>

@Reference(authors="A. Bagga, B. Baldwin",
           title="Entity-based cross-document coreferencing using the Vector Space Model",
           booktitle="Proc. 17th Int. Conf. on Computational Linguistics (COLING \'98)",
           url="https://doi.org/10.3115/980451.980859",
           bibkey="doi:10.3115/980451.980859")
public class ClusteringBCubedF1Similarity
extends java.lang.Object
implements ClusteringDistanceSimilarity, NormalizedSimilarity<Clustering<?>>

Measure the similarity of clusters via the BCubed F1 Index.

Reference:

A. Bagga, B. Baldwin
Entity-based cross-document coreferencing using the Vector Space Model
Proc. 17th Int. Conf. on Computational Linguistics (COLING '98)

Since:

0.7.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClusteringBCubedF1Similarity.Par	Parameterization class.

Field Summary

Fields

Modifier and Type	Field	Description
static ClusteringBCubedF1Similarity	STATIC	Static instance.

Constructor Summary

Constructors

Constructor	Description
ClusteringBCubedF1Similarity()	Constructor - use the static instance STATIC!

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface elki.similarity.cluster.ClusteringDistanceSimilarity

isSymmetric

Methods inherited from interface elki.distance.Distance

isSquared

Field Detail

STATIC

public static final ClusteringBCubedF1Similarity STATIC

Static instance.

Constructor Detail

ClusteringBCubedF1Similarity

public ClusteringBCubedF1Similarity()

Constructor - use the static instance STATIC!

Method Detail

similarity

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

Description copied from interface: PrimitiveSimilarity

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

Specified by:

similarity in interface PrimitiveSimilarity<Clustering<?>>

Parameters:

o1 - first DatabaseObject

o2 - second DatabaseObject

Returns:

the similarity between two given DatabaseObjects according to this similarity function

distance

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

Description copied from interface: PrimitiveDistance

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

Specified by:

distance in interface PrimitiveDistance<Clustering<?>>

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: Distance

Is this distance function metric (satisfy the triangle inequality)

Specified by:

isMetric in interface Distance<Clustering<?>>

Returns:

true when metric.

instantiate

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

Description copied from interface: Similarity

Instantiate with a representation to get the actual similarity query.

Specified by:

instantiate in interface ClusteringDistanceSimilarity

Specified by:

instantiate in interface Distance<Clustering<?>>

Specified by:

instantiate in interface PrimitiveDistance<Clustering<?>>

Specified by:

instantiate in interface PrimitiveSimilarity<Clustering<?>>

Specified by:

instantiate in interface Similarity<Clustering<?>>

Parameters:

relation - Representation to use

Returns:

Actual distance query.

getInputTypeRestriction

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

Description copied from interface: Similarity

Get the input data type of the function.

Specified by:

getInputTypeRestriction in interface Distance<Clustering<?>>

Specified by:

getInputTypeRestriction in interface PrimitiveDistance<Clustering<?>>

Specified by:

getInputTypeRestriction in interface Similarity<Clustering<?>>

Returns:

Type restriction