org.apache.flink.graph.generator

Class GridGraph

java.lang.Object

org.apache.flink.graph.generator.GraphGeneratorBase<LongValue,NullValue,NullValue>

org.apache.flink.graph.generator.GridGraph

All Implemented Interfaces:

GraphGenerator<LongValue,NullValue,NullValue>

public class GridGraph
extends GraphGeneratorBase<LongValue,NullValue,NullValue>

See Also:

Grid Graph at Wolfram MathWorld

Field Summary

Fields inherited from class org.apache.flink.graph.generator.GraphGeneratorBase

parallelism

Constructor Summary

Constructors

Constructor and Description
GridGraph(ExecutionEnvironment env) An undirected Graph connecting vertices in a regular tiling in one or more dimensions and where the endpoints are optionally connected.

Method Summary

Modifier and Type	Method and Description
GridGraph	addDimension(long size, boolean wrapEndpoints) Required configuration for each dimension of the graph.
Graph<LongValue,NullValue,NullValue>	generate() Generates the configured graph.

Methods inherited from class org.apache.flink.graph.generator.GraphGeneratorBase

setParallelism

Methods inherited from class java.lang.Object

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

Constructor Detail

GridGraph

public GridGraph(ExecutionEnvironment env)

An undirected Graph connecting vertices in a regular tiling in one or more dimensions and where the endpoints are optionally connected.

Parameters:

env - the Flink execution environment

Method Detail

addDimension

public GridGraph addDimension(long size,
                              boolean wrapEndpoints)

Required configuration for each dimension of the graph.

Parameters:

size - number of vertices; dimensions of size 1 are prohibited due to having no effect on the generated graph

wrapEndpoints - whether to connect first and last vertices; this has no effect on dimensions of size 2

Returns:

this

generate

public Graph<LongValue,NullValue,NullValue> generate()

Description copied from interface: GraphGenerator

Generates the configured graph.

Returns:

generated graph