com.tinkerpop.furnace.alpha.generators

Class DistributionGenerator

java.lang.Object

com.tinkerpop.furnace.alpha.generators.AbstractGenerator

com.tinkerpop.furnace.alpha.generators.DistributionGenerator

public class DistributionGenerator
extends AbstractGenerator

Generates a synthetic network for a given out- and (optionally) in-degree distribution. After construction, at least the out-degree distribution must be set via setOutDistribution(com.tinkerpop.furnace.alpha.generators.Distribution)

Author:

Matthias Broecheler (me@matthiasb.com)

Constructor Summary

Constructors

Constructor and Description
DistributionGenerator(String label)
DistributionGenerator(String label, EdgeAnnotator annotator)

Method Summary

Modifier and Type	Method and Description
void	clearInDistribution() Clears the in-degree distribution
int	generate(com.tinkerpop.blueprints.Graph graph, int expectedNumEdges) Generates a synthetic network connecting all vertices in the provided graph with the expected number of edges.
int	generate(com.tinkerpop.blueprints.Graph graph, Iterable<com.tinkerpop.blueprints.Vertex> vertices, int expectedNumEdges) Generates a synthetic network connecting the given vertices by the expected number of directed edges in the provided graph.
int	generate(com.tinkerpop.blueprints.Graph graph, Iterable<com.tinkerpop.blueprints.Vertex> out, Iterable<com.tinkerpop.blueprints.Vertex> in, int expectedNumEdges) Generates a synthetic network connecting the vertices in out by directed edges with those in in with the given number of expected edges in the provided graph.
boolean	hasAllowLoops() Whether edge loops are allowed
void	setAllowLoops(boolean allowLoops) Sets whether loops, i.e.
void	setInDistribution(Distribution distribution) Sets the in-degree distribution to be used by this generator.
void	setOutDistribution(Distribution distribution) Sets the out-degree distribution to be used by this generator.

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

Constructor Detail

DistributionGenerator

public DistributionGenerator(String label,
                             EdgeAnnotator annotator)

Parameters:

label -

annotator -

See Also:

AbstractGenerator.AbstractGenerator(String, EdgeAnnotator)

DistributionGenerator

public DistributionGenerator(String label)

Parameters:

label -

See Also:

AbstractGenerator.AbstractGenerator(String)

Method Detail

setOutDistribution

public void setOutDistribution(Distribution distribution)

Sets the out-degree distribution to be used by this generator. This method must be called prior to generating the network.

Parameters:

distribution -

setInDistribution

public void setInDistribution(Distribution distribution)

Sets the in-degree distribution to be used by this generator. If the in-degree distribution is not specified, CopyDistribution is used by default.

Parameters:

distribution -

clearInDistribution

public void clearInDistribution()

Clears the in-degree distribution

hasAllowLoops

public boolean hasAllowLoops()

Whether edge loops are allowed

Returns:

setAllowLoops

public void setAllowLoops(boolean allowLoops)

Sets whether loops, i.e. edges with the same start and end vertex, are allowed to be generated.

Parameters:

allowLoops -

generate

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

Generates a synthetic network connecting all vertices in the provided graph with the expected number of edges.

Parameters:

graph -

expectedNumEdges -

Returns:

The number of generated edges. Not that this number may not be equal to the expected number of edges

generate

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

Generates a synthetic network connecting the given vertices by the expected number of directed edges in the provided graph.

Parameters:

graph -

vertices -

expectedNumEdges -

Returns:

The number of generated edges. Not that this number may not be equal to the expected number of edges

generate

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

Generates a synthetic network connecting the vertices in out by directed edges with those in in with the given number of expected edges in the provided graph.

Parameters:

graph -

out -

in -

expectedNumEdges -

Returns:

The number of generated edges. Not that this number may not be equal to the expected number of edges