org.apache.flink.graph.library.metric.directed

Class VertexMetrics<K extends Comparable<K>,VV,EV>

java.lang.Object

org.apache.flink.graph.GraphAnalyticBase<K,VV,EV,VertexMetrics.Result>

org.apache.flink.graph.library.metric.directed.VertexMetrics<K,VV,EV>

Type Parameters:

K - graph ID type

VV - vertex value type

EV - edge value type

All Implemented Interfaces:

GraphAnalytic<K,VV,EV,VertexMetrics.Result>

public class VertexMetrics<K extends Comparable<K>,VV,EV>
extends GraphAnalyticBase<K,VV,EV,VertexMetrics.Result>

Compute the following vertex metrics in a directed graph. - number of vertices - number of edges - number of unidirectional edges - number of bidirectional edges - average degree - number of triplets - maximum degree - maximum out degree - maximum in degree - maximum number of triplets

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VertexMetrics.Result Wraps vertex metrics.

Field Summary

Fields inherited from class org.apache.flink.graph.GraphAnalyticBase

env, parallelism

Constructor Summary

Constructors

Constructor and Description
VertexMetrics()

Method Summary

Modifier and Type	Method and Description
VertexMetrics.Result	getResult() This method must be called after the program has executed.
VertexMetrics<K,VV,EV>	run(Graph<K,VV,EV> input) All GraphAnalytic processing must be terminated by an OutputFormat.
VertexMetrics<K,VV,EV>	setIncludeZeroDegreeVertices(boolean includeZeroDegreeVertices) By default only the edge set is processed for the computation of degree.

Methods inherited from class org.apache.flink.graph.GraphAnalyticBase

execute, execute, setParallelism

Methods inherited from class java.lang.Object

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

Constructor Detail

VertexMetrics

public VertexMetrics()

Method Detail

setIncludeZeroDegreeVertices

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

By default only the edge set is processed for the computation of degree. When this flag is set an additional join is performed against the vertex set in order to output vertices with a degree of zero.

Parameters:

includeZeroDegreeVertices - whether to output vertices with a degree of zero

Returns:

this

run

public VertexMetrics<K,VV,EV> run(Graph<K,VV,EV> input)
                           throws Exception

Description copied from interface: GraphAnalytic

All GraphAnalytic processing must be terminated by an OutputFormat. Rather than obtained via accumulators rather than returned by a DataSet.

Specified by:

run in interface GraphAnalytic<K extends Comparable<K>,VV,EV,VertexMetrics.Result>

Overrides:

run in class GraphAnalyticBase<K extends Comparable<K>,VV,EV,VertexMetrics.Result>

Parameters:

input - input graph

Returns:

this

Throws:

Exception

getResult

public VertexMetrics.Result getResult()

Description copied from interface: GraphAnalytic

This method must be called after the program has executed. 1) "run" analytics and algorithms 2) call ExecutionEnvironment.execute() 3) get analytic results

Returns:

the result