Package org.nlpub.watset.graph

Class ChineseWhispers<V,E>

java.lang.Object

org.nlpub.watset.graph.ChineseWhispers<V,E>

Type Parameters:

V - the type of nodes in the graph

E - the type of edges in the graph

All Implemented Interfaces:

org.jgrapht.alg.interfaces.ClusteringAlgorithm<V>

public class ChineseWhispers<V,E>
extends Object
implements org.jgrapht.alg.interfaces.ClusteringAlgorithm<V>

Implementation of the Chinese Whispers algorithm.

See Also:

Biemann (TextGraphs-1)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChineseWhispers.Builder<V,E>	Builder for ChineseWhispers.
protected static class	ChineseWhispers.Implementation<V,E>	Actual implementation of Chinese Whispers.

Nested classes/interfaces inherited from interface org.jgrapht.alg.interfaces.ClusteringAlgorithm

org.jgrapht.alg.interfaces.ClusteringAlgorithm.Clustering<V extends Object>, org.jgrapht.alg.interfaces.ClusteringAlgorithm.ClusteringImpl<V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.jgrapht.alg.interfaces.ClusteringAlgorithm.Clustering<V>	clustering	The cached clustering result.
protected org.jgrapht.Graph<V,E>	graph	The graph.
protected int	iterations	The number of iterations.
protected Random	random	The random number generator.
protected NodeWeighting<V,E>	weighting	The node weighting approach.

Constructor Summary

Constructors

Constructor	Description
ChineseWhispers(org.jgrapht.Graph<V,E> graph, NodeWeighting<V,E> weighting, int iterations, Random random)	Create an instance of the Chinese Whispers algorithm.

Method Summary

Modifier and Type	Method	Description
static <V,E> ChineseWhispers.Builder<V,E>	builder()	Create a builder.
org.jgrapht.alg.interfaces.ClusteringAlgorithm.Clustering<V>	getClustering()

Methods inherited from class java.lang.Object

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

Field Detail

graph

protected final org.jgrapht.Graph<V,E> graph

The graph.

weighting

protected final NodeWeighting<V,E> weighting

The node weighting approach.

iterations

protected final int iterations

The number of iterations.

random

protected final Random random

The random number generator.

clustering

protected org.jgrapht.alg.interfaces.ClusteringAlgorithm.Clustering<V> clustering

The cached clustering result.

Constructor Detail

ChineseWhispers

public ChineseWhispers(org.jgrapht.Graph<V,E> graph,
                       NodeWeighting<V,E> weighting,
                       int iterations,
                       Random random)

Create an instance of the Chinese Whispers algorithm.

Parameters:

graph - the graph

weighting - the node weighting approach

iterations - the number of iterations

random - the random number generator

Method Detail

builder

public static <V,E> ChineseWhispers.Builder<V,E> builder()

Create a builder.

Type Parameters:

V - the type of nodes in the graph

E - the type of edges in the graph

Returns:

a builder

getClustering

public org.jgrapht.alg.interfaces.ClusteringAlgorithm.Clustering<V> getClustering()

Specified by:

getClustering in interface org.jgrapht.alg.interfaces.ClusteringAlgorithm<V>