Package org.jgrapht.generate
Class CompleteGraphGenerator<V,E>
 java.lang.Object

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

 Type Parameters:
V
 the graph vertex typeE
 the graph edge type
 All Implemented Interfaces:
GraphGenerator<V,E,V>
public class CompleteGraphGenerator<V,E> extends Object implements GraphGenerator<V,E,V>
Generates a complete graph of any size.A complete graph is a graph where every vertex shares an edge with every other vertex. If it is a directed graph, then edges must always exist in both directions.
 Author:
 Tim Shearouse


Constructor Summary
Constructors Constructor Description CompleteGraphGenerator()
Construct a new CompleteGraphGenerator.CompleteGraphGenerator(int size)
Construct a new CompleteGraphGenerator.

Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
generateGraph(Graph<V,E> target, Map<String,V> resultMap)
Generate a graph structure.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jgrapht.generate.GraphGenerator
generateGraph




Constructor Detail

CompleteGraphGenerator
public CompleteGraphGenerator(int size)
Construct a new CompleteGraphGenerator. The generator will first addsize
nodes to the target graph when invokinggenerateGraph(Graph, Map)
. Next, a complete graph is generated on all nodes present in the target graph, including any nodes that were already present in the target graph. Parameters:
size
 number of vertices that will be added to the graph Throws:
IllegalArgumentException
 if the specified size is negative

CompleteGraphGenerator
public CompleteGraphGenerator()
Construct a new CompleteGraphGenerator. A complete graph will be generated using the vertices already present in the target graph when invokinggenerateGraph(Graph, Map)


Method Detail

generateGraph
public void generateGraph(Graph<V,E> target, Map<String,V> resultMap)
Generate a graph structure. The topology of the generated graph is dependent on the implementation. For graphs in which not all vertices share the same automorphism equivalence class, the generator may produce a labeling indicating the roles played by generated elements. This is the purpose of the resultMap parameter. For example, a generator for a wheel graph would designate a hub vertex. Role names used as keys in resultMap should be declared as public static final Strings by implementation classes. Specified by:
generateGraph
in interfaceGraphGenerator<V,E,V>
 Parameters:
target
 receives the generated edges and vertices; if this is nonempty on entry, the result will be a disconnected graph since generated elements will not be connected to existing elementsresultMap
 if nonnull, receives implementationspecific mappings from String roles to graph elements (or collections of graph elements)

