V
- the graph vertex typeW
- the value typepublic class ImmutableValueGraphAdapter<V,W> extends BaseValueGraphAdapter<V,W,com.google.common.graph.ImmutableValueGraph<V,W>> implements Graph<V,com.google.common.graph.EndpointPair<V>>, Cloneable, Serializable
ImmutableValueGraph
.
The adapter uses class EndpointPair
to represent edges. Since the underlying value graph
is immutable, the resulting graph is unmodifiable.
The class uses a converter from Guava's values to JGraphT's double weights. Thus, the resulting graph is weighted.
Assume for example that the following class is the value type:
Then one could create an adapter using the following code:class MyValue implements Serializable { private double value; public MyValue(double value) { this.value = value; } public double getValue() { return value; } }
MutableValueGraph<String, MyValue> valueGraph = ValueGraphBuilder.directed().allowsSelfLoops(true).build(); valueGraph.addNode("v1"); valueGraph.addNode("v2"); valueGraph.putEdgeValue("v1", "v2", new MyValue(5.0)); ImmutableValueGraph<String, MyValue> immutableValueGraph = ImmutableValueGraph.copyOf(valueGraph); Graph<String, EndpointPair<String>> graph = new ImmutableValueGraphAdapter<>( immutableValueGraph, (ToDoubleFunction<MyValue> & Serializable) MyValue::getValue); double weight = graph.getEdgeWeight(EndpointPair.ordered("v1", "v2")); // should return 5.0
Modifier and Type | Field and Description |
---|---|
protected static String |
GRAPH_IS_IMMUTABLE |
edgeSupplier, LOOPS_NOT_ALLOWED, unmodifiableEdgeSet, unmodifiableVertexSet, valueConverter, valueGraph, vertexSupplier
DEFAULT_EDGE_WEIGHT
Constructor and Description |
---|
ImmutableValueGraphAdapter(com.google.common.graph.ImmutableValueGraph<V,W> valueGraph,
ToDoubleFunction<W> valueConverter)
Create a new adapter.
|
Modifier and Type | Method and Description |
---|---|
com.google.common.graph.EndpointPair<V> |
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,
com.google.common.graph.EndpointPair<V> 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.
|
GraphType |
getType()
Get the graph type.
|
boolean |
removeEdge(com.google.common.graph.EndpointPair<V> e)
Removes the specified edge from the graph.
|
com.google.common.graph.EndpointPair<V> |
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 |
setEdgeWeight(com.google.common.graph.EndpointPair<V> e,
double weight)
Assigns a weight to an edge.
|
containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getVertexSupplier, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, setEdgeSupplier, setVertexSupplier, vertexSet
assertVertexExist, containsEdge, equals, hashCode, removeAllEdges, removeAllEdges, removeAllEdges, removeAllVertices, toString, toStringFromSets
finalize, getClass, notify, notifyAll, wait, wait, wait
containsEdge, containsEdge, containsVertex, degreeOf, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeSource, getEdgeSupplier, getEdgeTarget, getEdgeWeight, getVertexSupplier, incomingEdgesOf, inDegreeOf, outDegreeOf, outgoingEdgesOf, removeAllEdges, removeAllEdges, removeAllVertices, setEdgeWeight, vertexSet
protected static final String GRAPH_IS_IMMUTABLE
public ImmutableValueGraphAdapter(com.google.common.graph.ImmutableValueGraph<V,W> valueGraph, ToDoubleFunction<W> valueConverter)
valueGraph
- the value graphvalueConverter
- a function that converts a value to a doublepublic com.google.common.graph.EndpointPair<V> addEdge(V sourceVertex, V targetVertex)
Graph
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
.
addEdge
in interface Graph<V,com.google.common.graph.EndpointPair<V>>
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.
null
.Graph.getEdgeSupplier()
public boolean addEdge(V sourceVertex, V targetVertex, com.google.common.graph.EndpointPair<V> e)
Graph
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.
addEdge
in interface Graph<V,com.google.common.graph.EndpointPair<V>>
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.e
- edge to be added to this graph.Graph.addEdge(Object, Object)
,
Graph.getEdgeSupplier()
public V addVertex()
Graph
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()
.
addVertex
in interface Graph<V,com.google.common.graph.EndpointPair<V>>
Graph.getVertexSupplier()
public boolean addVertex(V v)
Graph
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.public com.google.common.graph.EndpointPair<V> removeEdge(V sourceVertex, V targetVertex)
Graph
null
otherwise.removeEdge
in interface Graph<V,com.google.common.graph.EndpointPair<V>>
sourceVertex
- source vertex of the edge.targetVertex
- target vertex of the edge.null
if no edge removed.public boolean removeEdge(com.google.common.graph.EndpointPair<V> e)
Graph
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
.
removeEdge
in interface Graph<V,com.google.common.graph.EndpointPair<V>>
e
- edge to be removed from this graph, if present.true
if and only if the graph contained the specified edge.public boolean removeVertex(V v)
Graph
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
.
removeVertex
in interface Graph<V,com.google.common.graph.EndpointPair<V>>
v
- vertex to be removed from this graph, if present.true
if the graph contained the specified vertex; false
otherwise.public void setEdgeWeight(com.google.common.graph.EndpointPair<V> e, double weight)
Graph
setEdgeWeight
in interface Graph<V,com.google.common.graph.EndpointPair<V>>
e
- edge on which to set weightweight
- new weight for edgepublic GraphType getType()
Graph
public Object clone()
clone
in class Object
RuntimeException
- in case the clone is not supportedObject.clone()
Copyright © 2018. All rights reserved.