V
 the graph vertex typeE
 the graph edge typepublic class MaskSubgraph<V,E> extends AbstractGraph<V,E>
Constructor and Description 

MaskSubgraph(Graph<V,E> base,
MaskFunctor<V,E> mask)
Creates a new induced subgraph.

Modifier and Type  Method and 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 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)
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.

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.

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.

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 
removeAllEdges(Collection<? extends E> edges)
Removes all the edges in this graph that are also contained in the specified edge collection.

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(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.

Set<V> 
vertexSet()
Returns a set of the vertices contained in this graph.

assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, toString, toStringFromSets
public MaskSubgraph(Graph<V,E> base, MaskFunctor<V,E> mask)
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.public E addEdge(V sourceVertex, V targetVertex)
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 edgemultiplicity). 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
.
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.
null
.Graph.getEdgeFactory()
public boolean addEdge(V sourceVertex, V targetVertex, E 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 edgemultiplicity. 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.
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.edge
 edge to be added to this graph.Graph.addEdge(Object, Object)
,
Graph.getEdgeFactory()
public boolean addVertex(V v)
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.v
 vertex to be added to this graph.public boolean containsEdge(E e)
e2
such that
e.equals(e2)
. If the specified edge is null
returns
false
.e
 edge whose presence in this graph is to be tested.public boolean containsVertex(V v)
u
such that
u.equals(v)
. If the specified vertex is null
returns
false
.v
 vertex whose presence in this graph is to be tested.public int degreeOf(V vertex)
vertex
 vertex whose degree is to be calculatedpublic Set<E> edgeSet()
Graph
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.
public Set<E> edgesOf(V vertex)
Graph
vertex
 the vertex for which a set of touching edges is to be returned.public Set<E> getAllEdges(V sourceVertex, V targetVertex)
Graph
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.
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.public E getEdge(V sourceVertex, V targetVertex)
Graph
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.
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.public EdgeFactory<V,E> getEdgeFactory()
Graph
public V getEdgeSource(E edge)
Graph
edge
 edge of interestpublic V getEdgeTarget(E edge)
Graph
edge
 edge of interestpublic double getEdgeWeight(E edge)
Graph
WeightedGraph.DEFAULT_EDGE_WEIGHT
), allowing weightedgraph algorithms to apply to
them where meaningful.edge
 edge of interestWeightedGraph
public Set<E> incomingEdgesOf(V vertex)
vertex
 the vertex for which the list of incoming edges to be returnedpublic int inDegreeOf(V vertex)
vertex
 vertex whose in degree is to be calculatedpublic int outDegreeOf(V vertex)
vertex
 vertex whose out degree is to be calculatedpublic Set<E> outgoingEdgesOf(V vertex)
vertex
 the vertex for which the list of outgoing edges to be returnedpublic boolean removeAllEdges(Collection<? extends E> edges)
Graph.removeEdge(Object)
method.removeAllEdges
in interface Graph<V,E>
removeAllEdges
in class AbstractGraph<V,E>
edges
 edges to be removed from this graph.Graph.removeAllEdges(Collection)
public Set<E> removeAllEdges(V sourceVertex, V targetVertex)
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.removeAllEdges
in interface Graph<V,E>
removeAllEdges
in class AbstractGraph<V,E>
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.null
if either vertex is not part of graphGraph.removeAllEdges(Object, Object)
public boolean removeAllVertices(Collection<? extends V> vertices)
Graph.removeVertex(Object)
method.removeAllVertices
in interface Graph<V,E>
removeAllVertices
in class AbstractGraph<V,E>
vertices
 vertices to be removed from this graph.Graph.removeAllVertices(Collection)
public boolean removeEdge(E e)
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
.
e
 edge to be removed from this graph, if present.true
if and only if the graph contained the specified edge.public E removeEdge(V sourceVertex, V targetVertex)
null
otherwise.sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge.null
if no edge removed.public boolean removeVertex(V v)
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
.
v
 vertex to be removed from this graph, if present.true
if the graph contained the specified vertex; false
otherwise.public Set<V> vertexSet()
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.
Copyright © 2016. All rights reserved.