org.apache.flink.graph.library.clustering.undirected

Class LocalClusteringCoefficient<K extends Comparable<K> & org.apache.flink.types.CopyableValue<K>,VV,EV>

java.lang.Object

org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingDataSet<K,VV,EV,LocalClusteringCoefficient.Result<K>>

org.apache.flink.graph.library.clustering.undirected.LocalClusteringCoefficient<K,VV,EV>

Type Parameters:

K - graph ID type

VV - vertex value type

EV - edge value type

All Implemented Interfaces:

GraphAlgorithm<K,VV,EV,DataSet<LocalClusteringCoefficient.Result<K>>>

public class LocalClusteringCoefficient<K extends Comparable<K> & org.apache.flink.types.CopyableValue<K>,VV,EV>
extends GraphAlgorithmWrappingDataSet<K,VV,EV,LocalClusteringCoefficient.Result<K>>

The local clustering coefficient measures the connectedness of each vertex's neighborhood. Scores range from 0.0 (no edges between neighbors) to 1.0 (neighborhood is a clique).
An edge between a vertex's neighbors is a triangle. Counting edges between neighbors is equivalent to counting the number of triangles which include the vertex.
The input graph must be a simple, undirected graph containing no duplicate edges or self-loops.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalClusteringCoefficient.Result<T> Wraps the vertex type to encapsulate results from the Local Clustering Coefficient algorithm.

Constructor Summary

Constructors

Constructor and Description
LocalClusteringCoefficient()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getAlgorithmName() Algorithms are identified by name rather than by class to allow subclassing.
protected boolean	mergeConfiguration(GraphAlgorithmWrappingDataSet other) An algorithm must first test whether the configurations can be merged before merging individual fields.
DataSet<LocalClusteringCoefficient.Result<K>>	runInternal(Graph<K,VV,EV> input) The implementation of the algorithm, renamed from GraphAlgorithm.run(Graph).
LocalClusteringCoefficient<K,VV,EV>	setIncludeZeroDegreeVertices(boolean includeZeroDegreeVertices) By default the vertex set is checked for zero degree vertices.
LocalClusteringCoefficient<K,VV,EV>	setLittleParallelism(int littleParallelism) Override the parallelism of operators processing small amounts of data.

Methods inherited from class org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingDataSet

equals, hashCode, run

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalClusteringCoefficient

public LocalClusteringCoefficient()

Method Detail

setIncludeZeroDegreeVertices

public LocalClusteringCoefficient<K,VV,EV> setIncludeZeroDegreeVertices(boolean includeZeroDegreeVertices)

By default the vertex set is checked for zero degree vertices. When this flag is disabled only clustering coefficient scores for vertices with a degree of a least one will be produced.

Parameters:

includeZeroDegreeVertices - whether to output scores for vertices with a degree of zero

Returns:

this

setLittleParallelism

public LocalClusteringCoefficient<K,VV,EV> setLittleParallelism(int littleParallelism)

Override the parallelism of operators processing small amounts of data.

Parameters:

littleParallelism - operator parallelism

Returns:

this

getAlgorithmName

protected String getAlgorithmName()

Description copied from class: GraphAlgorithmWrappingDataSet

Algorithms are identified by name rather than by class to allow subclassing.

Specified by:

getAlgorithmName in class GraphAlgorithmWrappingDataSet<K extends Comparable<K> & org.apache.flink.types.CopyableValue<K>,VV,EV,LocalClusteringCoefficient.Result<K extends Comparable<K> & org.apache.flink.types.CopyableValue<K>>>

Returns:

name of the algorithm, which may be shared by multiple classes implementing the same algorithm and generating the same output

mergeConfiguration

protected boolean mergeConfiguration(GraphAlgorithmWrappingDataSet other)

Description copied from class: GraphAlgorithmWrappingDataSet

An algorithm must first test whether the configurations can be merged before merging individual fields.

Specified by:

mergeConfiguration in class GraphAlgorithmWrappingDataSet<K extends Comparable<K> & org.apache.flink.types.CopyableValue<K>,VV,EV,LocalClusteringCoefficient.Result<K extends Comparable<K> & org.apache.flink.types.CopyableValue<K>>>

Parameters:

other - the algorithm with which to compare and merge

Returns:

true if and only if configuration has been merged and the algorithm's output can be reused

runInternal

public DataSet<LocalClusteringCoefficient.Result<K>> runInternal(Graph<K,VV,EV> input)
                                                                                                                         throws Exception

Description copied from class: GraphAlgorithmWrappingDataSet

The implementation of the algorithm, renamed from GraphAlgorithm.run(Graph).

Specified by:

runInternal in class GraphAlgorithmWrappingDataSet<K extends Comparable<K> & org.apache.flink.types.CopyableValue<K>,VV,EV,LocalClusteringCoefficient.Result<K extends Comparable<K> & org.apache.flink.types.CopyableValue<K>>>

Parameters:

input - the input graph

Returns:

the algorithm's output

Throws:

Exception