org.jgrapht.graph.specifics

Class Specifics<V,E>

java.lang.Object

org.jgrapht.graph.specifics.Specifics<V,E>

Type Parameters:

V - the graph vertex type

E - the graph edge type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DirectedSpecifics, UndirectedSpecifics

public abstract class Specifics<V,E>
extends Object
implements Serializable

A base class encapsulating the basic graph operations. Different implementations have different space-time tradeoffs.

Author:

Barak Naveh

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Specifics()

Method Summary

Modifier and Type	Method and Description
abstract void	addEdgeToTouchingVertices(E e) Adds the specified edge to the edge containers of its source and target vertices.
abstract void	addVertex(V vertex) Adds a vertex.
abstract int	degreeOf(V vertex) Returns the degree of the specified vertex.
abstract Set<E>	edgesOf(V vertex) Returns a set of all edges touching the specified vertex.
abstract 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.
abstract 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.
abstract Set<V>	getVertexSet() Get the vertex set.
abstract Set<E>	incomingEdgesOf(V vertex) Returns a set of all edges incoming into the specified vertex.
abstract int	inDegreeOf(V vertex) Returns the "in degree" of the specified vertex.
abstract int	outDegreeOf(V vertex) Returns the "out degree" of the specified vertex.
abstract Set<E>	outgoingEdgesOf(V vertex) Returns a set of all edges outgoing from the specified vertex.
abstract void	removeEdgeFromTouchingVertices(E e) Removes the specified edge from the edge containers of its source and target vertices.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Specifics

public Specifics()

Method Detail

addVertex

public abstract void addVertex(V vertex)

Adds a vertex.

Parameters:

vertex - vertex to be added.

getVertexSet

public abstract Set<V> getVertexSet()

Get the vertex set.

Returns:

the vertex set

getAllEdges

public abstract 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.

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.

getEdge

public abstract 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.

Parameters:

sourceVertex - source vertex of the edge.

targetVertex - target vertex of the edge.

Returns:

an edge connecting source vertex to target vertex.

addEdgeToTouchingVertices

public abstract void addEdgeToTouchingVertices(E e)

Adds the specified edge to the edge containers of its source and target vertices.

Parameters:

e - the edge

degreeOf

public abstract int degreeOf(V vertex)

Returns the degree of the specified vertex. A degree of a vertex in an undirected graph is the number of edges touching that vertex.

Parameters:

vertex - vertex whose degree is to be calculated.

Returns:

the degree of the specified vertex.

edgesOf

public abstract Set<E> edgesOf(V vertex)

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

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.

inDegreeOf

public abstract int inDegreeOf(V vertex)

Returns the "in degree" of the specified vertex.

Parameters:

vertex - vertex whose in degree is to be calculated.

Returns:

the in degree of the specified vertex.

incomingEdgesOf

public abstract Set<E> incomingEdgesOf(V vertex)

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

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.

outDegreeOf

public abstract int outDegreeOf(V vertex)

Returns the "out degree" of the specified vertex.

Parameters:

vertex - vertex whose out degree is to be calculated.

Returns:

the out degree of the specified vertex.

outgoingEdgesOf

public abstract Set<E> outgoingEdgesOf(V vertex)

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

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.

removeEdgeFromTouchingVertices

public abstract void removeEdgeFromTouchingVertices(E e)

Removes the specified edge from the edge containers of its source and target vertices.

Parameters:

e - the edge