Skip to content

Commit d50acca

Browse files
author
Jegors Čemisovs
authored
Merge pull request #21 from rabestro/feature/interface
Update API documentation
2 parents 1b2ab6b + caae098 commit d50acca

15 files changed

+1801
-0
lines changed

‎docs/api/lv.id.jc.algorithm/lv/id/jc/algorithm/graph/BreadthFirstSearch.html

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (17) on Mon Jan 03 14:15:02 EET 2022 -->
5+
<title>BreadthFirstSearch</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8+
<meta name="dc.created" content="2022-01-03">
9+
<meta name="description" content="declaration: module: lv.id.jc.algorithm, package: lv.id.jc.algorithm.graph, class: BreadthFirstSearch">
10+
<meta name="generator" content="javadoc/ClassWriterImpl">
11+
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
13+
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
14+
<script type="text/javascript" src="../../../../../../script.js"></script>
15+
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script>
16+
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
17+
</head>
18+
<body class="class-declaration-page">
19+
<script type="text/javascript">var evenRowColor = "even-row-color";
20+
var oddRowColor = "odd-row-color";
21+
var tableTab = "table-tab";
22+
var activeTableTab = "active-table-tab";
23+
var pathtoroot = "../../../../../../";
24+
loadScripts(document, 'script');</script>
25+
<noscript>
26+
<div>JavaScript is disabled on your browser.</div>
27+
</noscript>
28+
<div class="flex-box">
29+
<header role="banner" class="flex-header">
30+
<nav role="navigation">
31+
<!-- ========= START OF TOP NAVBAR ======= -->
32+
<div class="top-nav" id="navbar-top">
33+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
34+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
35+
<li><a href="../../../../../module-summary.html">Module</a></li>
36+
<li><a href="package-summary.html">Package</a></li>
37+
<li class="nav-bar-cell1-rev">Class</li>
38+
<li><a href="class-use/BreadthFirstSearch.html">Use</a></li>
39+
<li><a href="package-tree.html">Tree</a></li>
40+
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
41+
<li><a href="../../../../../../help-doc.html#class">Help</a></li>
42+
</ul>
43+
</div>
44+
<div class="sub-nav">
45+
<div>
46+
<ul class="sub-nav-list">
47+
<li>Summary:&nbsp;</li>
48+
<li>Nested&nbsp;|&nbsp;</li>
49+
<li>Field&nbsp;|&nbsp;</li>
50+
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
51+
<li><a href="#method-summary">Method</a></li>
52+
</ul>
53+
<ul class="sub-nav-list">
54+
<li>Detail:&nbsp;</li>
55+
<li>Field&nbsp;|&nbsp;</li>
56+
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
57+
<li><a href="#method-detail">Method</a></li>
58+
</ul>
59+
</div>
60+
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
61+
<input type="text" id="search-input" value="search" disabled="disabled">
62+
<input type="reset" id="reset-button" value="reset" disabled="disabled">
63+
</div>
64+
</div>
65+
<!-- ========= END OF TOP NAVBAR ========= -->
66+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
67+
</header>
68+
<div class="flex-content">
69+
<main role="main">
70+
<!-- ======== START OF CLASS DATA ======== -->
71+
<div class="header">
72+
<div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../../module-summary.html">lv.id.jc.algorithm</a></div>
73+
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">lv.id.jc.algorithm.graph</a></div>
74+
<h1 title="Class BreadthFirstSearch" class="title">Class BreadthFirstSearch&lt;T&gt;</h1>
75+
</div>
76+
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
77+
<div class="inheritance">lv.id.jc.algorithm.graph.BreadthFirstSearch&lt;T&gt;</div>
78+
</div>
79+
<section class="class-description" id="class-description">
80+
<dl class="notes">
81+
<dt>Type Parameters:</dt>
82+
<dd><code>T</code> - the type of vertex id</dd>
83+
</dl>
84+
<dl class="notes">
85+
<dt>All Implemented Interfaces:</dt>
86+
<dd><code><a href="SearchAlgorithm.html" title="interface in lv.id.jc.algorithm.graph">SearchAlgorithm</a>&lt;T&gt;</code></dd>
87+
</dl>
88+
<hr>
89+
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">BreadthFirstSearch&lt;T&gt;</span>
90+
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
91+
implements <a href="SearchAlgorithm.html" title="interface in lv.id.jc.algorithm.graph">SearchAlgorithm</a>&lt;T&gt;</span></div>
92+
<div class="block">Algorithm for finding the shortest paths between nodes in a graph.
93+
94+
The algorithm doesn't take into account the distance between nodes.</div>
95+
<dl class="notes">
96+
<dt>Since:</dt>
97+
<dd>1.0</dd>
98+
</dl>
99+
</section>
100+
<section class="summary">
101+
<ul class="summary-list">
102+
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
103+
<li>
104+
<section class="constructor-summary" id="constructor-summary">
105+
<h2>Constructor Summary</h2>
106+
<div class="caption"><span>Constructors</span></div>
107+
<div class="summary-table two-column-summary">
108+
<div class="table-header col-first">Constructor</div>
109+
<div class="table-header col-last">Description</div>
110+
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BreadthFirstSearch</a>()</code></div>
111+
<div class="col-last even-row-color">&nbsp;</div>
112+
</div>
113+
</section>
114+
</li>
115+
<!-- ========== METHOD SUMMARY =========== -->
116+
<li>
117+
<section class="method-summary" id="method-summary">
118+
<h2>Method Summary</h2>
119+
<div id="method-summary-table">
120+
<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">All Methods</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">Instance Methods</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">Concrete Methods</button></div>
121+
<div id="method-summary-table.tabpanel" role="tabpanel">
122+
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
123+
<div class="table-header col-first">Modifier and Type</div>
124+
<div class="table-header col-second">Method</div>
125+
<div class="table-header col-last">Description</div>
126+
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="BreadthFirstSearch.html" title="type parameter in BreadthFirstSearch">T</a>&gt;</code></div>
127+
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#findPath(lv.id.jc.algorithm.graph.Graph,T,T)" class="member-name-link">findPath</a><wbr>(<a href="Graph.html" title="interface in lv.id.jc.algorithm.graph">Graph</a>&lt;<a href="BreadthFirstSearch.html" title="type parameter in BreadthFirstSearch">T</a>&gt;&nbsp;graph,
128+
<a href="BreadthFirstSearch.html" title="type parameter in BreadthFirstSearch">T</a>&nbsp;source,
129+
<a href="BreadthFirstSearch.html" title="type parameter in BreadthFirstSearch">T</a>&nbsp;target)</code></div>
130+
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
131+
<div class="block">Find the path from the source node to the target</div>
132+
</div>
133+
</div>
134+
</div>
135+
</div>
136+
<div class="inherited-list">
137+
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
138+
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
139+
</section>
140+
</li>
141+
</ul>
142+
</section>
143+
<section class="details">
144+
<ul class="details-list">
145+
<!-- ========= CONSTRUCTOR DETAIL ======== -->
146+
<li>
147+
<section class="constructor-details" id="constructor-detail">
148+
<h2>Constructor Details</h2>
149+
<ul class="member-list">
150+
<li>
151+
<section class="detail" id="&lt;init&gt;()">
152+
<h3>BreadthFirstSearch</h3>
153+
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">BreadthFirstSearch</span>()</div>
154+
</section>
155+
</li>
156+
</ul>
157+
</section>
158+
</li>
159+
<!-- ============ METHOD DETAIL ========== -->
160+
<li>
161+
<section class="method-details" id="method-detail">
162+
<h2>Method Details</h2>
163+
<ul class="member-list">
164+
<li>
165+
<section class="detail" id="findPath(lv.id.jc.algorithm.graph.Graph,T,T)">
166+
<h3 id="findPath(lv.id.jc.algorithm.graph.Graph,java.lang.Object,java.lang.Object)">findPath</h3>
167+
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="BreadthFirstSearch.html" title="type parameter in BreadthFirstSearch">T</a>&gt;</span>&nbsp;<span class="element-name">findPath</span><wbr><span class="parameters">(<a href="Graph.html" title="interface in lv.id.jc.algorithm.graph">Graph</a>&lt;<a href="BreadthFirstSearch.html" title="type parameter in BreadthFirstSearch">T</a>&gt;&nbsp;graph,
168+
<a href="BreadthFirstSearch.html" title="type parameter in BreadthFirstSearch">T</a>&nbsp;source,
169+
<a href="BreadthFirstSearch.html" title="type parameter in BreadthFirstSearch">T</a>&nbsp;target)</span></div>
170+
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="SearchAlgorithm.html#findPath(lv.id.jc.algorithm.graph.Graph,T,T)">SearchAlgorithm</a></code></span></div>
171+
<div class="block">Find the path from the source node to the target</div>
172+
<dl class="notes">
173+
<dt>Specified by:</dt>
174+
<dd><code><a href="SearchAlgorithm.html#findPath(lv.id.jc.algorithm.graph.Graph,T,T)">findPath</a></code>&nbsp;in interface&nbsp;<code><a href="SearchAlgorithm.html" title="interface in lv.id.jc.algorithm.graph">SearchAlgorithm</a>&lt;<a href="BreadthFirstSearch.html" title="type parameter in BreadthFirstSearch">T</a>&gt;</code></dd>
175+
<dt>Parameters:</dt>
176+
<dd><code>graph</code> - The graph in which we search for the path</dd>
177+
<dd><code>source</code> - Search starting point identifier</dd>
178+
<dd><code>target</code> - Search finish point identifier</dd>
179+
<dt>Returns:</dt>
180+
<dd>Path found or empty list if path cannot be found</dd>
181+
</dl>
182+
</section>
183+
</li>
184+
</ul>
185+
</section>
186+
</li>
187+
</ul>
188+
</section>
189+
<!-- ========= END OF CLASS DATA ========= -->
190+
</main>
191+
</div>
192+
</div>
193+
</body>
194+
</html>

0 commit comments

Comments
 (0)