dukantic/gomoku
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Aubin DORIVAL
2025-03-31 12:01:51 +02:00
parent 0867ea36c1
commit 7efba643b5
29 changed files with 1966 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
doc/GomokuAI.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (24) on Fri Mar 28 11:00:03 CET 2025 -->
<!-- Generated by javadoc (24) on Mon Mar 31 12:00:50 CEST 2025 -->
<title>GomokuAI</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="2025-03-28">
<meta name="dc.created" content="2025-03-31">
<meta name="description" content="declaration: class: GomokuAI">
<meta name="generator" content="javadoc/ClassWriter">
<link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">
@@ -78,6 +78,7 @@ loadScripts(document, 'script');</script>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#chooseMove(GomokuBoard)" tabindex="0">chooseMove(GomokuBoard)</a></li>
<li><a href="#GetCellPoint(GomokuBoard)" tabindex="0">GetCellPoint(GomokuBoard)</a></li>
</ol>
</li>
</ol>
@@ -88,13 +89,15 @@ loadScripts(document, 'script');</script>
<h1 title="Class GomokuAI" class="title">Class GomokuAI</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="Player.html" title="class in Unnamed Package">Player</a>
<div class="inheritance">GomokuAI</div>
</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="horizontal-scroll">
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">GomokuAI</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<span class="extends-implements">extends <a href="Player.html" title="class in Unnamed Package">Player</a></span></div>
</div>
</section>
<section class="summary">
@@ -110,11 +113,18 @@ loadScripts(document, 'script');</script>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>(package private) int</code></div>
<div class="col-second even-row-color"><code><a href="#difficulty" class="member-name-link">difficulty</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-last even-row-color">
<div class="block">The difficulty of the GomokuAI</div>
</div>
<div class="col-first odd-row-color"><code>(package private) <a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a></code></div>
<div class="col-second odd-row-color"><code><a href="#random" class="member-name-link">random</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-last odd-row-color">
<div class="block">The random initialization</div>
</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-Player">Fields inherited from class&nbsp;<a href="Player.html" title="class in Unnamed Package">Player</a></h3>
<code><a href="Player.html#color">color</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
@@ -141,12 +151,22 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Coordinate.html" title="class in Unnamed Package">Coordinate</a></code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#chooseMove(GomokuBoard)" class="member-name-link">chooseMove</a><wbr>(<a href="GomokuBoard.html" title="class in Unnamed Package">GomokuBoard</a>&nbsp;board)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the coordinate of the move played by the Gomoku AI.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr>&lt;<a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a>, <a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#GetCellPoint(GomokuBoard)" class="member-name-link">GetCellPoint</a><wbr>(<a href="GomokuBoard.html" title="class in Unnamed Package">GomokuBoard</a>&nbsp;board)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return a Map of all Cell playable, and their point.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Player">Methods inherited from class&nbsp;<a href="Player.html" title="class in Unnamed Package">Player</a></h3>
<code><a href="Player.html#getColor()">getColor</a>, <a href="Player.html#getName()">getName</a>, <a href="Player.html#Player(java.lang.String,Color)">Player</a></code></div>
<div class="inherited-list">
<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/24/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/24/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/24/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/24/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/24/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/24/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/24/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/24/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/24/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/24/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/24/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/24/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>
@@ -166,6 +186,7 @@ loadScripts(document, 'script');</script>
<h3>random</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a></span>&nbsp;<span class="element-name">random</span></div>
<div class="block">The random initialization</div>
</div>
</section>
</li>
@@ -174,6 +195,7 @@ loadScripts(document, 'script');</script>
<h3>difficulty</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name">difficulty</span></div>
<div class="block">The difficulty of the GomokuAI</div>
</div>
</section>
</li>
@@ -205,7 +227,31 @@ loadScripts(document, 'script');</script>
<section class="detail" id="chooseMove(GomokuBoard)">
<h3>chooseMove</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Coordinate.html" title="class in Unnamed Package">Coordinate</a></span>&nbsp;<span class="element-name">chooseMove</span><wbr><span class="parameters">(<a href="GomokuBoard.html" title="class in Unnamed Package">GomokuBoard</a>&nbsp;board)</span></div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a></span>&nbsp;<span class="element-name">chooseMove</span><wbr><span class="parameters">(<a href="GomokuBoard.html" title="class in Unnamed Package">GomokuBoard</a>&nbsp;board)</span></div>
<div class="block">Return the coordinate of the move played by the Gomoku AI.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Player.html#chooseMove(GomokuBoard)">chooseMove</a></code>&nbsp;in class&nbsp;<code><a href="Player.html" title="class in Unnamed Package">Player</a></code></dd>
<dt>Parameters:</dt>
<dd><code>board</code> - The actual Gomoku board.</dd>
<dt>Returns:</dt>
<dd>The Cell of the move played.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="GetCellPoint(GomokuBoard)">
<h3>GetCellPoint</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a>, <a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</span>&nbsp;<span class="element-name">GetCellPoint</span><wbr><span class="parameters">(<a href="GomokuBoard.html" title="class in Unnamed Package">GomokuBoard</a>&nbsp;board)</span></div>
<div class="block">Return a Map of all Cell playable, and their point.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>board</code> - The actual Gomoku board.</dd>
<dt>Returns:</dt>
<dd>the Map of all Cell playable, and their point.</dd>
</dl>
</div>
</section>
</li>