Module org.jgrapht.core

Package org.jgrapht.graph

Class AbstractBaseGraph<V,E>

java.lang.Object

org.jgrapht.graph.AbstractGraph<V,E>

org.jgrapht.graph.AbstractBaseGraph<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

Serializable, Cloneable, Graph<V,E>

Direct Known Subclasses:

DefaultDirectedGraph, DefaultUndirectedGraph, DirectedAcyclicGraph, DirectedMultigraph, DirectedPseudograph, FastutilMapGraph, FastutilMapIntVertexGraph, Multigraph, Pseudograph, SimpleDirectedGraph, SimpleGraph

public abstract class AbstractBaseGraph<V,E>
extends AbstractGraph<V,E>
implements Graph<V,E>, Cloneable, Serializable

The most general implementation of the Graph interface.

Its subclasses add various restrictions to get more specific graphs. The decision whether it is directed or undirected is decided at construction time and cannot be later modified (see constructor for details).

The behavior of this class can be adjusted by changing the GraphSpecificsStrategy that is provided from the constructor. All implemented strategies guarantee deterministic vertex and edge set ordering (via LinkedHashMap and LinkedHashSet). The defaults are reasonable for most use-cases, only change if you know what you are doing.

The default graph implementations are not safe for concurrent reads and writes from different threads. If an application attempts to modify a graph in one thread while another thread is reading or writing the same graph, undefined behavior will result. However, concurrent reads against the same graph from different threads are safe. (Note that the Graph interface itself makes no such guarantee, so for non-default implementations, different rules may apply.)

If you need support for concurrent reads and writes, consider using the AsSynchronizedGraph wrapper.

Author:

Barak Naveh, Dimitrios Michail

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.jgrapht.Graph

DEFAULT_EDGE_WEIGHT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBaseGraph(Supplier<V> vertexSupplier, Supplier<E> edgeSupplier, GraphType type)	Construct a new graph.
protected	AbstractBaseGraph(Supplier<V> vertexSupplier, Supplier<E> edgeSupplier, GraphType type, GraphSpecificsStrategy<V,E> graphSpecificsStrategy)	Construct a new graph.

Method Summary

Modifier and Type	Method	Description
E	addEdge(V sourceVertex, V targetVertex)	Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge.
boolean	addEdge(V sourceVertex, V targetVertex, E e)	Adds the specified edge to this graph, going from the source vertex to the target vertex.
V	addVertex()	Creates a new vertex in this graph and returns it.
boolean	addVertex(V v)	Adds the specified vertex to this graph if not already present.
Object	clone()	Returns a shallow copy of this graph instance.
boolean	containsEdge(E e)	Returns true if this graph contains the specified edge.
boolean	containsVertex(V v)	Returns true if this graph contains the specified vertex.
int	degreeOf(V vertex)	Returns the degree of the specified vertex.
Set<E>	edgeSet()	Returns a set of the edges contained in this graph.
Set<E>	edgesOf(V vertex)	Returns a set of all edges touching the specified vertex.
Set<E>	getAllEdges(V sourceVertex, V targetVertex)	Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph.
E	getEdge(V sourceVertex, V targetVertex)	Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph.
V	getEdgeSource(E e)	Returns the source vertex of an edge.
Supplier<E>	getEdgeSupplier()	Return the edge supplier that the graph uses whenever it needs to create new edges.
V	getEdgeTarget(E e)	Returns the target vertex of an edge.
double	getEdgeWeight(E e)	Returns the weight assigned to a given edge.
GraphType	getType()	Get the graph type.
Supplier<V>	getVertexSupplier()	Return the vertex supplier that the graph uses whenever it needs to create new vertices.
Set<E>	incomingEdgesOf(V vertex)	Returns a set of all edges incoming into the specified vertex.
int	inDegreeOf(V vertex)	Returns the "in degree" of the specified vertex.
GraphIterables<V,E>	iterables()	Access the graph using the GraphIterables interface.
int	outDegreeOf(V vertex)	Returns the "out degree" of the specified vertex.
Set<E>	outgoingEdgesOf(V vertex)	Returns a set of all edges outgoing from the specified vertex.
boolean	removeEdge(E e)	Removes the specified edge from the graph.
E	removeEdge(V sourceVertex, V targetVertex)	Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph.
boolean	removeVertex(V v)	Removes the specified vertex from this graph including all its touching edges if present.
void	setEdgeSupplier(Supplier<E> edgeSupplier)	Set the edge supplier that the graph uses whenever it needs to create new edges.
void	setEdgeWeight(E e, double weight)	Assigns a weight to an edge.
void	setVertexSupplier(Supplier<V> vertexSupplier)	Set the vertex supplier that the graph uses whenever it needs to create new vertices.
Set<V>	vertexSet()	Returns a set of the vertices contained in this graph.

Methods inherited from class org.jgrapht.graph.AbstractGraph

assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toString, toStringFromSets

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jgrapht.Graph

containsEdge, removeAllEdges, removeAllEdges, removeAllVertices, setEdgeWeight

Constructor Detail

AbstractBaseGraph

protected AbstractBaseGraph(Supplier<V> vertexSupplier,
                            Supplier<E> edgeSupplier,
                            GraphType type)

Construct a new graph.

Parameters:

vertexSupplier - the vertex supplier, can be null

edgeSupplier - the edge supplier, can be null

type - the graph type

Throws:

IllegalArgumentException - if the graph type is mixed

AbstractBaseGraph

protected AbstractBaseGraph(Supplier<V> vertexSupplier,
                            Supplier<E> edgeSupplier,
                            GraphType type,
                            GraphSpecificsStrategy<V,E> graphSpecificsStrategy)

Construct a new graph.

Parameters:

vertexSupplier - the vertex supplier, can be null

edgeSupplier - the edge supplier, can be null

type - the graph type

graphSpecificsStrategy - strategy for constructing low-level graph specifics

Throws:

IllegalArgumentException - if the graph type is mixed

Method Detail

getAllEdges

public Set<E> getAllEdges(V sourceVertex,
                          V targetVertex)

Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph. If any of the vertices does not exist or is null, returns null. If both vertices exist but no edges found, returns an empty set.

In undirected graphs, some of the returned edges may have their source and target vertices in the opposite order. In simple graphs the returned set is either singleton set or empty set.

Specified by:

getAllEdges in interface Graph<V,E>

Parameters:

sourceVertex - source vertex of the edge.

targetVertex - target vertex of the edge.

Returns:

a set of all edges connecting source vertex to target vertex.

getEdgeSupplier

public Supplier<E> getEdgeSupplier()

Description copied from interface: Graph

Return the edge supplier that the graph uses whenever it needs to create new edges.

A graph uses the edge supplier to create new edge objects whenever a user calls method Graph.addEdge(Object, Object). Users can also create the edge in user code and then use method Graph.addEdge(Object, Object, Object) to add the edge.

In contrast with the Supplier interface, the edge supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new edge to be added in a graph e must not be equal to any other edge in the graph (even if the graph allows edge-multiplicity). More formally, the graph must not contain any edge e2 such that e2.equals(e).

Specified by:

getEdgeSupplier in interface Graph<V,E>

Returns:

the edge supplier null if the graph has no such supplier

setEdgeSupplier

public void setEdgeSupplier(Supplier<E> edgeSupplier)

Set the edge supplier that the graph uses whenever it needs to create new edges.

A graph uses the edge supplier to create new edge objects whenever a user calls method Graph.addEdge(Object, Object). Users can also create the edge in user code and then use method Graph.addEdge(Object, Object, Object) to add the edge.

In contrast with the Supplier interface, the edge supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new edge to be added in a graph e must not be equal to any other edge in the graph (even if the graph allows edge-multiplicity). More formally, the graph must not contain any edge e2 such that e2.equals(e).

Parameters:

edgeSupplier - the edge supplier

getVertexSupplier

public Supplier<V> getVertexSupplier()

Description copied from interface: Graph

Return the vertex supplier that the graph uses whenever it needs to create new vertices.

A graph uses the vertex supplier to create new vertex objects whenever a user calls method Graph.addVertex(). Users can also create the vertex in user code and then use method Graph.addVertex(Object) to add the vertex.

In contrast with the Supplier interface, the vertex supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new vertex to be added in a graph v must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertex v2 such that v2.equals(v).

Care must also be taken when interchanging calls to methods Graph.addVertex(Object) and Graph.addVertex(). In such a case the user must make sure never to add vertices in the graph using method Graph.addVertex(Object), which are going to be returned in the future by the supplied vertex supplier. Such a sequence will result into an IllegalArgumentException when calling method Graph.addVertex().

Specified by:

getVertexSupplier in interface Graph<V,E>

Returns:

the vertex supplier or null if the graph has no such supplier

setVertexSupplier

public void setVertexSupplier(Supplier<V> vertexSupplier)

Set the vertex supplier that the graph uses whenever it needs to create new vertices.

A graph uses the vertex supplier to create new vertex objects whenever a user calls method Graph.addVertex(). Users can also create the vertex in user code and then use method Graph.addVertex(Object) to add the vertex.

In contrast with the Supplier interface, the vertex supplier has the additional requirement that a new and distinct result is returned every time it is invoked. More specifically for a new vertex to be added in a graph v must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertex v2 such that v2.equals(v).

Care must also be taken when interchanging calls to methods Graph.addVertex(Object) and Graph.addVertex(). In such a case the user must make sure never to add vertices in the graph using method Graph.addVertex(Object), which are going to be returned in the future by the supplied vertex supplier. Such a sequence will result into an IllegalArgumentException when calling method Graph.addVertex().

Parameters:

vertexSupplier - the vertex supplier

getEdge

public E getEdge(V sourceVertex,
                 V targetVertex)

Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph. Otherwise returns null. If any of the specified vertices is null returns null

In undirected graphs, the returned edge may have its source and target vertices in the opposite order.

Specified by:

getEdge in interface Graph<V,E>

Parameters:

sourceVertex - source vertex of the edge.

targetVertex - target vertex of the edge.

Returns:

an edge connecting source vertex to target vertex.

addEdge

public E addEdge(V sourceVertex,
                 V targetVertex)

Description copied from interface: Graph

Creates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge. Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, then this method does not change the graph and returns null.

The source and target vertices must already be contained in this graph. If they are not found in graph IllegalArgumentException is thrown.

This method creates the new edge e using this graph's edge supplier (see Graph.getEdgeSupplier()). For the new edge to be added e must not be equal to any other edge the graph (even if the graph allows edge-multiplicity). More formally, the graph must not contain any edge e2 such that e2.equals(e). If such e2 is found then the newly created edge e is abandoned, the method leaves this graph unchanged and returns null.

If the underlying graph implementation's Graph.getEdgeSupplier() returns null, then this method cannot create edges and throws an UnsupportedOperationException.

Specified by:

addEdge in interface Graph<V,E>

Parameters:

sourceVertex - source vertex of the edge.

targetVertex - target vertex of the edge.

Returns:

The newly created edge if added to the graph, otherwise null.

Throws:

IllegalArgumentException - if source or target vertices are not found in the graph or if there is a property of this graph that prevents the addition of the edge

NullPointerException - if any of the specified vertices is null.

UnsupportedOperationException - if the graph was not initialized with an edge supplier or if this graph disallows modification

See Also:

Graph.getEdgeSupplier()

addEdge

public boolean addEdge(V sourceVertex,
                       V targetVertex,
                       E e)

Description copied from interface: Graph

Adds the specified edge to this graph, going from the source vertex to the target vertex. More formally, adds the specified edge, e, to this graph if this graph contains no edge e2 such that e2.equals(e). If this graph already contains such an edge, the call leaves this graph unchanged and returns false. Some graphs do not allow edge-multiplicity. In such cases, if the graph already contains an edge from the specified source to the specified target, then this method does not change the graph and returns false. If the edge was added to the graph, returns true.

Specified by:

addEdge in interface Graph<V,E>

Parameters:

sourceVertex - source vertex of the edge.

targetVertex - target vertex of the edge.

e - edge to be added to this graph.

Returns:

true if this graph did not already contain the specified edge.

Throws:

IllegalArgumentException - if source or target vertices are not found in the graph or if there is a property of this graph that prevents the addition of the edge

NullPointerException - if any of the arguments is null

See Also:

Graph.addEdge(Object, Object), Graph.getEdgeSupplier()

addVertex

public V addVertex()

Description copied from interface: Graph

Creates a new vertex in this graph and returns it.

This method creates the new vertex v using this graph's vertex supplier (see Graph.getVertexSupplier()). For the new vertex to be added v must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertex v2 such that v2.equals(v). If such v2 is found then the newly created vertex v is abandoned, the method leaves this graph unchanged and throws an IllegalArgumentException.

If the underlying graph implementation's Graph.getVertexSupplier() returns null, then this method cannot create vertices and throws an UnsupportedOperationException.

Care must also be taken when interchanging calls to methods Graph.addVertex(Object) and Graph.addVertex(). In such a case the user must make sure never to add vertices in the graph using method Graph.addVertex(Object), which are going to be returned in the future by the supplied vertex supplier. Such a sequence will result into an IllegalArgumentException when calling method Graph.addVertex().

Specified by:

addVertex in interface Graph<V,E>

Returns:

The newly created vertex if added to the graph.

Throws:

IllegalArgumentException - if the graph supplier returns a vertex which is already in the graph

UnsupportedOperationException - if this graph was not initialized with a vertex supplier or if this graph disallows modification

See Also:

Graph.getVertexSupplier()

addVertex

public boolean addVertex(V v)

Description copied from interface: Graph

Adds the specified vertex to this graph if not already present. More formally, adds the specified vertex, v, to this graph if this graph contains no vertex u such that u.equals(v). If this graph already contains such vertex, the call leaves this graph unchanged and returns false. In combination with the restriction on constructors, this ensures that graphs never contain duplicate vertices.

Specified by:

addVertex in interface Graph<V,E>

Parameters:

v - vertex to be added to this graph.

Returns:

true if this graph did not already contain the specified vertex.

Throws:

NullPointerException - if the specified vertex is null.

getEdgeSource

public V getEdgeSource(E e)

Returns the source vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).

Specified by:

getEdgeSource in interface Graph<V,E>

Parameters:

e - edge of interest

Returns:

source vertex

getEdgeTarget

public V getEdgeTarget(E e)

Returns the target vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).

Specified by:

getEdgeTarget in interface Graph<V,E>

Parameters:

e - edge of interest

Returns:

target vertex

clone

public Object clone()

Returns a shallow copy of this graph instance. Neither edges nor vertices are cloned.

Overrides:

clone in class Object

Returns:

a shallow copy of this graph.

Throws:

RuntimeException - in case the clone is not supported

See Also:

Object.clone()

containsEdge

public boolean containsEdge(E e)

Returns true if this graph contains the specified edge. More formally, returns true if and only if this graph contains an edge e2 such that e.equals(e2). If the specified edge is null returns false.

Specified by:

containsEdge in interface Graph<V,E>

Parameters:

e - edge whose presence in this graph is to be tested.

Returns:

true if this graph contains the specified edge.

containsVertex

public boolean containsVertex(V v)

Returns true if this graph contains the specified vertex. More formally, returns true if and only if this graph contains a vertex u such that u.equals(v). If the specified vertex is null returns false.

Specified by:

containsVertex in interface Graph<V,E>

Parameters:

v - vertex whose presence in this graph is to be tested.

Returns:

true if this graph contains the specified vertex.

degreeOf

public int degreeOf(V vertex)

Description copied from interface: Graph

Returns the degree of the specified vertex.

A degree of a vertex in an undirected graph is the number of edges touching that vertex. Edges with same source and target vertices (self-loops) are counted twice.

In directed graphs this method returns the sum of the "in degree" and the "out degree".

Specified by:

degreeOf in interface Graph<V,E>

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.

Throws:

IllegalArgumentException - if vertex is not found in the graph.

NullPointerException - if vertex is null.

edgeSet

public Set<E> edgeSet()

Returns a set of the edges contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.

The graph implementation may maintain a particular set ordering (e.g. via LinkedHashSet) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

Specified by:

edgeSet in interface Graph<V,E>

Returns:

a set of the edges contained in this graph.

edgesOf

public Set<E> edgesOf(V vertex)

Description copied from interface: Graph

Returns a set of all edges touching the specified vertex. If no edges are touching the specified vertex returns an empty set.

Specified by:

edgesOf in interface Graph<V,E>

Parameters:

vertex - the vertex for which a set of touching edges is to be returned.

Returns:

a set of all edges touching the specified vertex.

Throws:

IllegalArgumentException - if vertex is not found in the graph.

NullPointerException - if vertex is null.

inDegreeOf

public int inDegreeOf(V vertex)

Description copied from interface: Graph

Returns the "in degree" of the specified vertex.

The "in degree" of a vertex in a directed graph is the number of inward directed edges from that vertex. See http://mathworld.wolfram.com/Indegree.html.

In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (self-loops) are counted twice.

Specified by:

inDegreeOf in interface Graph<V,E>

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.

Throws:

IllegalArgumentException - if vertex is not found in the graph.

NullPointerException - if vertex is null.

incomingEdgesOf

public Set<E> incomingEdgesOf(V vertex)

Description copied from interface: Graph

Returns a set of all edges incoming into the specified vertex.

In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.

Specified by:

incomingEdgesOf in interface Graph<V,E>

Parameters:

vertex - the vertex for which the list of incoming edges to be returned.

Returns:

a set of all edges incoming into the specified vertex.

Throws:

IllegalArgumentException - if vertex is not found in the graph.

NullPointerException - if vertex is null.

outDegreeOf

public int outDegreeOf(V vertex)

Description copied from interface: Graph

Returns the "out degree" of the specified vertex.

The "out degree" of a vertex in a directed graph is the number of outward directed edges from that vertex. See http://mathworld.wolfram.com/Outdegree.html.

In the case of undirected graphs this method returns the number of edges touching the vertex. Edges with same source and target vertices (self-loops) are counted twice.

Specified by:

outDegreeOf in interface Graph<V,E>

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.

Throws:

IllegalArgumentException - if vertex is not found in the graph.

NullPointerException - if vertex is null.

outgoingEdgesOf

public Set<E> outgoingEdgesOf(V vertex)

Description copied from interface: Graph

Returns a set of all edges outgoing from the specified vertex.

In the case of undirected graphs this method returns all edges touching the vertex, thus, some of the returned edges may have their source and target vertices in the opposite order.

Specified by:

outgoingEdgesOf in interface Graph<V,E>

Parameters:

vertex - the vertex for which the list of outgoing edges to be returned.

Returns:

a set of all edges outgoing from the specified vertex.

Throws:

IllegalArgumentException - if vertex is not found in the graph.

NullPointerException - if vertex is null.

removeEdge

public E removeEdge(V sourceVertex,
                    V targetVertex)

Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph. Returns the edge if removed or null otherwise.

Specified by:

removeEdge in interface Graph<V,E>

Parameters:

sourceVertex - source vertex of the edge.

targetVertex - target vertex of the edge.

Returns:

The removed edge, or null if no edge removed.

removeEdge

public boolean removeEdge(E e)

Removes the specified edge from the graph. Removes the specified edge from this graph if it is present. More formally, removes an edge e2 such that e2.equals(e), if the graph contains such edge. Returns true if the graph contained the specified edge. (The graph will not contain the specified edge once the call returns).

If the specified edge is null returns false.

Specified by:

removeEdge in interface Graph<V,E>

Parameters:

e - edge to be removed from this graph, if present.

Returns:

true if and only if the graph contained the specified edge.

removeVertex

public boolean removeVertex(V v)

Removes the specified vertex from this graph including all its touching edges if present. More formally, if the graph contains a vertex u such that u.equals(v), the call removes all edges that touch u and then removes u itself. If no such u is found, the call leaves the graph unchanged. Returns true if the graph contained the specified vertex. (The graph will not contain the specified vertex once the call returns).

If the specified vertex is null returns false.

Specified by:

removeVertex in interface Graph<V,E>

Parameters:

v - vertex to be removed from this graph, if present.

Returns:

true if the graph contained the specified vertex; false otherwise.

vertexSet

public Set<V> vertexSet()

Returns a set of the vertices contained in this graph. The set is backed by the graph, so changes to the graph are reflected in the set. If the graph is modified while an iteration over the set is in progress, the results of the iteration are undefined.

The graph implementation may maintain a particular set ordering (e.g. via LinkedHashSet) for deterministic iteration, but this is not required. It is the responsibility of callers who rely on this behavior to only use graph implementations which support it.

Specified by:

vertexSet in interface Graph<V,E>

Returns:

a set view of the vertices contained in this graph.

getEdgeWeight

public double getEdgeWeight(E e)

Description copied from interface: Graph

Returns the weight assigned to a given edge. Unweighted graphs return 1.0 (as defined by Graph.DEFAULT_EDGE_WEIGHT), allowing weighted-graph algorithms to apply to them when meaningful.

Specified by:

getEdgeWeight in interface Graph<V,E>

Parameters:

e - edge of interest

Returns:

edge weight

Throws:

NullPointerException - if argument is null

setEdgeWeight

public void setEdgeWeight(E e,
                          double weight)

Description copied from interface: Graph

Assigns a weight to an edge.

Specified by:

setEdgeWeight in interface Graph<V,E>

Parameters:

e - edge on which to set weight

weight - new weight for edge

Throws:

NullPointerException - if e is null

UnsupportedOperationException - if the graph does not support weights or if there is a property of this graph that disallows modification of the weight

getType

public GraphType getType()

Get the graph type. The graph type can be used to query for additional metadata such as whether the graph supports directed or undirected edges, self-loops, multiple (parallel) edges, weights, etc.

Specified by:

getType in interface Graph<V,E>

Returns:

the graph type

iterables

public GraphIterables<V,E> iterables()

Description copied from interface: Graph

Access the graph using the GraphIterables interface. This allows accessing graphs without the restrictions imposed by 32-bit arithmetic. Moreover, graph implementations are free to implement this interface without explicitly materializing intermediate results.

Specified by:

iterables in interface Graph<V,E>

Returns:

the graph iterables