org.jgrapht.generate

Class CompleteBipartiteGraphGenerator<V,E>

java.lang.Object

org.jgrapht.generate.CompleteBipartiteGraphGenerator<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphGenerator<V,E,V>

public class CompleteBipartiteGraphGenerator<V,E>
extends Object
implements GraphGenerator<V,E,V>

Generates a complete bipartite graph of any size. This is a graph with two partitions; two vertices will contain an edge if and only if they belong to different partitions.

Since:

Dec 21, 2008

Author:

Andrew Newell

Constructor Summary

Constructors

Constructor and Description
CompleteBipartiteGraphGenerator(int partitionOne, int partitionTwo) Creates a new CompleteBipartiteGraphGenerator object.

Method Summary

Modifier and Type	Method and Description
void	generateGraph(Graph<V,E> target, VertexFactory<V> vertexFactory, Map<String,V> resultMap) Construct a complete bipartite graph

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteBipartiteGraphGenerator

public CompleteBipartiteGraphGenerator(int partitionOne,
                                       int partitionTwo)

Creates a new CompleteBipartiteGraphGenerator object.

Parameters:

partitionOne - This is the number of vertices in the first partition

partitionTwo - This is the number of vertices in the second parition

Method Detail

generateGraph

public void generateGraph(Graph<V,E> target,
                          VertexFactory<V> vertexFactory,
                          Map<String,V> resultMap)

Construct a complete bipartite graph

Specified by:

generateGraph in interface GraphGenerator<V,E,V>

Parameters:

target - receives the generated edges and vertices; if this is non-empty on entry, the result will be a disconnected graph since generated elements will not be connected to existing elements

vertexFactory - called to produce new vertices

resultMap - if non-null, receives implementation-specific mappings from String roles to graph elements (or collections of graph elements)