Module org.jgrapht.core

Package org.jgrapht.generate

Class SimpleWeightedBipartiteGraphMatrixGenerator<V,E>

java.lang.Object

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

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphGenerator<V,E,V>

public class SimpleWeightedBipartiteGraphMatrixGenerator<V,E>
extends java.lang.Object
implements GraphGenerator<V,E,V>

A simple weighted bipartite graph matrix generator.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<V>	first
protected java.util.List<V>	second
protected double[][]	weights

Constructor Summary

Constructors

Constructor	Description
SimpleWeightedBipartiteGraphMatrixGenerator()

Method Summary

Modifier and Type	Method	Description
SimpleWeightedBipartiteGraphMatrixGenerator<V,E>	first(java.util.List<? extends V> first)	Set the first partition of the generator.
void	generateGraph(Graph<V,E> target, java.util.Map<java.lang.String,V> resultMap)	Generate a graph structure.
SimpleWeightedBipartiteGraphMatrixGenerator<V,E>	second(java.util.List<? extends V> second)	Set the second partition of the generator.
SimpleWeightedBipartiteGraphMatrixGenerator<V,E>	weights(double[][] weights)	Set the weights of the generator.

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

Field Detail

first

protected java.util.List<V> first

second

protected java.util.List<V> second

weights

protected double[][] weights

Constructor Detail

SimpleWeightedBipartiteGraphMatrixGenerator

public SimpleWeightedBipartiteGraphMatrixGenerator()

Method Detail

first

public SimpleWeightedBipartiteGraphMatrixGenerator<V,E> first(java.util.List<? extends V> first)

Set the first partition of the generator.

Parameters:

first - the first partition

Returns:

the generator

second

public SimpleWeightedBipartiteGraphMatrixGenerator<V,E> second(java.util.List<? extends V> second)

Set the second partition of the generator.

Parameters:

second - the second partition

Returns:

the generator

weights

public SimpleWeightedBipartiteGraphMatrixGenerator<V,E> weights(double[][] weights)

Set the weights of the generator.

Parameters:

weights - the weights

Returns:

the generator

generateGraph

public void generateGraph(Graph<V,E> target,
                          java.util.Map<java.lang.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)