* added a method where you can get all the marks * implemented and tested * moved main * changed README * builded JavaDoc * builded jar
370 lines
19 KiB
HTML
370 lines
19 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 (1.8.0_144) on Fri Jun 21 23:35:56 CEST 2019 -->
|
|
<title>Dijkstra</title>
|
|
<meta name="date" content="2019-06-21">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Dijkstra";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<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/Dijkstra.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../../berack96/lib/graph/visit/impl/DFS.html" title="class in berack96.lib.graph.visit.impl"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../../berack96/lib/graph/visit/impl/Tarjan.html" title="class in berack96.lib.graph.visit.impl"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?berack96/lib/graph/visit/impl/Dijkstra.html" target="_top">Frames</a></li>
|
|
<li><a href="Dijkstra.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><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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">berack96.lib.graph.visit.impl</div>
|
|
<h2 title="Class Dijkstra" class="title">Class Dijkstra<V,W extends java.lang.Number></h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>berack96.lib.graph.visit.impl.Dijkstra<V,W></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt><span class="paramLabel">Type Parameters:</span></dt>
|
|
<dd><code>V</code> - vertex</dd>
|
|
<dd><code>W</code> - weight</dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="../../../../../berack96/lib/graph/visit/VisitDistance.html" title="interface in berack96.lib.graph.visit">VisitDistance</a><V,W>, <a href="../../../../../berack96/lib/graph/visit/VisitStrategy.html" title="interface in berack96.lib.graph.visit">VisitStrategy</a><V,W></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="typeNameLabel">Dijkstra<V,W extends java.lang.Number></span>
|
|
extends java.lang.Object
|
|
implements <a href="../../../../../berack96/lib/graph/visit/VisitDistance.html" title="interface in berack96.lib.graph.visit">VisitDistance</a><V,W></pre>
|
|
<div class="block">Class that implements the Dijkstra algorithm and uses it for getting all the distance from a source</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
|
<dd>Berack96</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html#Dijkstra--">Dijkstra</a></span>()</code> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>java.util.Map<<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>,java.util.List<<a href="../../../../../berack96/lib/graph/Edge.html" title="class in berack96.lib.graph">Edge</a><<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>,<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">W</a>>>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html#getLastDistance--">getLastDistance</a></span>()</code>
|
|
<div class="block">Get the last calculated distance to all the possible destinations<br>
|
|
The map contains all the possible vertices that are reachable from the source set in the visit<br>
|
|
If there is no path between the destination and the source, then null is returned as accordingly to the map interface<br>
|
|
If the visit is not already been done, then the map is null.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html#getLastSource--">getLastSource</a></span>()</code>
|
|
<div class="block">Get the last source vertex of the visit for calculating the destinations.<br>
|
|
Returns null if the visit is not already been done</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="../../../../../berack96/lib/graph/visit/impl/VisitInfo.html" title="class in berack96.lib.graph.visit.impl">VisitInfo</a><<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html#visit-berack96.lib.graph.Graph-V-java.util.function.Consumer-">visit</a></span>(<a href="../../../../../berack96/lib/graph/Graph.html" title="interface in berack96.lib.graph">Graph</a><<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>,<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">W</a>> graph,
|
|
<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a> source,
|
|
java.util.function.Consumer<<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>> visit)</code>
|
|
<div class="block">With this the graph will be visited accordingly to the strategy of the visit.<br>
|
|
Some strategy can accept a source vertex null, because they visit all the graph anyway.<br>
|
|
If you want to stop the visit of the graph, you just have to throw any exception in the visit function, but be sure to catch it</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="Dijkstra--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>Dijkstra</h4>
|
|
<pre>public Dijkstra()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getLastDistance--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLastDistance</h4>
|
|
<pre>public java.util.Map<<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>,java.util.List<<a href="../../../../../berack96/lib/graph/Edge.html" title="class in berack96.lib.graph">Edge</a><<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>,<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">W</a>>>> getLastDistance()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../berack96/lib/graph/visit/VisitDistance.html#getLastDistance--">VisitDistance</a></code></span></div>
|
|
<div class="block">Get the last calculated distance to all the possible destinations<br>
|
|
The map contains all the possible vertices that are reachable from the source set in the visit<br>
|
|
If there is no path between the destination and the source, then null is returned as accordingly to the map interface<br>
|
|
If the visit is not already been done, then the map is null.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../../berack96/lib/graph/visit/VisitDistance.html#getLastDistance--">getLastDistance</a></code> in interface <code><a href="../../../../../berack96/lib/graph/visit/VisitDistance.html" title="interface in berack96.lib.graph.visit">VisitDistance</a><<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>,<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">W</a> extends java.lang.Number></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the last distance</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLastSource--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLastSource</h4>
|
|
<pre>public <a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a> getLastSource()</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../berack96/lib/graph/visit/VisitDistance.html#getLastSource--">VisitDistance</a></code></span></div>
|
|
<div class="block">Get the last source vertex of the visit for calculating the destinations.<br>
|
|
Returns null if the visit is not already been done</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../../berack96/lib/graph/visit/VisitDistance.html#getLastSource--">getLastSource</a></code> in interface <code><a href="../../../../../berack96/lib/graph/visit/VisitDistance.html" title="interface in berack96.lib.graph.visit">VisitDistance</a><<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>,<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">W</a> extends java.lang.Number></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the last vertex</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="visit-berack96.lib.graph.Graph-java.lang.Object-java.util.function.Consumer-">
|
|
<!-- -->
|
|
</a><a name="visit-berack96.lib.graph.Graph-V-java.util.function.Consumer-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>visit</h4>
|
|
<pre>public <a href="../../../../../berack96/lib/graph/visit/impl/VisitInfo.html" title="class in berack96.lib.graph.visit.impl">VisitInfo</a><<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>> visit(<a href="../../../../../berack96/lib/graph/Graph.html" title="interface in berack96.lib.graph">Graph</a><<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>,<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">W</a>> graph,
|
|
<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a> source,
|
|
java.util.function.Consumer<<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>> visit)
|
|
throws java.lang.NullPointerException,
|
|
java.lang.IllegalArgumentException</pre>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../berack96/lib/graph/visit/VisitStrategy.html#visit-berack96.lib.graph.Graph-V-java.util.function.Consumer-">VisitStrategy</a></code></span></div>
|
|
<div class="block">With this the graph will be visited accordingly to the strategy of the visit.<br>
|
|
Some strategy can accept a source vertex null, because they visit all the graph anyway.<br>
|
|
If you want to stop the visit of the graph, you just have to throw any exception in the visit function, but be sure to catch it</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="../../../../../berack96/lib/graph/visit/VisitStrategy.html#visit-berack96.lib.graph.Graph-V-java.util.function.Consumer-">visit</a></code> in interface <code><a href="../../../../../berack96/lib/graph/visit/VisitStrategy.html" title="interface in berack96.lib.graph.visit">VisitStrategy</a><<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">V</a>,<a href="../../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="type parameter in Dijkstra">W</a> extends java.lang.Number></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>graph</code> - the graph to visit</dd>
|
|
<dd><code>source</code> - the source of the visit</dd>
|
|
<dd><code>visit</code> - the function to apply at each vertex when they are visited</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an info of the view</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if one of the arguments is null (only the consumers can be null)</dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if the source vertex is not in the graph</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>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<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/Dijkstra.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../../berack96/lib/graph/visit/impl/DFS.html" title="class in berack96.lib.graph.visit.impl"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../../berack96/lib/graph/visit/impl/Tarjan.html" title="class in berack96.lib.graph.visit.impl"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?berack96/lib/graph/visit/impl/Dijkstra.html" target="_top">Frames</a></li>
|
|
<li><a href="Dijkstra.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><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|