MarkovClustering (Watset 2.4.0 API)

java.lang.Object
- org.nlpub.watset.graph.MarkovClustering<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 MarkovClustering<V,E>
extends Object
implements org.jgrapht.alg.interfaces.ClusteringAlgorithm<V>
```
Naïve implementation of the Markov Clustering (MCL) algorithm.
This implementation assumes processing of relatively small graphs due to the lack of pruning optimizations.

See Also:

van Dongen (2000), van Dongen (2008)

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`MarkovClustering.Builder<V,E>`	Builder for `MarkovClustering`.
`protected static class`	`MarkovClustering.Implementation<V,E>`	Actual implementation of Markov Clustering.
`static class`	`MarkovClustering.InflateVisitor`	Visitor that raises each element to the power of `r`.
`static class`	`MarkovClustering.NormalizeVisitor`	Visitor that normalizes columns.

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 int`	`e`	The expansion parameter.
`protected org.jgrapht.Graph<V,E>`	`graph`	The graph.
`protected int`	`iterations`	The maximal number of iterations.
`protected double`	`r`	The inflation parameter.

Constructor Summary

Constructors
Constructor	Description
`MarkovClustering(org.jgrapht.Graph<V,E> graph, int e, double r, int iterations)`	Create an instance of the Markov Clustering algorithm.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static <V,E> MarkovClustering.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.
  - e
```
protected final int e
```
    The expansion parameter.
  - r
```
protected final double r
```
    The inflation parameter.
  - iterations
```
protected final int iterations
```
    The maximal number of iterations.
  - clustering
```
protected org.jgrapht.alg.interfaces.ClusteringAlgorithm.Clustering<V> clustering
```
    The cached clustering result.
- Constructor Detail
  - MarkovClustering
```
public MarkovClustering(org.jgrapht.Graph<V,E> graph,
                        int e,
                        double r,
                        int iterations)
```
    Create an instance of the Markov Clustering algorithm.
    
    Parameters:
    
    graph - the graph
    
    e - the expansion parameter
    
    r - the inflation parameter
    
    iterations - the maximal number of iterations
- Method Detail
  - builder
```
public static <V,E> MarkovClustering.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>