Module org.jgrapht.core
Package 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 java.lang.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.
Author:
Andrew Newell

  • Constructor Summary

    Constructors 
    Constructor Description
    CompleteBipartiteGraphGenerator​(int partitionA, int partitionB)
    Creates a new CompleteBipartiteGraphGenerator object.
    CompleteBipartiteGraphGenerator​(java.util.Set<V> partitionA, java.util.Set<V> partitionB)
    Creates a new CompleteBipartiteGraphGenerator object.

  • Method Summary

    Modifier and Type Method Description
    void generateGraph​(Graph<V,​E> target, java.util.Map<java.lang.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

    Methods inherited from interface org.jgrapht.generate.GraphGenerator

    generateGraph

  • Constructor Details

    • CompleteBipartiteGraphGenerator

      public CompleteBipartiteGraphGenerator​(int partitionA, int partitionB)
      Creates a new CompleteBipartiteGraphGenerator object.
      Parameters:
      partitionA - number of vertices in the first partition
      partitionB - number of vertices in the second partition

    • CompleteBipartiteGraphGenerator

      public CompleteBipartiteGraphGenerator​(java.util.Set<V> partitionA, java.util.Set<V> partitionB)
      Creates a new CompleteBipartiteGraphGenerator object. A complete bipartite graph is generated on the vertices provided between the vertices provided in the two partitions. Note that all vertices in both partitionA and partitionB must be present in the graph or an exception will be thrown during the invocation of generateGraph(Graph, Map)
      Parameters:
      partitionA - first partition
      partitionB - second partition

  • Method Details

    • generateGraph

      public void generateGraph​(Graph<V,​E> target, java.util.Map<java.lang.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
      resultMap - if non-null, receives implementation-specific mappings from String roles to graph elements (or collections of graph elements)