org.apache.flink.graph.spargel

Class ScatterGatherIteration<K,VV,Message,EV>

java.lang.Object

org.apache.flink.graph.spargel.ScatterGatherIteration<K,VV,Message,EV>

Type Parameters:

K - The type of the vertex key (the vertex identifier).

VV - The type of the vertex value (the state of the vertex).

Message - The type of the message sent between vertices along the edges.

EV - The type of the values that are associated with the edges.

All Implemented Interfaces:

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

public class ScatterGatherIteration<K,VV,Message,EV>
extends Object
implements CustomUnaryOperation<Vertex<K,VV>,Vertex<K,VV>>

This class represents iterative graph computations, programmed in a scatter-gather perspective. It is a special case of Bulk Synchronous Parallel computation.

Scatter-Gather algorithms operate on graphs, which are defined through vertices and edges. The algorithms send messages along the edges and update the state of vertices based on the old state and the incoming messages. All vertices have an initial state. The computation terminates once no vertex updates its state any more. Additionally, a maximum number of iterations (supersteps) may be specified.

The computation is here represented by two functions:

• The GatherFunction receives incoming messages and may updates the state for the vertex. If a state is updated, messages are sent from this vertex. Initially, all vertices are considered updated.
• The ScatterFunction takes the new vertex state and sends messages along the outgoing edges of the vertex. The outgoing edges may optionally have an associated value, such as a weight.

Scatter-Gather graph iterations are are run by calling Graph.runScatterGatherIteration(ScatterFunction, GatherFunction, int).

Method Summary

Modifier and Type	Method and Description
void	configure(ScatterGatherConfiguration parameters) Configures this scatter-gather iteration with the provided parameters.
DataSet<Vertex<K,VV>>	createResult() Creates the operator that represents this scatter-gather graph computation.
ScatterGatherConfiguration	getIterationConfiguration()
void	setInput(DataSet<Vertex<K,VV>> inputData) Sets the input data set for this operator.
static <K,VV,Message,EV> ScatterGatherIteration<K,VV,Message,EV>	withEdges(DataSet<Edge<K,EV>> edgesWithValue, ScatterFunction<K,VV,Message,EV> sf, GatherFunction<K,VV,Message> gf, int maximumNumberOfIterations) Creates a new scatter-gather iteration operator for graphs where the edges are associated with a value (such as a weight or distance).

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>> inputData)

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:

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

See Also:

CustomUnaryOperation.setInput(org.apache.flink.api.java.DataSet)

createResult

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

Creates the operator that represents this scatter-gather graph computation.

Specified by:

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

Returns:

The operator that represents this scatter-gather graph computation.

withEdges

public static <K,VV,Message,EV> ScatterGatherIteration<K,VV,Message,EV> withEdges(DataSet<Edge<K,EV>> edgesWithValue,
                                                                                  ScatterFunction<K,VV,Message,EV> sf,
                                                                                  GatherFunction<K,VV,Message> gf,
                                                                                  int maximumNumberOfIterations)

Creates a new scatter-gather iteration operator for graphs where the edges are associated with a value (such as a weight or distance).

Type Parameters:

K - The type of the vertex key (the vertex identifier).

VV - The type of the vertex value (the state of the vertex).

Message - The type of the message sent between vertices along the edges.

EV - The type of the values that are associated with the edges.

Parameters:

edgesWithValue - The data set containing edges.

sf - The function that turns changed vertex states into messages along the edges.

gf - The function that updates the state of the vertices from the incoming messages.

Returns:

An in stance of the scatter-gather graph computation operator.

configure

public void configure(ScatterGatherConfiguration parameters)

Configures this scatter-gather iteration with the provided parameters.

Parameters:

parameters - the configuration parameters

getIterationConfiguration

public ScatterGatherConfiguration getIterationConfiguration()

Returns:

the configuration parameters of this scatter-gather iteration