org.apache.flink.graph.library.clustering.directed

Class LocalClusteringCoefficient<K extends Comparable<K> & CopyableValue<K>,VV,EV>

java.lang.Object

org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase<K,VV,EV,DataSet<T>>

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

org.apache.flink.graph.library.clustering.directed.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> & 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 graph containing no duplicate edges or self-loops.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalClusteringCoefficient.Result<T> A result for the directed Local Clustering Coefficient algorithm.

Field Summary

Fields inherited from class org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase

parallelism

Constructor Summary

Constructors

Constructor and Description
LocalClusteringCoefficient()

Method Summary

Modifier and Type	Method and Description
protected boolean	canMergeConfigurationWith(GraphAlgorithmWrappingBase other) First test whether the algorithm configurations can be merged before the call to GraphAlgorithmWrappingBase.mergeConfiguration(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase).
protected void	mergeConfiguration(GraphAlgorithmWrappingBase other) Merge the other configuration into this algorithm's after the call to GraphAlgorithmWrappingBase.canMergeConfigurationWith(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase) has checked that the configurations can be merged.
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.

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

equals, hashCode, run

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

getAlgorithmName, setParallelism

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

canMergeConfigurationWith

protected boolean canMergeConfigurationWith(GraphAlgorithmWrappingBase other)

Description copied from class: GraphAlgorithmWrappingBase

First test whether the algorithm configurations can be merged before the call to GraphAlgorithmWrappingBase.mergeConfiguration(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase).

Overrides:

canMergeConfigurationWith in class GraphAlgorithmWrappingBase<K extends Comparable<K> & CopyableValue<K>,VV,EV,DataSet<LocalClusteringCoefficient.Result<K extends Comparable<K> & CopyableValue<K>>>>

Parameters:

other - the algorithm with which to compare configuration

Returns:

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

See Also:

GraphAlgorithmWrappingBase.mergeConfiguration(GraphAlgorithmWrappingBase)

mergeConfiguration

protected void mergeConfiguration(GraphAlgorithmWrappingBase other)

Description copied from class: GraphAlgorithmWrappingBase

Merge the other configuration into this algorithm's after the call to GraphAlgorithmWrappingBase.canMergeConfigurationWith(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase) has checked that the configurations can be merged.

Overrides:

mergeConfiguration in class GraphAlgorithmWrappingBase<K extends Comparable<K> & CopyableValue<K>,VV,EV,DataSet<LocalClusteringCoefficient.Result<K extends Comparable<K> & CopyableValue<K>>>>

Parameters:

other - the algorithm from which to merge configuration

See Also:

GraphAlgorithmWrappingBase.canMergeConfigurationWith(GraphAlgorithmWrappingBase)

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> & CopyableValue<K>,VV,EV,LocalClusteringCoefficient.Result<K extends Comparable<K> & CopyableValue<K>>>

Parameters:

input - the input graph

Returns:

the algorithm's output

Throws:

Exception