Files
upo-graphs/doc/berack96/lib/graph/visit/VisitStrategy.html
Giacomo Bertolazzi ddc81330ab dsadasdasd
* added a method where you can get all the marks
* implemented and tested
* moved main
* changed README
* builded JavaDoc
* builded jar
2019-06-21 23:50:34 +02:00

268 lines
13 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:55 CEST 2019 -->
<title>VisitStrategy</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="VisitStrategy";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/VisitStrategy.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/VisitSCC.html" title="interface in berack96.lib.graph.visit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../berack96/lib/graph/visit/VisitTopological.html" title="interface in berack96.lib.graph.visit"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?berack96/lib/graph/visit/VisitStrategy.html" target="_top">Frames</a></li>
<li><a href="VisitStrategy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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</div>
<h2 title="Interface VisitStrategy" class="title">Interface VisitStrategy&lt;V,W extends java.lang.Number&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - The Object that represent a vertex</dd>
<dd><code>W</code> - The Object that represent the edge (more specifically the weight of the edge)</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../berack96/lib/graph/visit/VisitDistance.html" title="interface in berack96.lib.graph.visit">VisitDistance</a>&lt;V,W&gt;, <a href="../../../../berack96/lib/graph/visit/VisitDistSourceDest.html" title="interface in berack96.lib.graph.visit">VisitDistSourceDest</a>&lt;V,W&gt;, <a href="../../../../berack96/lib/graph/visit/VisitSCC.html" title="interface in berack96.lib.graph.visit">VisitSCC</a>&lt;V,W&gt;, <a href="../../../../berack96/lib/graph/visit/VisitTopological.html" title="interface in berack96.lib.graph.visit">VisitTopological</a>&lt;V,W&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../berack96/lib/graph/visit/impl/BFS.html" title="class in berack96.lib.graph.visit.impl">BFS</a>, <a href="../../../../berack96/lib/graph/visit/impl/DFS.html" title="class in berack96.lib.graph.visit.impl">DFS</a>, <a href="../../../../berack96/lib/graph/visit/impl/Dijkstra.html" title="class in berack96.lib.graph.visit.impl">Dijkstra</a>, <a href="../../../../berack96/lib/graph/visit/impl/Tarjan.html" title="class in berack96.lib.graph.visit.impl">Tarjan</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">VisitStrategy&lt;V,W extends java.lang.Number&gt;</span></pre>
<div class="block">This class is used for define some strategy for the visit of a graph.</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">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../../berack96/lib/graph/visit/impl/VisitInfo.html" title="class in berack96.lib.graph.visit.impl">VisitInfo</a>&lt;<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">V</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../berack96/lib/graph/visit/VisitStrategy.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>&lt;<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">V</a>,<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">W</a>&gt;&nbsp;graph,
<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">V</a>&nbsp;source,
java.util.function.Consumer&lt;<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">V</a>&gt;&nbsp;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>
</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="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><a href="../../../../berack96/lib/graph/visit/impl/VisitInfo.html" title="class in berack96.lib.graph.visit.impl">VisitInfo</a>&lt;<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">V</a>&gt;&nbsp;visit(<a href="../../../../berack96/lib/graph/Graph.html" title="interface in berack96.lib.graph">Graph</a>&lt;<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">V</a>,<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">W</a>&gt;&nbsp;graph,
<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">V</a>&nbsp;source,
java.util.function.Consumer&lt;<a href="../../../../berack96/lib/graph/visit/VisitStrategy.html" title="type parameter in VisitStrategy">V</a>&gt;&nbsp;visit)
throws java.lang.NullPointerException,
java.lang.IllegalArgumentException,
java.lang.UnsupportedOperationException</pre>
<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="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>
<dd><code>java.lang.UnsupportedOperationException</code> - in the case that the visit algorithm cannot be applied to 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/VisitStrategy.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/VisitSCC.html" title="interface in berack96.lib.graph.visit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../berack96/lib/graph/visit/VisitTopological.html" title="interface in berack96.lib.graph.visit"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?berack96/lib/graph/visit/VisitStrategy.html" target="_top">Frames</a></li>
<li><a href="VisitStrategy.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>