Module org.jgrapht.core

Package org.jgrapht.generate

Class SimpleWeightedGraphMatrixGenerator<V,E>

java.lang.Object

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

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

GraphGenerator<V,E,V>

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

A simple weighted graph matrix generator.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<V>	vertices
protected double[][]	weights

Constructor Summary

Constructors

Constructor	Description
SimpleWeightedGraphMatrixGenerator()

Method Summary

Modifier and Type	Method	Description
void	generateGraph(Graph<V,E> target, Map<String,V> resultMap)	Generate a graph structure.
SimpleWeightedGraphMatrixGenerator<V,E>	vertices(List<V> vertices)	Set the generator vertices.
SimpleWeightedGraphMatrixGenerator<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

vertices

protected List<V> vertices

weights

protected double[][] weights

Constructor Detail

SimpleWeightedGraphMatrixGenerator

public SimpleWeightedGraphMatrixGenerator()

Method Detail

vertices

public SimpleWeightedGraphMatrixGenerator<V,E> vertices(List<V> vertices)

Set the generator vertices.

Parameters:

vertices - the graph vertices

Returns:

the generator

weights

public SimpleWeightedGraphMatrixGenerator<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,
                          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)