org.jgrapht.graph
Class MaskSubgraph<V,E>

java.lang.Object
  extended by org.jgrapht.graph.AbstractGraph<V,E>
      extended by org.jgrapht.graph.MaskSubgraph<V,E>
All Implemented Interfaces:
Graph<V,E>
Direct Known Subclasses:
DirectedMaskSubgraph, UndirectedMaskSubgraph

public class MaskSubgraph<V,E>
extends AbstractGraph<V,E>

An unmodifiable subgraph induced by a vertex/edge masking function. The subgraph will keep track of edges being added to its vertex subset as well as deletion of edges and vertices. When iterating over the vertices/edges, it will iterate over the vertices/edges of the base graph and discard vertices/edges that are masked (an edge with a masked extremity vertex is discarded as well).

Since:
July 5, 2007
Author:
Guillaume Boulmier

Constructor Summary
MaskSubgraph(Graph<V,E> base, MaskFunctor<V,E> mask)
          Creates a new induced subgraph.
 
Method Summary
 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 edge)
          Adds the specified edge to this graph, going from the source vertex to the target vertex.
 boolean addVertex(V v)
          Adds the specified vertex to this graph if not already present.
 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)
           
 java.util.Set<E> edgeSet()
          Returns a set of the edges contained in this graph.
 java.util.Set<E> edgesOf(V vertex)
          Returns a set of all edges touching the specified vertex.
 java.util.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.
 EdgeFactory<V,E> getEdgeFactory()
          Returns the edge factory using which this graph creates new edges.
 V getEdgeSource(E edge)
          Returns the source vertex of an edge.
 V getEdgeTarget(E edge)
          Returns the target vertex of an edge.
 double getEdgeWeight(E edge)
          Returns the weight assigned to a given edge.
 java.util.Set<E> incomingEdgesOf(V vertex)
           
 int inDegreeOf(V vertex)
           
 int outDegreeOf(V vertex)
           
 java.util.Set<E> outgoingEdgesOf(V vertex)
           
 boolean removeAllEdges(java.util.Collection<? extends E> edges)
          Removes all the edges in this graph that are also contained in the specified edge collection.
 java.util.Set<E> removeAllEdges(V sourceVertex, V targetVertex)
          Removes all the edges going from the specified source vertex to the specified target vertex, and returns a set of all removed edges.
 boolean removeAllVertices(java.util.Collection<? extends V> vertices)
          Removes all the vertices in this graph that are also contained in the specified vertex collection.
 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.
 java.util.Set<V> vertexSet()
          Returns a set of the vertices contained in this graph.
 
Methods inherited from class org.jgrapht.graph.AbstractGraph
assertVertexExist, containsEdge, removeAllEdges, toString, toStringFromSets
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MaskSubgraph

public MaskSubgraph(Graph<V,E> base,
                    MaskFunctor<V,E> mask)
Creates a new induced subgraph. Running-time = O(1).

Parameters:
base - the base (backing) graph on which the subgraph will be based.
mask - vertices and edges to exclude in the subgraph. If a vertex/edge is masked, it is as if it is not in the subgraph.
Method Detail

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, than 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 EdgeFactory. 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 returns null.

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.
See Also:
Graph.addEdge(Object, Object)

addEdge

public boolean addEdge(V sourceVertex,
                       V targetVertex,
                       E edge)
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, than this method does not change the graph and returns false. If the edge was added to the graph, returns true.

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

Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
edge - edge to be added to this graph.
Returns:
true if this graph did not already contain the specified edge.
See Also:
Graph.addEdge(Object, Object), Graph.getEdgeFactory()

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.

Parameters:
v - vertex to be added to this graph.
Returns:
true if this graph did not already contain the specified vertex.
See Also:
Graph.addVertex(Object)

containsEdge

public boolean containsEdge(E e)
Description copied from interface: Graph
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.

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)
Description copied from interface: Graph
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.

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)
See Also:
UndirectedGraph.degreeOf(Object)

edgeSet

public java.util.Set<E> edgeSet()
Description copied from interface: Graph
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.

Returns:
a set of the edges contained in this graph.

edgesOf

public java.util.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.

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.

getAllEdges

public java.util.Set<E> getAllEdges(V sourceVertex,
                                    V targetVertex)
Description copied from interface: Graph
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.

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 E getEdge(V sourceVertex,
                 V targetVertex)
Description copied from interface: Graph
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.

getEdgeFactory

public EdgeFactory<V,E> getEdgeFactory()
Description copied from interface: Graph
Returns the edge factory using which this graph creates new edges. The edge factory is defined when the graph is constructed and must not be modified.

Returns:
the edge factory using which this graph creates new edges.

getEdgeSource

public V getEdgeSource(E edge)
Description copied from interface: Graph
Returns the source vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).

Parameters:
edge - edge of interest
Returns:
source vertex

getEdgeTarget

public V getEdgeTarget(E edge)
Description copied from interface: Graph
Returns the target vertex of an edge. For an undirected graph, source and target are distinguishable designations (but without any mathematical meaning).

Parameters:
edge - edge of interest
Returns:
target vertex

getEdgeWeight

public double getEdgeWeight(E edge)
Description copied from interface: Graph
Returns the weight assigned to a given edge. Unweighted graphs return 1.0 (as defined by WeightedGraph.DEFAULT_EDGE_WEIGHT), allowing weighted-graph algorithms to apply to them where meaningful.

Parameters:
edge - edge of interest
Returns:
edge weight
See Also:
WeightedGraph

incomingEdgesOf

public java.util.Set<E> incomingEdgesOf(V vertex)
See Also:
DirectedGraph.incomingEdgesOf(Object)

inDegreeOf

public int inDegreeOf(V vertex)
See Also:
DirectedGraph.inDegreeOf(Object)

outDegreeOf

public int outDegreeOf(V vertex)
See Also:
DirectedGraph.outDegreeOf(Object)

outgoingEdgesOf

public java.util.Set<E> outgoingEdgesOf(V vertex)
See Also:
DirectedGraph.outgoingEdgesOf(Object)

removeAllEdges

public boolean removeAllEdges(java.util.Collection<? extends E> edges)
Description copied from interface: Graph
Removes all the edges in this graph that are also contained in the specified edge collection. After this call returns, this graph will contain no edges in common with the specified edges. This method will invoke the Graph.removeEdge(Object) method.

Specified by:
removeAllEdges in interface Graph<V,E>
Overrides:
removeAllEdges in class AbstractGraph<V,E>
Parameters:
edges - edges to be removed from this graph.
Returns:
true if this graph changed as a result of the call
See Also:
Graph.removeAllEdges(Collection)

removeAllEdges

public java.util.Set<E> removeAllEdges(V sourceVertex,
                                       V targetVertex)
Description copied from interface: Graph
Removes all the edges going from the specified source vertex to the specified target vertex, and returns a set of all removed edges. Returns null if any of the specified vertices does not exist in the graph. If both vertices exist but no edge is found, returns an empty set. This method will either invoke the Graph.removeEdge(Object) method, or the Graph.removeEdge(Object, Object) method.

Specified by:
removeAllEdges in interface Graph<V,E>
Overrides:
removeAllEdges in class AbstractGraph<V,E>
Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
the removed edges, or null if no either vertex not part of graph
See Also:
Graph.removeAllEdges(Object, Object)

removeAllVertices

public boolean removeAllVertices(java.util.Collection<? extends V> vertices)
Description copied from interface: Graph
Removes all the vertices in this graph that are also contained in the specified vertex collection. After this call returns, this graph will contain no vertices in common with the specified vertices. This method will invoke the Graph.removeVertex(Object) method.

Specified by:
removeAllVertices in interface Graph<V,E>
Overrides:
removeAllVertices in class AbstractGraph<V,E>
Parameters:
vertices - vertices to be removed from this graph.
Returns:
true if this graph changed as a result of the call
See Also:
Graph.removeAllVertices(Collection)

removeEdge

public boolean removeEdge(E e)
Description copied from interface: Graph
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.

Parameters:
e - edge to be removed from this graph, if present.
Returns:
true if and only if the graph contained the specified edge.
See Also:
Graph.removeEdge(Object)

removeEdge

public E removeEdge(V sourceVertex,
                    V targetVertex)
Description copied from interface: Graph
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.

Parameters:
sourceVertex - source vertex of the edge.
targetVertex - target vertex of the edge.
Returns:
The removed edge, or null if no edge removed.
See Also:
Graph.removeEdge(Object, Object)

removeVertex

public boolean removeVertex(V v)
Description copied from interface: Graph
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.

Parameters:
v - vertex to be removed from this graph, if present.
Returns:
true if the graph contained the specified vertex; false otherwise.
See Also:
Graph.removeVertex(Object)

vertexSet

public java.util.Set<V> vertexSet()
Description copied from interface: Graph
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.

Returns:
a set view of the vertices contained in this graph.