org.apache.flink.graph.gsa

Class GatherSumApplyIteration<K,VV,EV,M>

java.lang.Object

org.apache.flink.graph.gsa.GatherSumApplyIteration<K,VV,EV,M>

Type Parameters:

K - The type of the vertex key in the graph

VV - The type of the vertex value in the graph

EV - The type of the edge value in the graph

M - The intermediate type used by the gather, sum and apply functions

All Implemented Interfaces:

CustomUnaryOperation<Vertex<K,VV>,Vertex<K,VV>>

public class GatherSumApplyIteration<K,VV,EV,M>
extends Object
implements CustomUnaryOperation<Vertex<K,VV>,Vertex<K,VV>>

This class represents iterative graph computations, programmed in a gather-sum-apply perspective.

Method Summary

Modifier and Type	Method and Description
void	configure(GSAConfiguration parameters) Configures this gather-sum-apply iteration with the provided parameters.
DataSet<Vertex<K,VV>>	createResult() Computes the results of the gather-sum-apply iteration
GSAConfiguration	getIterationConfiguration()
void	setInput(DataSet<Vertex<K,VV>> dataSet) Sets the input data set for this operator.
static <K,VV,EV,M> GatherSumApplyIteration<K,VV,EV,M>	withEdges(DataSet<Edge<K,EV>> edges, GatherFunction<VV,EV,M> gather, SumFunction<VV,EV,M> sum, ApplyFunction<K,VV,M> apply, int maximumNumberOfIterations) Creates a new gather-sum-apply iteration operator for graphs

Methods inherited from class java.lang.Object

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

Method Detail

setInput

public void setInput(DataSet<Vertex<K,VV>> dataSet)

Sets the input data set for this operator. In the case of this operator this input data set represents the set of vertices with their initial state.

Specified by:

setInput in interface CustomUnaryOperation<Vertex<K,VV>,Vertex<K,VV>>

Parameters:

dataSet - The input data set, which in the case of this operator represents the set of vertices with their initial state.

createResult

public DataSet<Vertex<K,VV>> createResult()

Computes the results of the gather-sum-apply iteration

Specified by:

createResult in interface CustomUnaryOperation<Vertex<K,VV>,Vertex<K,VV>>

Returns:

The resulting DataSet

withEdges

public static final <K,VV,EV,M> GatherSumApplyIteration<K,VV,EV,M> withEdges(DataSet<Edge<K,EV>> edges,
                                                                             GatherFunction<VV,EV,M> gather,
                                                                             SumFunction<VV,EV,M> sum,
                                                                             ApplyFunction<K,VV,M> apply,
                                                                             int maximumNumberOfIterations)

Creates a new gather-sum-apply iteration operator for graphs

Type Parameters:

K - The type of the vertex key in the graph

VV - The type of the vertex value in the graph

EV - The type of the edge value in the graph

M - The intermediate type used by the gather, sum and apply functions

Parameters:

edges - The edge DataSet

gather - The gather function of the GSA iteration

sum - The sum function of the GSA iteration

apply - The apply function of the GSA iteration

maximumNumberOfIterations - The maximum number of iterations executed

Returns:

An in stance of the gather-sum-apply graph computation operator.

configure

public void configure(GSAConfiguration parameters)

Configures this gather-sum-apply iteration with the provided parameters.

Parameters:

parameters - the configuration parameters

getIterationConfiguration

public GSAConfiguration getIterationConfiguration()

Returns:

the configuration parameters of this gather-sum-apply iteration