org.jgrapht.generate

Class HyperCubeGraphGenerator<V,E>

java.lang.Object

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

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphGenerator<V,E,V>

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

Generates a hyper cube graph of any size. This is a graph that can be represented by bit strings, so for an n-dimensional hypercube each vertex resembles an n-length bit string. Then, two vertices are adjacent if and only if their bitstring differ by exactly one element.

Since:

Dec 21, 2008

Author:

Andrew Newell

Constructor Summary

Constructors

Constructor and Description
HyperCubeGraphGenerator(int dim) Creates a new generator

Method Summary

Modifier and Type	Method and 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, generateGraph, generateGraph

Constructor Detail

HyperCubeGraphGenerator

public HyperCubeGraphGenerator(int dim)

Creates a new generator

Parameters:

dim - the dimension of the hypercube

Method Detail

generateGraph

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

Description copied from interface: GraphGenerator

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 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

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