Class AbstractValueGraph<N,V>
- java.lang.Object
-
- com.google.common.graph.AbstractValueGraph<N,V>
-
- Type Parameters:
N
- Node parameter typeV
- Value parameter type
- All Implemented Interfaces:
PredecessorsFunction<N>
,SuccessorsFunction<N>
,ValueGraph<N,V>
- Direct Known Subclasses:
ImmutableValueGraph
@Beta public abstract class AbstractValueGraph<N,V> extends Object implements ValueGraph<N,V>
This class provides a skeletal implementation ofValueGraph
. It is recommended to extend this class rather than implementValueGraph
directly.The methods implemented in this class should not be overridden unless the subclass admits a more efficient implementation.
- Since:
- 20.0
- Author:
- James Sexton
-
-
Constructor Summary
Constructors Constructor Description AbstractValueGraph()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Graph<N>
asGraph()
Returns a live view of this graph as aGraph
.int
degree(N node)
protected long
edgeCount()
Returns the number of edges in this graph; used to calculate the size ofedges()
.Set<EndpointPair<N>>
edges()
An implementation ofBaseGraph.edges()
defined in terms ofnodes()
andSuccessorsFunction.successors(Object)
.boolean
equals(Object obj)
Indicates whether some other object is "equal to" this one.boolean
hasEdgeConnecting(EndpointPair<N> endpoints)
boolean
hasEdgeConnecting(N nodeU, N nodeV)
int
hashCode()
Returns a hash code value for the object.ElementOrder<N>
incidentEdgeOrder()
Set<EndpointPair<N>>
incidentEdges(N node)
int
inDegree(N node)
protected boolean
isOrderingCompatible(EndpointPair<?> endpoints)
int
outDegree(N node)
String
toString()
Returns a string representation of this graph.protected void
validateEndpoints(EndpointPair<?> endpoints)
ThrowsIllegalArgumentException
if the ordering ofendpoints
is not compatible with the directionality of this graph.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.google.common.graph.ValueGraph
adjacentNodes, allowsSelfLoops, degree, edges, edgeValueOrDefault, edgeValueOrDefault, hasEdgeConnecting, hasEdgeConnecting, incidentEdgeOrder, incidentEdges, inDegree, isDirected, nodeOrder, nodes, outDegree, predecessors, successors
-
-
-
-
Constructor Detail
-
AbstractValueGraph
public AbstractValueGraph()
-
-
Method Detail
-
asGraph
public Graph<N> asGraph()
Description copied from interface:ValueGraph
Returns a live view of this graph as aGraph
. The resultingGraph
will have an edge connecting node A to node B if thisValueGraph
has an edge connecting A to B.- Specified by:
asGraph
in interfaceValueGraph<N,V>
-
equals
public final boolean equals(@CheckForNull Object obj)
Description copied from class:java.lang.Object
Indicates whether some other object is "equal to" this one.The
equals
method implements an equivalence relation on non-null object references:- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.- Specified by:
equals
in interfaceValueGraph<N,V>
- Overrides:
equals
in classObject
- Parameters:
obj
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
- It is reflexive: for any non-null reference value
-
hashCode
public final int hashCode()
Description copied from class:java.lang.Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap
.The general contract of
hashCode
is:- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
Object.equals(java.lang.Object)
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class
Object
does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)- Specified by:
hashCode
in interfaceValueGraph<N,V>
- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
edgeCount
protected long edgeCount()
Returns the number of edges in this graph; used to calculate the size ofedges()
. This implementation requires O(|N|) time. Classes extending this one may manually keep track of the number of edges as the graph is updated, and override this method for better performance.
-
edges
public Set<EndpointPair<N>> edges()
An implementation ofBaseGraph.edges()
defined in terms ofnodes()
andSuccessorsFunction.successors(Object)
.
-
incidentEdgeOrder
public ElementOrder<N> incidentEdgeOrder()
-
incidentEdges
public Set<EndpointPair<N>> incidentEdges(N node)
-
degree
public int degree(N node)
-
inDegree
public int inDegree(N node)
-
outDegree
public int outDegree(N node)
-
hasEdgeConnecting
public boolean hasEdgeConnecting(N nodeU, N nodeV)
-
hasEdgeConnecting
public boolean hasEdgeConnecting(EndpointPair<N> endpoints)
-
validateEndpoints
protected final void validateEndpoints(EndpointPair<?> endpoints)
ThrowsIllegalArgumentException
if the ordering ofendpoints
is not compatible with the directionality of this graph.
-
isOrderingCompatible
protected final boolean isOrderingCompatible(EndpointPair<?> endpoints)
-
-