Class AbstractImmutableGraphAdapter<E extends it.unimi.dsi.fastutil.ints.IntIntPair>
 Type Parameters:
E
 the type of an edge.
 Direct Known Subclasses:
ImmutableDirectedGraphAdapter
,ImmutableUndirectedGraphAdapter
ImmutableGraph
. Nodes are instances of Integer
corresponding to the index of a
node in WebGraph. Author:
 Sebastiano Vigna

Field Summary
Modifier and TypeFieldDescriptionprotected final it.unimi.dsi.webgraph.ImmutableGraph
The underlying graph.protected long
The number of edges, cached, or 1 if it still unknown.protected final int
The number of nodes ofimmutableGraph
.Fields inherited from interface org.jgrapht.Graph
DEFAULT_EDGE_WEIGHT

Constructor Summary
ModifierConstructorDescriptionprotected
AbstractImmutableGraphAdapter
(it.unimi.dsi.webgraph.ImmutableGraph immutableGraph) 
Method Summary
Modifier and TypeMethodDescriptionCreates a new edge in this graph, going from the source vertex to the target vertex, and returns the created edge.boolean
Adds the specified edge to this graph, going from the source vertex to the target vertex.Creates a new vertex in this graph and returns it.boolean
Adds the specified vertex to this graph if not already present.boolean
containsEdge
(Integer sourceVertex, Integer targetVertex) Returnstrue
if and only if this graph contains an edge going from the source vertex to the target vertex.protected boolean
containsEdgeFast
(int x, int y) boolean
Returnstrue
if this graph contains the specified vertex.getAllEdges
(Integer sourceVertex, Integer targetVertex) Returns a set of all edges connecting source vertex to target vertex if such vertices exist in this graph.Returns an edge connecting source vertex to target vertex if such vertices and such edge exist in this graph.getEdgeSource
(E e) Returns the source vertex of an edge.Return the edge supplier that the graph uses whenever it needs to create new edges.getEdgeTarget
(E e) Returns the target vertex of an edge.double
getEdgeWeight
(E e) Returns the weight assigned to a given edge.Return the vertex supplier that the graph uses whenever it needs to create new vertices.protected abstract E
makeEdge
(int x, int y) boolean
removeEdge
(E e) Removes the specified edge from the graph.removeEdge
(Integer sourceVertex, Integer targetVertex) Removes an edge going from source vertex to target vertex, if such vertices and such edge exist in this graph.boolean
Removes the specified vertex from this graph including all its touching edges if present.void
setEdgeWeight
(E e, double weight) Assigns a weight to an edge.Returns a set of the vertices contained in this graph.Methods inherited from class org.jgrapht.graph.AbstractGraph
assertVertexExist, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toString, toStringFromSets
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jgrapht.Graph
containsEdge, degreeOf, edgeSet, edgesOf, getType, incomingEdgesOf, inDegreeOf, iterables, outDegreeOf, outgoingEdgesOf, setEdgeWeight

Field Details

immutableGraph
protected final it.unimi.dsi.webgraph.ImmutableGraph immutableGraphThe underlying graph. 
n
protected final int nThe number of nodes ofimmutableGraph
. 
m
protected long mThe number of edges, cached, or 1 if it still unknown. This will have to be computed by enumeration for undirected graphs, as we do not know how many loops are present, and for graphs which do not supportImmutableGraph.numArcs()
.


Constructor Details

AbstractImmutableGraphAdapter
protected AbstractImmutableGraphAdapter(it.unimi.dsi.webgraph.ImmutableGraph immutableGraph)


Method Details

getAllEdges
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 isnull
, returnsnull
. 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.

makeEdge

getEdge
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 returnsnull
. If any of the specified vertices isnull
returnsnull
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.

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 methodGraph.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 graphv
must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertexv2
such thatv2.equals(v)
.Care must also be taken when interchanging calls to methods
Graph.addVertex(Object)
andGraph.addVertex()
. In such a case the user must make sure never to add vertices in the graph using methodGraph.addVertex(Object)
, which are going to be returned in the future by the supplied vertex supplier. Such a sequence will result into anIllegalArgumentException
when calling methodGraph.addVertex()
. Returns:
 the vertex supplier or
null
if the graph has no such supplier

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 methodGraph.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 graphe
must not be equal to any other edge in the graph (even if the graph allows edgemultiplicity). More formally, the graph must not contain any edgee2
such thate2.equals(e)
. Returns:
 the edge supplier
null
if the graph has no such supplier

addEdge
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 edgemultiplicity. 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 returnsnull
.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 (seeGraph.getEdgeSupplier()
). For the new edge to be addede
must not be equal to any other edge the graph (even if the graph allows edgemultiplicity). More formally, the graph must not contain any edgee2
such thate2.equals(e)
. If suche2
is found then the newly created edgee
is abandoned, the method leaves this graph unchanged and returnsnull
.If the underlying graph implementation's
Graph.getEdgeSupplier()
returnsnull
, then this method cannot create edges and throws anUnsupportedOperationException
. 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:

addEdge
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 edgee2
such thate2.equals(e)
. If this graph already contains such an edge, the call leaves this graph unchanged and returnsfalse
. Some graphs do not allow edgemultiplicity. 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 returnsfalse
. If the edge was added to the graph, returnstrue
.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.e
 edge to be added to this graph. Returns:
true
if this graph did not already contain the specified edge. See Also:

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 (seeGraph.getVertexSupplier()
). For the new vertex to be addedv
must not be equal to any other vertex in the graph. More formally, the graph must not contain any vertexv2
such thatv2.equals(v)
. If suchv2
is found then the newly created vertexv
is abandoned, the method leaves this graph unchanged and throws anIllegalArgumentException
.If the underlying graph implementation's
Graph.getVertexSupplier()
returnsnull
, then this method cannot create vertices and throws anUnsupportedOperationException
.Care must also be taken when interchanging calls to methods
Graph.addVertex(Object)
andGraph.addVertex()
. In such a case the user must make sure never to add vertices in the graph using methodGraph.addVertex(Object)
, which are going to be returned in the future by the supplied vertex supplier. Such a sequence will result into anIllegalArgumentException
when calling methodGraph.addVertex()
. Returns:
 The newly created vertex if added to the graph.
 See Also:

addVertex
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 vertexu
such thatu.equals(v)
. If this graph already contains such vertex, the call leaves this graph unchanged and returnsfalse
. 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.

containsEdge
Description copied from interface:Graph
Returnstrue
if and only if this graph contains an edge going from the source vertex to the target vertex. In undirected graphs the same result is obtained when source and target are inverted. If any of the specified vertices does not exist in the graph, or if isnull
, returnsfalse
. Specified by:
containsEdge
in interfaceGraph<Integer,
E extends it.unimi.dsi.fastutil.ints.IntIntPair>  Overrides:
containsEdge
in classAbstractGraph<Integer,
E extends it.unimi.dsi.fastutil.ints.IntIntPair>  Parameters:
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge. Returns:
true
if this graph contains the specified edge. See Also:

containsEdgeFast
protected boolean containsEdgeFast(int x, int y) 
containsVertex
Description copied from interface:Graph
Returnstrue
if this graph contains the specified vertex. More formally, returnstrue
if and only if this graph contains a vertexu
such thatu.equals(v)
. If the specified vertex isnull
returnsfalse
. Parameters:
v
 vertex whose presence in this graph is to be tested. Returns:
true
if this graph contains the specified vertex.

removeEdge
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 ornull
otherwise. Parameters:
sourceVertex
 source vertex of the edge.targetVertex
 target vertex of the edge. Returns:
 The removed edge, or
null
if no edge removed.

removeEdge
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 edgee2
such thate2.equals(e)
, if the graph contains such edge. Returnstrue
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
returnsfalse
. Parameters:
e
 edge to be removed from this graph, if present. Returns:
true
if and only if the graph contained the specified edge.

removeVertex
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 vertexu
such thatu.equals(v)
, the call removes all edges that touchu
and then removesu
itself. If no suchu
is found, the call leaves the graph unchanged. Returnstrue
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
returnsfalse
. Parameters:
v
 vertex to be removed from this graph, if present. Returns:
true
if the graph contained the specified vertex;false
otherwise.

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.

getEdgeSource
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:
e
 edge of interest Returns:
 source vertex

getEdgeTarget
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:
e
 edge of interest Returns:
 target vertex

getEdgeWeight
Description copied from interface:Graph
Returns the weight assigned to a given edge. Unweighted graphs return 1.0 (as defined byGraph.DEFAULT_EDGE_WEIGHT
), allowing weightedgraph algorithms to apply to them when meaningful. Parameters:
e
 edge of interest Returns:
 edge weight

setEdgeWeight
Description copied from interface:Graph
Assigns a weight to an edge. Parameters:
e
 edge on which to set weightweight
 new weight for edge
