278 lines
17 KiB
HTML
278 lines
17 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="de">
|
||
|
|
<head>
|
||
|
|
<!-- Generated by javadoc (21) on Tue Jul 09 12:47:01 CEST 2024 -->
|
||
|
|
<title>OurAlgorithm</title>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="dc.created" content="2024-07-09">
|
||
|
|
<meta name="description" content="declaration: package: OurApplication, class: OurAlgorithm">
|
||
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||
|
|
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
||
|
|
<script type="text/javascript" src="../script.js"></script>
|
||
|
|
<script type="text/javascript" src="../script-dir/jquery-3.6.1.min.js"></script>
|
||
|
|
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
||
|
|
</head>
|
||
|
|
<body class="class-declaration-page">
|
||
|
|
<script type="text/javascript">var pathtoroot = "../";
|
||
|
|
loadScripts(document, 'script');</script>
|
||
|
|
<noscript>
|
||
|
|
<div>JavaScript ist im Browser deaktiviert.</div>
|
||
|
|
</noscript>
|
||
|
|
<div class="flex-box">
|
||
|
|
<header role="banner" class="flex-header">
|
||
|
|
<nav role="navigation">
|
||
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
|
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Navigationslinks umschalten"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button>
|
||
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Navigations-Links überspringen">Navigations-Links überspringen</a></div>
|
||
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||
|
|
<li><a href="../index.html">Überblick</a></li>
|
||
|
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
|
<li class="nav-bar-cell1-rev">Klasse</li>
|
||
|
|
<li><a href="package-tree.html">Baum</a></li>
|
||
|
|
<li><a href="../index-files/index-1.html">Index</a></li>
|
||
|
|
<li><a href="../help-doc.html#class">Hilfe</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="sub-nav-list-small">
|
||
|
|
<li>
|
||
|
|
<p>Übersicht:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Verschachtelt</li>
|
||
|
|
<li><a href="#field-summary">Feld</a></li>
|
||
|
|
<li><a href="#constructor-summary">Konstruktor</a></li>
|
||
|
|
<li><a href="#method-summary">Methode</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>Details:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="#field-detail">Feld</a></li>
|
||
|
|
<li><a href="#constructor-detail">Konstruktor</a></li>
|
||
|
|
<li><a href="#method-detail">Methode</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="sub-nav">
|
||
|
|
<div id="navbar-sub-list">
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Übersicht: </li>
|
||
|
|
<li>Verschachtelt | </li>
|
||
|
|
<li><a href="#field-summary">Feld</a> | </li>
|
||
|
|
<li><a href="#constructor-summary">Konstruktor</a> | </li>
|
||
|
|
<li><a href="#method-summary">Methode</a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="sub-nav-list">
|
||
|
|
<li>Details: </li>
|
||
|
|
<li><a href="#field-detail">Feld</a> | </li>
|
||
|
|
<li><a href="#constructor-detail">Konstruktor</a> | </li>
|
||
|
|
<li><a href="#method-detail">Methode</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="nav-list-search"><a href="../search.html">SEARCH</a>
|
||
|
|
<input type="text" id="search-input" disabled placeholder="Suchen">
|
||
|
|
<input type="reset" id="reset-button" disabled value="reset">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||
|
|
</header>
|
||
|
|
<div class="flex-content">
|
||
|
|
<main role="main">
|
||
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">OurApplication</a></div>
|
||
|
|
<h1 title="Klasse OurAlgorithm" class="title">Klasse OurAlgorithm</h1>
|
||
|
|
</div>
|
||
|
|
<div class="inheritance" title="Vererbungsbaum"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">java.lang.Object</a>
|
||
|
|
<div class="inheritance"><a href="../logging/Algorithm.html" title="Klasse in logging">logging.Algorithm</a>
|
||
|
|
<div class="inheritance">OurApplication.OurAlgorithm</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<section class="class-description" id="class-description">
|
||
|
|
<hr>
|
||
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">OurAlgorithm</span>
|
||
|
|
<span class="extends-implements">extends <a href="../logging/Algorithm.html" title="Klasse in logging">Algorithm</a></span></div>
|
||
|
|
<div class="block">This class provides an example of using logging.Algorithm.
|
||
|
|
It implements a summation algorithm that computes the sum of integers starting from 0 up to a specified maximum value from the parameter area.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Siehe auch:</dt>
|
||
|
|
<dd>
|
||
|
|
<ul class="tag-list">
|
||
|
|
<li><a href="../logging/Algorithm.html" title="Klasse in logging"><code>Algorithm</code></a></li>
|
||
|
|
</ul>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
<section class="summary">
|
||
|
|
<ul class="summary-list">
|
||
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
|
<li>
|
||
|
|
<section class="field-summary" id="field-summary">
|
||
|
|
<h2>Feldübersicht</h2>
|
||
|
|
<div class="caption"><span>Felder</span></div>
|
||
|
|
<div class="summary-table three-column-summary">
|
||
|
|
<div class="table-header col-first">Modifizierer und Typ</div>
|
||
|
|
<div class="table-header col-second">Feld</div>
|
||
|
|
<div class="table-header col-last">Beschreibung</div>
|
||
|
|
<div class="col-first even-row-color"><code>private <a href="../graph/Graph.html" title="Klasse in graph">Graph</a><wbr><<a href="../graph/VertexMarking.html" title="Klasse in graph">VertexMarking</a>,<wbr><a href="../graph/EdgeMarking.html" title="Klasse in graph">EdgeMarking</a>></code></div>
|
||
|
|
<div class="col-second even-row-color"><code><a href="#currentGraph" class="member-name-link">currentGraph</a></code></div>
|
||
|
|
<div class="col-last even-row-color"> </div>
|
||
|
|
<div class="col-first odd-row-color"><code>private <a href="OurMethodButtons.html" title="Klasse in OurApplication">OurMethodButtons</a></code></div>
|
||
|
|
<div class="col-second odd-row-color"><code><a href="#methodButtons" class="member-name-link">methodButtons</a></code></div>
|
||
|
|
<div class="col-last odd-row-color"> </div>
|
||
|
|
</div>
|
||
|
|
<div class="inherited-list">
|
||
|
|
<h3 id="fields-inherited-from-class-logging.Algorithm">Von Klasse geerbte Felder logging.<a href="../logging/Algorithm.html" title="Klasse in logging">Algorithm</a></h3>
|
||
|
|
<code><a href="../logging/Algorithm.html#parameterArea">parameterArea</a>, <a href="../logging/Algorithm.html#title">title</a></code></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
|
<li>
|
||
|
|
<section class="constructor-summary" id="constructor-summary">
|
||
|
|
<h2>Konstruktorübersicht</h2>
|
||
|
|
<div class="caption"><span>Konstruktoren</span></div>
|
||
|
|
<div class="summary-table two-column-summary">
|
||
|
|
<div class="table-header col-first">Konstruktor</div>
|
||
|
|
<div class="table-header col-last">Beschreibung</div>
|
||
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">OurAlgorithm</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color">
|
||
|
|
<div class="block">Standard constructor.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(OurApplication.OurParameterArea,OurApplication.OurMethodButtons)" class="member-name-link">OurAlgorithm</a><wbr>(<a href="OurParameterArea.html" title="Klasse in OurApplication">OurParameterArea</a> parameterArea,
|
||
|
|
<a href="OurMethodButtons.html" title="Klasse in OurApplication">OurMethodButtons</a> methodButtons)</code></div>
|
||
|
|
<div class="col-last odd-row-color">
|
||
|
|
<div class="block">Constructs a summation algorithm with parameters from the parameter area.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
|
<li>
|
||
|
|
<section class="method-summary" id="method-summary">
|
||
|
|
<h2>Methodenübersicht</h2>
|
||
|
|
<div id="method-summary-table">
|
||
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">Alle Methoden</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instanzmethoden</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Konkrete Methoden</button></div>
|
||
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||
|
|
<div class="table-header col-first">Modifizierer und Typ</div>
|
||
|
|
<div class="table-header col-second">Methode</div>
|
||
|
|
<div class="table-header col-last">Beschreibung</div>
|
||
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../logging/LogElementList.html" title="Klasse in logging">LogElementList</a><wbr><<a href="OurLogElement.html" title="Klasse in OurApplication">OurLogElement</a>></code></div>
|
||
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#run()" class="member-name-link">run</a>()</code></div>
|
||
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Overridden method from the superclass.</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentGraph(graph.Graph)" class="member-name-link">setCurrentGraph</a><wbr>(<a href="../graph/Graph.html" title="Klasse in graph">Graph</a><<a href="../graph/VertexMarking.html" title="Klasse in graph">VertexMarking</a>,<wbr><a href="../graph/EdgeMarking.html" title="Klasse in graph">EdgeMarking</a>> graph)</code></div>
|
||
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||
|
|
<div class="block">Sets the current graph for the algorithm.</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="inherited-list">
|
||
|
|
<h3 id="methods-inherited-from-class-logging.Algorithm">Von Klasse geerbte Methoden logging.<a href="../logging/Algorithm.html" title="Klasse in logging">Algorithm</a></h3>
|
||
|
|
<code><a href="../logging/Algorithm.html#getParameterArea()">getParameterArea</a>, <a href="../logging/Algorithm.html#getTitle()">getTitle</a>, <a href="../logging/Algorithm.html#setParameterArea(PARAM)">setParameterArea</a>, <a href="../logging/Algorithm.html#setTitle(java.lang.String)">setTitle</a></code></div>
|
||
|
|
<div class="inherited-list">
|
||
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Von Klasse geerbte Methoden java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">Object</a></h3>
|
||
|
|
<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="Klasse oder Schnittstelle in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="Klasse oder Schnittstelle in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="Klasse oder Schnittstelle in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="Klasse oder Schnittstelle in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="Klasse oder Schnittstelle in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="Klasse oder Schnittstelle in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="Klasse oder Schnittstelle in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="Klasse oder Schnittstelle in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="Klasse oder Schnittstelle in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="Klasse oder Schnittstelle in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="Klasse oder Schnittstelle in java.lang" class="external-link">wait</a></code></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="details">
|
||
|
|
<ul class="details-list">
|
||
|
|
<!-- ============ FIELD DETAIL =========== -->
|
||
|
|
<li>
|
||
|
|
<section class="field-details" id="field-detail">
|
||
|
|
<h2>Felddetails</h2>
|
||
|
|
<ul class="member-list">
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="currentGraph">
|
||
|
|
<h3>currentGraph</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../graph/Graph.html" title="Klasse in graph">Graph</a><<a href="../graph/VertexMarking.html" title="Klasse in graph">VertexMarking</a>,<wbr><a href="../graph/EdgeMarking.html" title="Klasse in graph">EdgeMarking</a>></span> <span class="element-name">currentGraph</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="methodButtons">
|
||
|
|
<h3>methodButtons</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="OurMethodButtons.html" title="Klasse in OurApplication">OurMethodButtons</a></span> <span class="element-name">methodButtons</span></div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
|
<li>
|
||
|
|
<section class="constructor-details" id="constructor-detail">
|
||
|
|
<h2>Konstruktordetails</h2>
|
||
|
|
<ul class="member-list">
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="<init>()">
|
||
|
|
<h3>OurAlgorithm</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">OurAlgorithm</span>()</div>
|
||
|
|
<div class="block">Standard constructor.
|
||
|
|
Initializes an instance of OurAlgorithm.</div>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="<init>(OurApplication.OurParameterArea,OurApplication.OurMethodButtons)">
|
||
|
|
<h3>OurAlgorithm</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">OurAlgorithm</span><wbr><span class="parameters">(<a href="OurParameterArea.html" title="Klasse in OurApplication">OurParameterArea</a> parameterArea,
|
||
|
|
<a href="OurMethodButtons.html" title="Klasse in OurApplication">OurMethodButtons</a> methodButtons)</span></div>
|
||
|
|
<div class="block">Constructs a summation algorithm with parameters from the parameter area.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameter:</dt>
|
||
|
|
<dd><code>parameterArea</code> - the parameter area providing the selected graph for the algorithm</dd>
|
||
|
|
<dd><code>methodButtons</code> - the method buttons determining the algorithm type (Dijkstra or A-Star)</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
|
<li>
|
||
|
|
<section class="method-details" id="method-detail">
|
||
|
|
<h2>Methodendetails</h2>
|
||
|
|
<ul class="member-list">
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="run()">
|
||
|
|
<h3>run</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../logging/LogElementList.html" title="Klasse in logging">LogElementList</a><<a href="OurLogElement.html" title="Klasse in OurApplication">OurLogElement</a>></span> <span class="element-name">run</span>()</div>
|
||
|
|
<div class="block">Overridden method from the superclass.
|
||
|
|
Executes the summation algorithm.
|
||
|
|
Computes the shortest path in the current graph based on the selected method (Dijkstra or A-Star).</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Angegeben von:</dt>
|
||
|
|
<dd><code><a href="../logging/Algorithm.html#run()">run</a></code> in Klasse <code><a href="../logging/Algorithm.html" title="Klasse in logging">Algorithm</a></code></dd>
|
||
|
|
<dt>Gibt zurück:</dt>
|
||
|
|
<dd>a LogElementList containing the single steps of the algorithm processing</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<section class="detail" id="setCurrentGraph(graph.Graph)">
|
||
|
|
<h3>setCurrentGraph</h3>
|
||
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setCurrentGraph</span><wbr><span class="parameters">(<a href="../graph/Graph.html" title="Klasse in graph">Graph</a><<a href="../graph/VertexMarking.html" title="Klasse in graph">VertexMarking</a>,<wbr><a href="../graph/EdgeMarking.html" title="Klasse in graph">EdgeMarking</a>> graph)</span></div>
|
||
|
|
<div class="block">Sets the current graph for the algorithm.</div>
|
||
|
|
<dl class="notes">
|
||
|
|
<dt>Parameter:</dt>
|
||
|
|
<dd><code>graph</code> - the graph to be set as the current graph</dd>
|
||
|
|
</dl>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</section>
|
||
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
|
</main>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|