Du kannst nicht mehr als 25 Themen auswählen
Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
815 Zeilen
50 KiB
HTML
815 Zeilen
50 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_79) on Sun Apr 03 00:28:29 PDT 2016 -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>Graph (JGraphT : a free Java graph library)</title>
|
|
<meta name="date" content="2016-04-03">
|
|
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Graph (JGraphT : a free Java graph library)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/Graph.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../index-all.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../org/jgrapht/EdgeFactory.html" title="interface in org.jgrapht"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../org/jgrapht/GraphHelper.html" title="class in org.jgrapht"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?org/jgrapht/Graph.html" target="_top">Frames</a></li>
|
|
<li><a href="Graph.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">org.jgrapht</div>
|
|
<h2 title="Interface Graph" class="title">Interface Graph<V,E></h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Known Subinterfaces:</dt>
|
|
<dd><a href="../../org/jgrapht/DirectedGraph.html" title="interface in org.jgrapht">DirectedGraph</a><V,E>, <a href="../../org/jgrapht/ListenableGraph.html" title="interface in org.jgrapht">ListenableGraph</a><V,E>, <a href="../../org/jgrapht/UndirectedGraph.html" title="interface in org.jgrapht">UndirectedGraph</a><V,E>, <a href="../../org/jgrapht/WeightedGraph.html" title="interface in org.jgrapht">WeightedGraph</a><V,E></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><a href="../../org/jgrapht/graph/AbstractBaseGraph.html" title="class in org.jgrapht.graph">AbstractBaseGraph</a>, <a href="../../org/jgrapht/graph/AbstractGraph.html" title="class in org.jgrapht.graph">AbstractGraph</a>, <a href="../../org/jgrapht/graph/AsUndirectedGraph.html" title="class in org.jgrapht.graph">AsUndirectedGraph</a>, <a href="../../org/jgrapht/graph/AsUnweightedDirectedGraph.html" title="class in org.jgrapht.graph">AsUnweightedDirectedGraph</a>, <a href="../../org/jgrapht/graph/AsUnweightedGraph.html" title="class in org.jgrapht.graph">AsUnweightedGraph</a>, <a href="../../org/jgrapht/graph/AsWeightedDirectedGraph.html" title="class in org.jgrapht.graph">AsWeightedDirectedGraph</a>, <a href="../../org/jgrapht/graph/AsWeightedGraph.html" title="class in org.jgrapht.graph">AsWeightedGraph</a>, <a href="../../org/jgrapht/alg/BlockCutpointGraph.html" title="class in org.jgrapht.alg">BlockCutpointGraph</a>, <a href="../../org/jgrapht/graph/DefaultDirectedGraph.html" title="class in org.jgrapht.graph">DefaultDirectedGraph</a>, <a href="../../org/jgrapht/graph/DefaultDirectedWeightedGraph.html" title="class in org.jgrapht.graph">DefaultDirectedWeightedGraph</a>, <a href="../../org/jgrapht/graph/DefaultListenableGraph.html" title="class in org.jgrapht.graph">DefaultListenableGraph</a>, <a href="../../org/jgrapht/experimental/dag/DirectedAcyclicGraph.html" title="class in org.jgrapht.experimental.dag">DirectedAcyclicGraph</a>, <a href="../../org/jgrapht/graph/DirectedGraphUnion.html" title="class in org.jgrapht.graph">DirectedGraphUnion</a>, <a href="../../org/jgrapht/graph/DirectedMaskSubgraph.html" title="class in org.jgrapht.graph">DirectedMaskSubgraph</a>, <a href="../../org/jgrapht/graph/DirectedMultigraph.html" title="class in org.jgrapht.graph">DirectedMultigraph</a>, <a href="../../org/jgrapht/graph/DirectedPseudograph.html" title="class in org.jgrapht.graph">DirectedPseudograph</a>, <a href="../../org/jgrapht/graph/DirectedSubgraph.html" title="class in org.jgrapht.graph">DirectedSubgraph</a>, <a href="../../org/jgrapht/graph/DirectedWeightedMultigraph.html" title="class in org.jgrapht.graph">DirectedWeightedMultigraph</a>, <a href="../../org/jgrapht/graph/DirectedWeightedPseudograph.html" title="class in org.jgrapht.graph">DirectedWeightedPseudograph</a>, <a href="../../org/jgrapht/graph/DirectedWeightedSubgraph.html" title="class in org.jgrapht.graph">DirectedWeightedSubgraph</a>, <a href="../../org/jgrapht/graph/EdgeReversedGraph.html" title="class in org.jgrapht.graph">EdgeReversedGraph</a>, <a href="../../org/jgrapht/graph/GraphDelegator.html" title="class in org.jgrapht.graph">GraphDelegator</a>, <a href="../../org/jgrapht/experimental/GraphSquare.html" title="class in org.jgrapht.experimental">GraphSquare</a>, <a href="../../org/jgrapht/graph/GraphUnion.html" title="class in org.jgrapht.graph">GraphUnion</a>, <a href="../../org/jgrapht/graph/ListenableDirectedGraph.html" title="class in org.jgrapht.graph">ListenableDirectedGraph</a>, <a href="../../org/jgrapht/graph/ListenableDirectedWeightedGraph.html" title="class in org.jgrapht.graph">ListenableDirectedWeightedGraph</a>, <a href="../../org/jgrapht/graph/ListenableUndirectedGraph.html" title="class in org.jgrapht.graph">ListenableUndirectedGraph</a>, <a href="../../org/jgrapht/graph/ListenableUndirectedWeightedGraph.html" title="class in org.jgrapht.graph">ListenableUndirectedWeightedGraph</a>, <a href="../../org/jgrapht/graph/MaskSubgraph.html" title="class in org.jgrapht.graph">MaskSubgraph</a>, <a href="../../org/jgrapht/graph/MixedGraphUnion.html" title="class in org.jgrapht.graph">MixedGraphUnion</a>, <a href="../../org/jgrapht/graph/Multigraph.html" title="class in org.jgrapht.graph">Multigraph</a>, <a href="../../org/jgrapht/graph/ParanoidGraph.html" title="class in org.jgrapht.graph">ParanoidGraph</a>, <a href="../../org/jgrapht/graph/Pseudograph.html" title="class in org.jgrapht.graph">Pseudograph</a>, <a href="../../org/jgrapht/graph/SimpleDirectedGraph.html" title="class in org.jgrapht.graph">SimpleDirectedGraph</a>, <a href="../../org/jgrapht/graph/SimpleDirectedWeightedGraph.html" title="class in org.jgrapht.graph">SimpleDirectedWeightedGraph</a>, <a href="../../org/jgrapht/graph/SimpleGraph.html" title="class in org.jgrapht.graph">SimpleGraph</a>, <a href="../../org/jgrapht/graph/SimpleWeightedGraph.html" title="class in org.jgrapht.graph">SimpleWeightedGraph</a>, <a href="../../org/jgrapht/graph/Subgraph.html" title="class in org.jgrapht.graph">Subgraph</a>, <a href="../../org/jgrapht/graph/UndirectedGraphUnion.html" title="class in org.jgrapht.graph">UndirectedGraphUnion</a>, <a href="../../org/jgrapht/graph/UndirectedMaskSubgraph.html" title="class in org.jgrapht.graph">UndirectedMaskSubgraph</a>, <a href="../../org/jgrapht/graph/UndirectedSubgraph.html" title="class in org.jgrapht.graph">UndirectedSubgraph</a>, <a href="../../org/jgrapht/graph/UndirectedWeightedSubgraph.html" title="class in org.jgrapht.graph">UndirectedWeightedSubgraph</a>, <a href="../../org/jgrapht/graph/UnmodifiableDirectedGraph.html" title="class in org.jgrapht.graph">UnmodifiableDirectedGraph</a>, <a href="../../org/jgrapht/graph/UnmodifiableGraph.html" title="class in org.jgrapht.graph">UnmodifiableGraph</a>, <a href="../../org/jgrapht/graph/UnmodifiableUndirectedGraph.html" title="class in org.jgrapht.graph">UnmodifiableUndirectedGraph</a>, <a href="../../org/jgrapht/graph/WeightedMultigraph.html" title="class in org.jgrapht.graph">WeightedMultigraph</a>, <a href="../../org/jgrapht/graph/WeightedPseudograph.html" title="class in org.jgrapht.graph">WeightedPseudograph</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="strong">Graph<V,E></span></pre>
|
|
<div class="block">The root interface in the graph hierarchy. A mathematical graph-theory graph
|
|
object <tt>G(V,E)</tt> contains a set <tt>V</tt> of vertices and a set <tt>
|
|
E</tt> of edges. Each edge e=(v1,v2) in E connects vertex v1 to vertex v2.
|
|
for more information about graphs and their related definitions see <a
|
|
href="http://mathworld.wolfram.com/Graph.html">
|
|
http://mathworld.wolfram.com/Graph.html</a>.
|
|
|
|
<p>This library generally follows the terminology found at: <a
|
|
href="http://mathworld.wolfram.com/topics/GraphTheory.html">
|
|
http://mathworld.wolfram.com/topics/GraphTheory.html</a>. Implementation of
|
|
this interface can provide simple-graphs, multigraphs, pseudographs etc. The
|
|
package <code>org.jgrapht.graph</code> provides a gallery of abstract and
|
|
concrete graph implementations.</p>
|
|
|
|
<p>This library works best when vertices represent arbitrary objects and
|
|
edges represent the relationships between them. Vertex and edge instances may
|
|
be shared by more than one graph.</p>
|
|
|
|
<p>Through generics, a graph can be typed to specific classes for vertices
|
|
<code>V</code> and edges <code>E<T></code>. Such a graph can contain
|
|
vertices of type <code>V</code> and all sub-types and Edges of type <code>
|
|
E</code> and all sub-types.</p>
|
|
|
|
<p>For guidelines on vertex and edge classes, see <a
|
|
href="https://github.com/jgrapht/jgrapht/wiki/EqualsAndHashCode">this wiki
|
|
page</a>.</div>
|
|
<dl><dt><span class="strong">Since:</span></dt>
|
|
<dd>Jul 14, 2003</dd>
|
|
<dt><span class="strong">Author:</span></dt>
|
|
<dd>Barak Naveh</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#addEdge(V,%20V)">addEdge</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</code>
|
|
<div class="block">Creates a new edge in this graph, going from the source vertex to the
|
|
target vertex, and returns the created edge.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#addEdge(V,%20V,%20E)">addEdge</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</code>
|
|
<div class="block">Adds the specified edge to this graph, going from the source vertex to
|
|
the target vertex.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#addVertex(V)">addVertex</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> v)</code>
|
|
<div class="block">Adds the specified vertex to this graph if not already present.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#containsEdge(E)">containsEdge</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</code>
|
|
<div class="block">Returns <tt>true</tt> if this graph contains the specified edge.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#containsEdge(V,%20V)">containsEdge</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</code>
|
|
<div class="block">Returns <tt>true</tt> if and only if this graph contains an edge going
|
|
from the source vertex to the target vertex.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#containsVertex(V)">containsVertex</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> v)</code>
|
|
<div class="block">Returns <tt>true</tt> if this graph contains the specified vertex.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#edgeSet()">edgeSet</a></strong>()</code>
|
|
<div class="block">Returns a set of the edges contained in this graph.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#edgesOf(V)">edgesOf</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> vertex)</code>
|
|
<div class="block">Returns a set of all edges touching the specified vertex.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#getAllEdges(V,%20V)">getAllEdges</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</code>
|
|
<div class="block">Returns a set of all edges connecting source vertex to target vertex if
|
|
such vertices exist in this graph.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#getEdge(V,%20V)">getEdge</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</code>
|
|
<div class="block">Returns an edge connecting source vertex to target vertex if such
|
|
vertices and such edge exist in this graph.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../org/jgrapht/EdgeFactory.html" title="interface in org.jgrapht">EdgeFactory</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a>,<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#getEdgeFactory()">getEdgeFactory</a></strong>()</code>
|
|
<div class="block">Returns the edge factory using which this graph creates new edges.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#getEdgeSource(E)">getEdgeSource</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</code>
|
|
<div class="block">Returns the source vertex of an edge.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#getEdgeTarget(E)">getEdgeTarget</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</code>
|
|
<div class="block">Returns the target vertex of an edge.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#getEdgeWeight(E)">getEdgeWeight</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</code>
|
|
<div class="block">Returns the weight assigned to a given edge.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#removeAllEdges(java.util.Collection)">removeAllEdges</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>> edges)</code>
|
|
<div class="block">Removes all the edges in this graph that are also contained in the
|
|
specified edge collection.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#removeAllEdges(V,%20V)">removeAllEdges</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</code>
|
|
<div class="block">Removes all the edges going from the specified source vertex to the
|
|
specified target vertex, and returns a set of all removed edges.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#removeAllVertices(java.util.Collection)">removeAllVertices</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a>> vertices)</code>
|
|
<div class="block">Removes all the vertices in this graph that are also contained in the
|
|
specified vertex collection.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#removeEdge(E)">removeEdge</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</code>
|
|
<div class="block">Removes the specified edge from the graph.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#removeEdge(V,%20V)">removeEdge</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</code>
|
|
<div class="block">Removes an edge going from source vertex to target vertex, if such
|
|
vertices and such edge exist in this graph.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#removeVertex(V)">removeVertex</a></strong>(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> v)</code>
|
|
<div class="block">Removes the specified vertex from this graph including all its touching
|
|
edges if present.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../org/jgrapht/Graph.html#vertexSet()">vertexSet</a></strong>()</code>
|
|
<div class="block">Returns a set of the vertices contained in this graph.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getAllEdges(java.lang.Object,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="getAllEdges(V, V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAllEdges</h4>
|
|
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>> getAllEdges(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</pre>
|
|
<div class="block">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 is <code>null</code>, returns <code>null</code>. If both vertices
|
|
exist but no edges found, returns an empty set.
|
|
|
|
<p>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.</p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceVertex</code> - source vertex of the edge.</dd><dd><code>targetVertex</code> - target vertex of the edge.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>a set of all edges connecting source vertex to target vertex.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getEdge(java.lang.Object,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="getEdge(V, V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getEdge</h4>
|
|
<pre><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> getEdge(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</pre>
|
|
<div class="block">Returns an edge connecting source vertex to target vertex if such
|
|
vertices and such edge exist in this graph. Otherwise returns <code>
|
|
null</code>. If any of the specified vertices is <code>null</code>
|
|
returns <code>null</code>
|
|
|
|
<p>In undirected graphs, the returned edge may have its source and target
|
|
vertices in the opposite order.</p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceVertex</code> - source vertex of the edge.</dd><dd><code>targetVertex</code> - target vertex of the edge.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>an edge connecting source vertex to target vertex.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getEdgeFactory()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getEdgeFactory</h4>
|
|
<pre><a href="../../org/jgrapht/EdgeFactory.html" title="interface in org.jgrapht">EdgeFactory</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a>,<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>> getEdgeFactory()</pre>
|
|
<div class="block">Returns the edge factory using which this graph creates new edges. The
|
|
edge factory is defined when the graph is constructed and must not be
|
|
modified.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the edge factory using which this graph creates new edges.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addEdge(java.lang.Object,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="addEdge(V, V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addEdge</h4>
|
|
<pre><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> addEdge(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</pre>
|
|
<div class="block">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
|
|
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 <code>null</code>.
|
|
|
|
<p>The source and target vertices must already be contained in this
|
|
graph. If they are not found in graph IllegalArgumentException is
|
|
thrown.</p>
|
|
|
|
<p>This method creates the new edge <code>e</code> using this graph's
|
|
<code>EdgeFactory</code>. For the new edge to be added <code>e</code>
|
|
must <i>not</i> be equal to any other edge the graph (even if the graph
|
|
allows edge-multiplicity). More formally, the graph must not contain any
|
|
edge <code>e2</code> such that <code>e2.equals(e)</code>. If such <code>
|
|
e2</code> is found then the newly created edge <code>e</code> is
|
|
abandoned, the method leaves this graph unchanged returns <code>
|
|
null</code>.</p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceVertex</code> - source vertex of the edge.</dd><dd><code>targetVertex</code> - target vertex of the edge.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The newly created edge if added to the graph, otherwise <code>
|
|
null</code>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if source or target vertices are not
|
|
found in the graph.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if any of the specified vertices is <code>
|
|
null</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../org/jgrapht/Graph.html#getEdgeFactory()"><code>getEdgeFactory()</code></a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addEdge(java.lang.Object,java.lang.Object,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="addEdge(V, V, E)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addEdge</h4>
|
|
<pre>boolean addEdge(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</pre>
|
|
<div class="block">Adds the specified edge to this graph, going from the source vertex to
|
|
the target vertex. More formally, adds the specified edge, <code>
|
|
e</code>, to this graph if this graph contains no edge <code>e2</code>
|
|
such that <code>e2.equals(e)</code>. If this graph already contains such
|
|
an edge, the call leaves this graph unchanged and returns <tt>false</tt>.
|
|
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 <code>
|
|
false</code>. If the edge was added to the graph, returns <code>
|
|
true</code>.
|
|
|
|
<p>The source and target vertices must already be contained in this
|
|
graph. If they are not found in graph IllegalArgumentException is
|
|
thrown.</p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceVertex</code> - source vertex of the edge.</dd><dd><code>targetVertex</code> - target vertex of the edge.</dd><dd><code>e</code> - edge to be added to this graph.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this graph did not already contain the specified
|
|
edge.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if source or target vertices are not
|
|
found in the graph.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</a></code> - if the specified edge is not assignment
|
|
compatible with the class of edges produced by the edge factory of this
|
|
graph.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if any of the specified vertices is <code>
|
|
null</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../org/jgrapht/Graph.html#addEdge(V,%20V)"><code>addEdge(Object, Object)</code></a>,
|
|
<a href="../../org/jgrapht/Graph.html#getEdgeFactory()"><code>getEdgeFactory()</code></a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addVertex(java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="addVertex(V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addVertex</h4>
|
|
<pre>boolean addVertex(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> v)</pre>
|
|
<div class="block">Adds the specified vertex to this graph if not already present. More
|
|
formally, adds the specified vertex, <code>v</code>, to this graph if
|
|
this graph contains no vertex <code>u</code> such that <code>
|
|
u.equals(v)</code>. If this graph already contains such vertex, the call
|
|
leaves this graph unchanged and returns <tt>false</tt>. In combination
|
|
with the restriction on constructors, this ensures that graphs never
|
|
contain duplicate vertices.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - vertex to be added to this graph.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this graph did not already contain the specified
|
|
vertex.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the specified vertex is <code>
|
|
null</code>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="containsEdge(java.lang.Object,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="containsEdge(V, V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>containsEdge</h4>
|
|
<pre>boolean containsEdge(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</pre>
|
|
<div class="block">Returns <tt>true</tt> 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 is <code>
|
|
null</code>, returns <code>false</code>.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceVertex</code> - source vertex of the edge.</dd><dd><code>targetVertex</code> - target vertex of the edge.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this graph contains the specified edge.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="containsEdge(java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="containsEdge(E)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>containsEdge</h4>
|
|
<pre>boolean containsEdge(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</pre>
|
|
<div class="block">Returns <tt>true</tt> if this graph contains the specified edge. More
|
|
formally, returns <tt>true</tt> if and only if this graph contains an
|
|
edge <code>e2</code> such that <code>e.equals(e2)</code>. If the
|
|
specified edge is <code>null</code> returns <code>false</code>.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - edge whose presence in this graph is to be tested.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this graph contains the specified edge.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="containsVertex(java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="containsVertex(V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>containsVertex</h4>
|
|
<pre>boolean containsVertex(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> v)</pre>
|
|
<div class="block">Returns <tt>true</tt> if this graph contains the specified vertex. More
|
|
formally, returns <tt>true</tt> if and only if this graph contains a
|
|
vertex <code>u</code> such that <code>u.equals(v)</code>. If the
|
|
specified vertex is <code>null</code> returns <code>false</code>.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - vertex whose presence in this graph is to be tested.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this graph contains the specified vertex.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="edgeSet()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>edgeSet</h4>
|
|
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>> edgeSet()</pre>
|
|
<div class="block">Returns a set of the edges 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.
|
|
|
|
<p>The graph implementation may maintain a particular set ordering (e.g.
|
|
via <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashSet.html?is-external=true" title="class or interface in java.util"><code>LinkedHashSet</code></a>) 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.</p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>a set of the edges contained in this graph.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="edgesOf(java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="edgesOf(V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>edgesOf</h4>
|
|
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>> edgesOf(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> vertex)</pre>
|
|
<div class="block">Returns a set of all edges touching the specified vertex. If no edges are
|
|
touching the specified vertex returns an empty set.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>vertex</code> - the vertex for which a set of touching edges is to be
|
|
returned.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>a set of all edges touching the specified vertex.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if vertex is not found in the graph.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if vertex is <code>null</code>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="removeAllEdges(java.util.Collection)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeAllEdges</h4>
|
|
<pre>boolean removeAllEdges(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>> edges)</pre>
|
|
<div class="block">Removes all the edges in this graph that are also contained in the
|
|
specified edge collection. After this call returns, this graph will
|
|
contain no edges in common with the specified edges. This method will
|
|
invoke the <a href="../../org/jgrapht/Graph.html#removeEdge(E)"><code>removeEdge(Object)</code></a> method.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>edges</code> - edges to be removed from this graph.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this graph changed as a result of the call</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the specified edge collection is <tt>
|
|
null</tt>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../org/jgrapht/Graph.html#removeEdge(E)"><code>removeEdge(Object)</code></a>,
|
|
<a href="../../org/jgrapht/Graph.html#containsEdge(E)"><code>containsEdge(Object)</code></a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="removeAllEdges(java.lang.Object,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="removeAllEdges(V, V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeAllEdges</h4>
|
|
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a>> removeAllEdges(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</pre>
|
|
<div class="block">Removes all the edges going from the specified source vertex to the
|
|
specified target vertex, and returns a set of all removed edges. Returns
|
|
<code>null</code> 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 <a href="../../org/jgrapht/Graph.html#removeEdge(E)"><code>removeEdge(Object)</code></a> method, or
|
|
the <a href="../../org/jgrapht/Graph.html#removeEdge(V,%20V)"><code>removeEdge(Object, Object)</code></a> method.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceVertex</code> - source vertex of the edge.</dd><dd><code>targetVertex</code> - target vertex of the edge.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>the removed edges, or <code>null</code> if either vertex is not
|
|
part of graph</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="removeAllVertices(java.util.Collection)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeAllVertices</h4>
|
|
<pre>boolean removeAllVertices(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><? extends <a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a>> vertices)</pre>
|
|
<div class="block">Removes all the vertices in this graph that are also contained in the
|
|
specified vertex collection. After this call returns, this graph will
|
|
contain no vertices in common with the specified vertices. This method
|
|
will invoke the <a href="../../org/jgrapht/Graph.html#removeVertex(V)"><code>removeVertex(Object)</code></a> method.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>vertices</code> - vertices to be removed from this graph.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><tt>true</tt> if this graph changed as a result of the call</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the specified vertex collection is <tt>
|
|
null</tt>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../org/jgrapht/Graph.html#removeVertex(V)"><code>removeVertex(Object)</code></a>,
|
|
<a href="../../org/jgrapht/Graph.html#containsVertex(V)"><code>containsVertex(Object)</code></a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="removeEdge(java.lang.Object,java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="removeEdge(V, V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeEdge</h4>
|
|
<pre><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> removeEdge(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> sourceVertex,
|
|
<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> targetVertex)</pre>
|
|
<div class="block">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
|
|
or <code>null</code> otherwise.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceVertex</code> - source vertex of the edge.</dd><dd><code>targetVertex</code> - target vertex of the edge.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>The removed edge, or <code>null</code> if no edge removed.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="removeEdge(java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="removeEdge(E)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeEdge</h4>
|
|
<pre>boolean removeEdge(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</pre>
|
|
<div class="block">Removes the specified edge from the graph. Removes the specified edge
|
|
from this graph if it is present. More formally, removes an edge <code>
|
|
e2</code> such that <code>e2.equals(e)</code>, if the graph contains such
|
|
edge. Returns <tt>true</tt> if the graph contained the specified edge.
|
|
(The graph will not contain the specified edge once the call returns).
|
|
|
|
<p>If the specified edge is <code>null</code> returns <code>
|
|
false</code>.</p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - edge to be removed from this graph, if present.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if and only if the graph contained the
|
|
specified edge.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="removeVertex(java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="removeVertex(V)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeVertex</h4>
|
|
<pre>boolean removeVertex(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> v)</pre>
|
|
<div class="block">Removes the specified vertex from this graph including all its touching
|
|
edges if present. More formally, if the graph contains a vertex <code>
|
|
u</code> such that <code>u.equals(v)</code>, the call removes all edges
|
|
that touch <code>u</code> and then removes <code>u</code> itself. If no
|
|
such <code>u</code> is found, the call leaves the graph unchanged.
|
|
Returns <tt>true</tt> if the graph contained the specified vertex. (The
|
|
graph will not contain the specified vertex once the call returns).
|
|
|
|
<p>If the specified vertex is <code>null</code> returns <code>
|
|
false</code>.</p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - vertex to be removed from this graph, if present.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the graph contained the specified vertex;
|
|
<code>false</code> otherwise.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="vertexSet()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>vertexSet</h4>
|
|
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a>> vertexSet()</pre>
|
|
<div class="block">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.
|
|
|
|
<p>The graph implementation may maintain a particular set ordering (e.g.
|
|
via <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashSet.html?is-external=true" title="class or interface in java.util"><code>LinkedHashSet</code></a>) 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.</p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>a set view of the vertices contained in this graph.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getEdgeSource(java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="getEdgeSource(E)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getEdgeSource</h4>
|
|
<pre><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> getEdgeSource(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</pre>
|
|
<div class="block">Returns the source vertex of an edge. For an undirected graph, source and
|
|
target are distinguishable designations (but without any mathematical
|
|
meaning).</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - edge of interest</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>source vertex</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getEdgeTarget(java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="getEdgeTarget(E)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getEdgeTarget</h4>
|
|
<pre><a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">V</a> getEdgeTarget(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</pre>
|
|
<div class="block">Returns the target vertex of an edge. For an undirected graph, source and
|
|
target are distinguishable designations (but without any mathematical
|
|
meaning).</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - edge of interest</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>target vertex</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getEdgeWeight(java.lang.Object)">
|
|
<!-- -->
|
|
</a><a name="getEdgeWeight(E)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getEdgeWeight</h4>
|
|
<pre>double getEdgeWeight(<a href="../../org/jgrapht/Graph.html" title="type parameter in Graph">E</a> e)</pre>
|
|
<div class="block">Returns the weight assigned to a given edge. Unweighted graphs return 1.0
|
|
(as defined by <a href="../../org/jgrapht/WeightedGraph.html#DEFAULT_EDGE_WEIGHT"><code>WeightedGraph.DEFAULT_EDGE_WEIGHT</code></a>), allowing
|
|
weighted-graph algorithms to apply to them where meaningful.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>e</code> - edge of interest</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>edge weight</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../org/jgrapht/WeightedGraph.html" title="interface in org.jgrapht"><code>WeightedGraph</code></a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/Graph.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../index-all.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../org/jgrapht/EdgeFactory.html" title="interface in org.jgrapht"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../org/jgrapht/GraphHelper.html" title="class in org.jgrapht"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?org/jgrapht/Graph.html" target="_top">Frames</a></li>
|
|
<li><a href="Graph.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small>Copyright © 2016. All rights reserved.</small></p>
|
|
</body>
|
|
</html>
|