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

Class GlobalClusteringCoefficient.Result

java.lang.Object

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

All Implemented Interfaces:

PrintableResult

Enclosing class:

GlobalClusteringCoefficient<K extends Comparable<K> & CopyableValue<K>,VV,EV>

public static class GlobalClusteringCoefficient.Result
extends Object
implements PrintableResult

Wraps global clustering coefficient metrics.

Constructor Summary

Constructors

Constructor and Description
Result(long tripletCount, long triangleCount) Instantiate an immutable result.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double	getGlobalClusteringCoefficientScore() Get the global clustering coefficient score.
long	getNumberOfTriangles() Get the number of triangles.
long	getNumberOfTriplets() Get the number of triplets.
int	hashCode()
String	toPrintableString() A human-readable representation of this value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result(long tripletCount,
              long triangleCount)

Instantiate an immutable result.

Parameters:

tripletCount - triplet count

triangleCount - triangle count

Method Detail

getNumberOfTriplets

public long getNumberOfTriplets()

Get the number of triplets.

Returns:

number of triplets

getNumberOfTriangles

public long getNumberOfTriangles()

Get the number of triangles.

Returns:

number of triangles

getGlobalClusteringCoefficientScore

public double getGlobalClusteringCoefficientScore()

Get the global clustering coefficient score. This is computed as the number of closed triplets (triangles) divided by the total number of triplets.

A score of Double.NaN is returned for a graph of isolated vertices for which both the triangle count and number of neighbors are zero.

Returns:

global clustering coefficient score

toString

public String toString()

Overrides:

toString in class Object

toPrintableString

public String toPrintableString()

Description copied from interface: PrintableResult

A human-readable representation of this value.

Specified by:

toPrintableString in interface PrintableResult

Returns:

printable string

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object