001/*
002 * Copyright (C) 2016 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.google.common.graph;
018
019import com.google.common.annotations.Beta;
020import java.util.Collection;
021import java.util.Set;
022import org.checkerframework.checker.nullness.compatqual.NullableDecl;
023
024/**
025 * An interface for <a
026 * href="https://en.wikipedia.org/wiki/Graph_(discrete_mathematics)">graph</a>-structured data,
027 * whose edges have associated non-unique values.
028 *
029 * <p>A graph is composed of a set of nodes and a set of edges connecting pairs of nodes.
030 *
031 * <p>There are three primary interfaces provided to represent graphs. In order of increasing
032 * complexity they are: {@link Graph}, {@link ValueGraph}, and {@link Network}. You should generally
033 * prefer the simplest interface that satisfies your use case. See the <a
034 * href="https://github.com/google/guava/wiki/GraphsExplained#choosing-the-right-graph-type">
035 * "Choosing the right graph type"</a> section of the Guava User Guide for more details.
036 *
037 * <h3>Capabilities</h3>
038 *
039 * <p>{@code ValueGraph} supports the following use cases (<a
040 * href="https://github.com/google/guava/wiki/GraphsExplained#definitions">definitions of
041 * terms</a>):
042 *
043 * <ul>
044 *   <li>directed graphs
045 *   <li>undirected graphs
046 *   <li>graphs that do/don't allow self-loops
047 *   <li>graphs whose nodes/edges are insertion-ordered, sorted, or unordered
048 *   <li>graphs whose edges have associated values
049 * </ul>
050 *
051 * <p>{@code ValueGraph}, as a subtype of {@code Graph}, explicitly does not support parallel edges,
052 * and forbids implementations or extensions with parallel edges. If you need parallel edges, use
053 * {@link Network}. (You can use a positive {@code Integer} edge value as a loose representation of
054 * edge multiplicity, but the {@code *degree()} and mutation methods will not reflect your
055 * interpretation of the edge value as its multiplicity.)
056 *
057 * <h3>Building a {@code ValueGraph}</h3>
058 *
059 * <p>The implementation classes that {@code common.graph} provides are not public, by design. To
060 * create an instance of one of the built-in implementations of {@code ValueGraph}, use the {@link
061 * ValueGraphBuilder} class:
062 *
063 * <pre>{@code
064 * MutableValueGraph<Integer, Double> graph = ValueGraphBuilder.directed().build();
065 * }</pre>
066 *
067 * <p>{@link ValueGraphBuilder#build()} returns an instance of {@link MutableValueGraph}, which is a
068 * subtype of {@code ValueGraph} that provides methods for adding and removing nodes and edges. If
069 * you do not need to mutate a graph (e.g. if you write a method than runs a read-only algorithm on
070 * the graph), you should use the non-mutating {@link ValueGraph} interface, or an {@link
071 * ImmutableValueGraph}.
072 *
073 * <p>You can create an immutable copy of an existing {@code ValueGraph} using {@link
074 * ImmutableValueGraph#copyOf(ValueGraph)}:
075 *
076 * <pre>{@code
077 * ImmutableValueGraph<Integer, Double> immutableGraph = ImmutableValueGraph.copyOf(graph);
078 * }</pre>
079 *
080 * <p>Instances of {@link ImmutableValueGraph} do not implement {@link MutableValueGraph}
081 * (obviously!) and are contractually guaranteed to be unmodifiable and thread-safe.
082 *
083 * <p>The Guava User Guide has <a
084 * href="https://github.com/google/guava/wiki/GraphsExplained#building-graph-instances">more
085 * information on (and examples of) building graphs</a>.
086 *
087 * <h3>Additional documentation</h3>
088 *
089 * <p>See the Guava User Guide for the {@code common.graph} package (<a
090 * href="https://github.com/google/guava/wiki/GraphsExplained">"Graphs Explained"</a>) for
091 * additional documentation, including:
092 *
093 * <ul>
094 *   <li><a
095 *       href="https://github.com/google/guava/wiki/GraphsExplained#equals-hashcode-and-graph-equivalence">
096 *       {@code equals()}, {@code hashCode()}, and graph equivalence</a>
097 *   <li><a href="https://github.com/google/guava/wiki/GraphsExplained#synchronization">
098 *       Synchronization policy</a>
099 *   <li><a href="https://github.com/google/guava/wiki/GraphsExplained#notes-for-implementors">Notes
100 *       for implementors</a>
101 * </ul>
102 *
103 * @author James Sexton
104 * @author Joshua O'Madadhain
105 * @param <N> Node parameter type
106 * @param <V> Value parameter type
107 * @since 20.0
108 */
109@Beta
110public interface ValueGraph<N, V> extends BaseGraph<N> {
111  //
112  // ValueGraph-level accessors
113  //
114
115  /** Returns all nodes in this graph, in the order specified by {@link #nodeOrder()}. */
116  @Override
117  Set<N> nodes();
118
119  /** Returns all edges in this graph. */
120  @Override
121  Set<EndpointPair<N>> edges();
122
123  /**
124   * Returns a live view of this graph as a {@link Graph}. The resulting {@link Graph} will have an
125   * edge connecting node A to node B if this {@link ValueGraph} has an edge connecting A to B.
126   */
127  Graph<N> asGraph();
128
129  //
130  // ValueGraph properties
131  //
132
133  /**
134   * Returns true if the edges in this graph are directed. Directed edges connect a {@link
135   * EndpointPair#source() source node} to a {@link EndpointPair#target() target node}, while
136   * undirected edges connect a pair of nodes to each other.
137   */
138  @Override
139  boolean isDirected();
140
141  /**
142   * Returns true if this graph allows self-loops (edges that connect a node to itself). Attempting
143   * to add a self-loop to a graph that does not allow them will throw an {@link
144   * IllegalArgumentException}.
145   */
146  @Override
147  boolean allowsSelfLoops();
148
149  /** Returns the order of iteration for the elements of {@link #nodes()}. */
150  @Override
151  ElementOrder<N> nodeOrder();
152
153  /**
154   * Returns an {@link ElementOrder} that specifies the order of iteration for the elements of
155   * {@link #edges()}, {@link #adjacentNodes(Object)}, {@link #predecessors(Object)}, {@link
156   * #successors(Object)} and {@link #incidentEdges(Object)}.
157   *
158   * @since 29.0
159   */
160  @Override
161  ElementOrder<N> incidentEdgeOrder();
162
163  //
164  // Element-level accessors
165  //
166
167  /**
168   * Returns the nodes which have an incident edge in common with {@code node} in this graph.
169   *
170   * <p>This is equal to the union of {@link #predecessors(Object)} and {@link #successors(Object)}.
171   *
172   * @throws IllegalArgumentException if {@code node} is not an element of this graph
173   */
174  @Override
175  Set<N> adjacentNodes(N node);
176
177  /**
178   * Returns all nodes in this graph adjacent to {@code node} which can be reached by traversing
179   * {@code node}'s incoming edges <i>against</i> the direction (if any) of the edge.
180   *
181   * <p>In an undirected graph, this is equivalent to {@link #adjacentNodes(Object)}.
182   *
183   * @throws IllegalArgumentException if {@code node} is not an element of this graph
184   */
185  @Override
186  Set<N> predecessors(N node);
187
188  /**
189   * Returns all nodes in this graph adjacent to {@code node} which can be reached by traversing
190   * {@code node}'s outgoing edges in the direction (if any) of the edge.
191   *
192   * <p>In an undirected graph, this is equivalent to {@link #adjacentNodes(Object)}.
193   *
194   * <p>This is <i>not</i> the same as "all nodes reachable from {@code node} by following outgoing
195   * edges". For that functionality, see {@link Graphs#reachableNodes(Graph, Object)}.
196   *
197   * @throws IllegalArgumentException if {@code node} is not an element of this graph
198   */
199  @Override
200  Set<N> successors(N node);
201
202  /**
203   * Returns the edges in this graph whose endpoints include {@code node}.
204   *
205   * <p>This is equal to the union of incoming and outgoing edges.
206   *
207   * @throws IllegalArgumentException if {@code node} is not an element of this graph
208   * @since 24.0
209   */
210  @Override
211  Set<EndpointPair<N>> incidentEdges(N node);
212
213  /**
214   * Returns the count of {@code node}'s incident edges, counting self-loops twice (equivalently,
215   * the number of times an edge touches {@code node}).
216   *
217   * <p>For directed graphs, this is equal to {@code inDegree(node) + outDegree(node)}.
218   *
219   * <p>For undirected graphs, this is equal to {@code incidentEdges(node).size()} + (number of
220   * self-loops incident to {@code node}).
221   *
222   * <p>If the count is greater than {@code Integer.MAX_VALUE}, returns {@code Integer.MAX_VALUE}.
223   *
224   * @throws IllegalArgumentException if {@code node} is not an element of this graph
225   */
226  @Override
227  int degree(N node);
228
229  /**
230   * Returns the count of {@code node}'s incoming edges (equal to {@code predecessors(node).size()})
231   * in a directed graph. In an undirected graph, returns the {@link #degree(Object)}.
232   *
233   * <p>If the count is greater than {@code Integer.MAX_VALUE}, returns {@code Integer.MAX_VALUE}.
234   *
235   * @throws IllegalArgumentException if {@code node} is not an element of this graph
236   */
237  @Override
238  int inDegree(N node);
239
240  /**
241   * Returns the count of {@code node}'s outgoing edges (equal to {@code successors(node).size()})
242   * in a directed graph. In an undirected graph, returns the {@link #degree(Object)}.
243   *
244   * <p>If the count is greater than {@code Integer.MAX_VALUE}, returns {@code Integer.MAX_VALUE}.
245   *
246   * @throws IllegalArgumentException if {@code node} is not an element of this graph
247   */
248  @Override
249  int outDegree(N node);
250
251  /**
252   * Returns true if there is an edge that directly connects {@code nodeU} to {@code nodeV}. This is
253   * equivalent to {@code nodes().contains(nodeU) && successors(nodeU).contains(nodeV)}.
254   *
255   * <p>In an undirected graph, this is equal to {@code hasEdgeConnecting(nodeV, nodeU)}.
256   *
257   * @since 23.0
258   */
259  @Override
260  boolean hasEdgeConnecting(N nodeU, N nodeV);
261
262  /**
263   * Returns true if there is an edge that directly connects {@code endpoints} (in the order, if
264   * any, specified by {@code endpoints}). This is equivalent to {@code
265   * edges().contains(endpoints)}.
266   *
267   * <p>Unlike the other {@code EndpointPair}-accepting methods, this method does not throw if the
268   * endpoints are unordered and the graph is directed; it simply returns {@code false}. This is for
269   * consistency with the behavior of {@link Collection#contains(Object)} (which does not generally
270   * throw if the object cannot be present in the collection), and the desire to have this method's
271   * behavior be compatible with {@code edges().contains(endpoints)}.
272   *
273   * @since 27.1
274   */
275  @Override
276  boolean hasEdgeConnecting(EndpointPair<N> endpoints);
277
278  /**
279   * Returns the value of the edge that connects {@code nodeU} to {@code nodeV}, if one is present;
280   * otherwise, returns {@code defaultValue}.
281   *
282   * <p>In an undirected graph, this is equal to {@code edgeValueOrDefault(nodeV, nodeU,
283   * defaultValue)}.
284   *
285   * @throws IllegalArgumentException if {@code nodeU} or {@code nodeV} is not an element of this
286   *     graph
287   */
288  @NullableDecl
289  V edgeValueOrDefault(N nodeU, N nodeV, @NullableDecl V defaultValue);
290
291  /**
292   * Returns the value of the edge that connects {@code endpoints} (in the order, if any, specified
293   * by {@code endpoints}), if one is present; otherwise, returns {@code defaultValue}.
294   *
295   * <p>If this graph is directed, the endpoints must be ordered.
296   *
297   * @throws IllegalArgumentException if either endpoint is not an element of this graph
298   * @throws IllegalArgumentException if the endpoints are unordered and the graph is directed
299   * @since 27.1
300   */
301  @NullableDecl
302  V edgeValueOrDefault(EndpointPair<N> endpoints, @NullableDecl V defaultValue);
303
304  //
305  // ValueGraph identity
306  //
307
308  /**
309   * Returns {@code true} iff {@code object} is a {@link ValueGraph} that has the same elements and
310   * the same structural relationships as those in this graph.
311   *
312   * <p>Thus, two value graphs A and B are equal if <b>all</b> of the following are true:
313   *
314   * <ul>
315   *   <li>A and B have equal {@link #isDirected() directedness}.
316   *   <li>A and B have equal {@link #nodes() node sets}.
317   *   <li>A and B have equal {@link #edges() edge sets}.
318   *   <li>The {@link #edgeValue(Object, Object) value} of a given edge is the same in both A and B.
319   * </ul>
320   *
321   * <p>Graph properties besides {@link #isDirected() directedness} do <b>not</b> affect equality.
322   * For example, two graphs may be considered equal even if one allows self-loops and the other
323   * doesn't. Additionally, the order in which nodes or edges are added to the graph, and the order
324   * in which they are iterated over, are irrelevant.
325   *
326   * <p>A reference implementation of this is provided by {@link AbstractValueGraph#equals(Object)}.
327   */
328  @Override
329  boolean equals(@NullableDecl Object object);
330
331  /**
332   * Returns the hash code for this graph. The hash code of a graph is defined as the hash code of a
333   * map from each of its {@link #edges() edges} to the associated {@link #edgeValue(Object, Object)
334   * edge value}.
335   *
336   * <p>A reference implementation of this is provided by {@link AbstractValueGraph#hashCode()}.
337   */
338  @Override
339  int hashCode();
340}