Package org.jgrapht.generate
Class CompleteGraphGenerator<V,E>
java.lang.Object
org.jgrapht.generate.CompleteGraphGenerator<V,E>
- All Implemented Interfaces:
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. On a side note, a
complete graph is the least efficient possible graph in terms of memory and
cpu usage. Note: This contructor was designed for a simple undirected or
directed graph. It will act strangely when used with certain graph types,
such as undirected multigraphs. Note, though, that a complete undirected
multigraph is rather senseless -- you can keep adding edges and the graph is
never truly complete.
- Since:
- Nov 02, 2008
- Author:
- Tim Shearouse
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
generateGraph
(Graph<V, E> target, VertexFactory<V> vertexFactory, Map<String, V> resultMap) Generate a graph structure.
-
Constructor Details
-
CompleteGraphGenerator
public CompleteGraphGenerator(int size) Construct a new CompleteGraphGenerator.- Parameters:
size
- number of vertices to be generated- Throws:
IllegalArgumentException
- if the specified size is negative.
-
-
Method Details
-
generateGraph
public void generateGraph(Graph<V, E> target, VertexFactory<V> vertexFactory, 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 non-empty on entry, the result will be a disconnected graph since generated elements will not be connected to existing elementsvertexFactory
- called to produce new verticesresultMap
- if non-null, receives implementation-specific mappings from String roles to graph elements (or collections of graph elements)
-