Module org.jgrapht.core
Package org.jgrapht.generate

Class LinearGraphGenerator<V,E>

java.lang.Object
org.jgrapht.generate.LinearGraphGenerator<V,E>
Type Parameters:
V - the graph vertex type
E - the graph edge type
All Implemented Interfaces:
GraphGenerator<V,E,V>
public class LinearGraphGenerator<V,E> extends Object implements GraphGenerator<V,E,V>
Generates a linear graph of any size. For a directed graph, the edges are oriented from START_VERTEX to END_VERTEX.
Author:
John V. Sichi

  • Field Details

  • Constructor Details

    • LinearGraphGenerator

      public LinearGraphGenerator(int size)
      Construct a new LinearGraphGenerator.
      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, 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 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)