com.tinkerpop.furnace.alpha.generators

Class CommunityGenerator

java.lang.Object

com.tinkerpop.furnace.alpha.generators.AbstractGenerator

com.tinkerpop.furnace.alpha.generators.CommunityGenerator

public class CommunityGenerator
extends AbstractGenerator

Generates a synthetic network with a community structure, that is, several densely connected sub-networks that are loosely connected with one another.

Author:

Matthias Broecheler (me@matthiasb.com)

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_CROSS_COMMUNITY_PERCENTAGE Default value used if setCrossCommunityPercentage(double) is not called.

Constructor Summary

Constructors

Constructor and Description
CommunityGenerator(String label)
CommunityGenerator(String label, EdgeAnnotator annotator)
CommunityGenerator(String label, EdgeAnnotator edgeAnnotator, VertexAnnotator vertexAnnotator)

Method Summary

Modifier and Type	Method and Description
int	generate(com.tinkerpop.blueprints.Graph graph, int expectedNumCommunities, int expectedNumEdges) Generates a synthetic network for all vertices in the given graph such that the provided expected number of communities are generated with the specified expected number of edges.
int	generate(com.tinkerpop.blueprints.Graph graph, Iterable<com.tinkerpop.blueprints.Vertex> vertices, int expectedNumCommunities, int expectedNumEdges) Generates a synthetic network for provided vertices in the given graphh such that the provided expected number of communities are generated with the specified expected number of edges.
double	getCrossCommunityPercentage() Returns the configured cross community percentage.
void	setCommunityDistribution(Distribution community) Sets the distribution to be used to generate the sizes of communities.
void	setCrossCommunityPercentage(double percentage) Sets the percentage of edges that cross a community, i.e.
void	setDegreeDistribution(Distribution degree) Sets the distribution to be used to generate the out-degrees of vertices

Methods inherited from class com.tinkerpop.furnace.alpha.generators.AbstractGenerator

addEdge, getEdgeAnnotator, getLabel, getVertexAnnotator, processVertex

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CROSS_COMMUNITY_PERCENTAGE

public static final double DEFAULT_CROSS_COMMUNITY_PERCENTAGE

Default value used if setCrossCommunityPercentage(double) is not called.

See Also:

Constant Field Values

Constructor Detail

CommunityGenerator

public CommunityGenerator(String label,
                          EdgeAnnotator annotator)

Parameters:

label -

annotator -

See Also:

AbstractGenerator.AbstractGenerator(String, EdgeAnnotator)

CommunityGenerator

public CommunityGenerator(String label,
                          EdgeAnnotator edgeAnnotator,
                          VertexAnnotator vertexAnnotator)

Parameters:

label -

edgeAnnotator -

vertexAnnotator -

See Also:

AbstractGenerator.AbstractGenerator(String, EdgeAnnotator, VertexAnnotator)

CommunityGenerator

public CommunityGenerator(String label)

Parameters:

label -

See Also:

AbstractGenerator.AbstractGenerator(String)

Method Detail

setCommunityDistribution

public void setCommunityDistribution(Distribution community)

Sets the distribution to be used to generate the sizes of communities.

Parameters:

community -

setDegreeDistribution

public void setDegreeDistribution(Distribution degree)

Sets the distribution to be used to generate the out-degrees of vertices

Parameters:

degree -

setCrossCommunityPercentage

public void setCrossCommunityPercentage(double percentage)

Sets the percentage of edges that cross a community, i.e. connect a vertex to a vertex in another community. The lower this value, the higher the modularity of the generated communities.

Parameters:

percentage - Percentage of community crossing edges. Must be in [0,1]

getCrossCommunityPercentage

public double getCrossCommunityPercentage()

Returns the configured cross community percentage.

Returns:

generate

public int generate(com.tinkerpop.blueprints.Graph graph,
                    int expectedNumCommunities,
                    int expectedNumEdges)

Generates a synthetic network for all vertices in the given graph such that the provided expected number of communities are generated with the specified expected number of edges.

Parameters:

graph -

expectedNumCommunities -

expectedNumEdges -

Returns:

The actual number of edges generated. May be different from the expected number.

generate

public int generate(com.tinkerpop.blueprints.Graph graph,
                    Iterable<com.tinkerpop.blueprints.Vertex> vertices,
                    int expectedNumCommunities,
                    int expectedNumEdges)

Generates a synthetic network for provided vertices in the given graphh such that the provided expected number of communities are generated with the specified expected number of edges.

Parameters:

graph -

vertices -

expectedNumCommunities -

expectedNumEdges -

Returns:

The actual number of edges generated. May be different from the expected number.