org.apache.flink.graph.generator

Class CirculantGraph

java.lang.Object

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

org.apache.flink.graph.generator.CirculantGraph

All Implemented Interfaces:

GraphGenerator<LongValue,NullValue,NullValue>

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

See Also:

Circulant Graph at Wolfram MathWorld

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CirculantGraph.OffsetRange Stores the start offset and length configuration for an offset range.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINIMUM_OFFSET
static int	MINIMUM_VERTEX_COUNT

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

parallelism

Constructor Summary

Constructors

Constructor and Description
CirculantGraph(ExecutionEnvironment env, long vertexCount) An oriented Graph with n vertices where each vertex vi is connected to vertex v(i+j)%n for each configured offset j.

Method Summary

Modifier and Type	Method and Description
CirculantGraph	addRange(long offset, long length) Required configuration for each range of offsets in 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

Field Detail

MINIMUM_VERTEX_COUNT

public static final int MINIMUM_VERTEX_COUNT

See Also:

Constant Field Values

MINIMUM_OFFSET

public static final int MINIMUM_OFFSET

See Also:

Constant Field Values

Constructor Detail

CirculantGraph

public CirculantGraph(ExecutionEnvironment env,
                      long vertexCount)

An oriented Graph with n vertices where each vertex v_i is connected to vertex v_(i+j)%n for each configured offset j.

Parameters:

env - the Flink execution environment

vertexCount - number of vertices

Method Detail

addRange

public CirculantGraph addRange(long offset,
                               long length)

Required configuration for each range of offsets in the graph.

Parameters:

offset - first offset appointing the vertices' position

length - number of contiguous offsets in range

Returns:

this

generate

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

Description copied from interface: GraphGenerator

Generates the configured graph.

Returns:

generated graph