backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-04-30 05:22:46 +08:00
Code Issues Projects Releases Wiki Activity

Documentation for f1eddf4d65

Browse Source
This commit is contained in:
realstealthninja
2025-07-09 10:53:16 +00:00
parent e7edde96ab
commit b41207008f
2497 changed files with 31270 additions and 40283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
d6/d30/classmachine__learning_1_1adaline.html
View File

@@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: machine_learning::adaline Class Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
@@ -19,7 +19,6 @@
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
@@ -60,26 +59,20 @@ window.MathJax = {
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
@@ -94,10 +87,9 @@ $(function() {
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d6/d30/classmachine__learning_1_1adaline.html','../../'); initResizable(true); });
/* @license-end */
$(function(){initNavTree('d6/d30/classmachine__learning_1_1adaline.html','../../','d9/d21/classmachine__learning_1_1adaline-members'); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -121,61 +113,45 @@ $(function(){initNavTree('d6/d30/classmachine__learning_1_1adaline.html','../../
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="../../d9/d21/classmachine__learning_1_1adaline-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">machine_learning::adaline Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for machine_learning::adaline:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../da/dd3/classmachine__learning_1_1adaline__coll__graph.svg" width="183" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../da/dd3/classmachine__learning_1_1adaline__coll__graph.svg" width="183" height="134"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="../../graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0acbe32aaab897e7939e5b0454035b8c" id="r_a0acbe32aaab897e7939e5b0454035b8c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0acbe32aaab897e7939e5b0454035b8c">adaline</a> (int num_features, const double <a class="el" href="#a28160d17e492597a2f112e0d38551cda">eta</a>=0.01f, const double <a class="el" href="#aa23d60262f917f35836ef4b1c1d9f7d3">accuracy</a>=1e-5)</td></tr>
<tr class="separator:a0acbe32aaab897e7939e5b0454035b8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab11242d9ad5b03a75911e29b04f78fd3" id="r_ab11242d9ad5b03a75911e29b04f78fd3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab11242d9ad5b03a75911e29b04f78fd3">predict</a> (const std::vector&lt; double &gt; &amp;x, double *out=nullptr)</td></tr>
<tr class="separator:ab11242d9ad5b03a75911e29b04f78fd3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74e3c6c037b67895014414c5d75465e5" id="r_a74e3c6c037b67895014414c5d75465e5"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a74e3c6c037b67895014414c5d75465e5">fit</a> (const std::vector&lt; double &gt; &amp;x, const int &amp;y)</td></tr>
<tr class="separator:a74e3c6c037b67895014414c5d75465e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d61f9ed872eef26bca39388cbda6a91" id="r_a8d61f9ed872eef26bca39388cbda6a91"><td class="memTemplParams" colspan="2">template&lt;size_t N&gt; </td></tr>
<tr class="memitem:a8d61f9ed872eef26bca39388cbda6a91"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a8d61f9ed872eef26bca39388cbda6a91">fit</a> (std::array&lt; std::vector&lt; double &gt;, N &gt; const &amp;X, std::array&lt; int, N &gt; const &amp;Y)</td></tr>
<tr class="separator:a8d61f9ed872eef26bca39388cbda6a91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d61f9ed872eef26bca39388cbda6a91 template"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d61f9ed872eef26bca39388cbda6a91">fit</a> (std::array&lt; std::vector&lt; double &gt;, N &gt; const &amp;X, std::array&lt; int, N &gt; const &amp;Y)</td></tr>
<tr class="memitem:a082f758fb55fe19f22b3df66f89b2325" id="r_a082f758fb55fe19f22b3df66f89b2325"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a082f758fb55fe19f22b3df66f89b2325">activation</a> (double x)</td></tr>
<tr class="separator:a082f758fb55fe19f22b3df66f89b2325"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
<tr class="heading"><td colspan="2"><h2 id="header-pri-methods" class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:ac8a9c2aaaa63b0f27ea176857e1e7d56" id="r_ac8a9c2aaaa63b0f27ea176857e1e7d56"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac8a9c2aaaa63b0f27ea176857e1e7d56">check_size_match</a> (const std::vector&lt; double &gt; &amp;x)</td></tr>
<tr class="separator:ac8a9c2aaaa63b0f27ea176857e1e7d56"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
<tr class="heading"><td colspan="2"><h2 id="header-pri-attribs" class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a28160d17e492597a2f112e0d38551cda" id="r_a28160d17e492597a2f112e0d38551cda"><td class="memItemLeft" align="right" valign="top">const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a28160d17e492597a2f112e0d38551cda">eta</a></td></tr>
<tr class="memdesc:a28160d17e492597a2f112e0d38551cda"><td class="mdescLeft">&#160;</td><td class="mdescRight">learning rate of the algorithm <br /></td></tr>
<tr class="separator:a28160d17e492597a2f112e0d38551cda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa23d60262f917f35836ef4b1c1d9f7d3" id="r_aa23d60262f917f35836ef4b1c1d9f7d3"><td class="memItemLeft" align="right" valign="top">const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa23d60262f917f35836ef4b1c1d9f7d3">accuracy</a></td></tr>
<tr class="memdesc:aa23d60262f917f35836ef4b1c1d9f7d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">model fit convergence accuracy <br /></td></tr>
<tr class="separator:aa23d60262f917f35836ef4b1c1d9f7d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4cd8fe438032fedaa66f93bfd66f5492" id="r_a4cd8fe438032fedaa66f93bfd66f5492"><td class="memItemLeft" align="right" valign="top">std::vector&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4cd8fe438032fedaa66f93bfd66f5492">weights</a></td></tr>
<tr class="memdesc:a4cd8fe438032fedaa66f93bfd66f5492"><td class="mdescLeft">&#160;</td><td class="mdescRight">weights of the neural network <br /></td></tr>
<tr class="separator:a4cd8fe438032fedaa66f93bfd66f5492"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
<tr class="heading"><td colspan="2"><h2 id="header-friends" class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ae347040516e995c8fb8ca2e5c0496daa" id="r_ae347040516e995c8fb8ca2e5c0496daa"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae347040516e995c8fb8ca2e5c0496daa">operator&lt;&lt;</a> (std::ostream &amp;out, const <a class="el" href="../../d6/d30/classmachine__learning_1_1adaline.html">adaline</a> &amp;ada)</td></tr>
<tr class="separator:ae347040516e995c8fb8ca2e5c0496daa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="../../d5/db0/adaline__learning_8cpp_source.html#l00046">46</a> of file <a class="el" href="../../d5/db0/adaline__learning_8cpp_source.html">adaline_learning.cpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0acbe32aaab897e7939e5b0454035b8c" name="a0acbe32aaab897e7939e5b0454035b8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0acbe32aaab897e7939e5b0454035b8c">&#9670;&#160;</a></span>adaline()</h2>
@@ -238,7 +214,7 @@ Friends</h2></td></tr>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="a082f758fb55fe19f22b3df66f89b2325" name="a082f758fb55fe19f22b3df66f89b2325"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a082f758fb55fe19f22b3df66f89b2325">&#9670;&#160;</a></span>activation()</h2>
@@ -309,9 +285,9 @@ Friends</h2></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> size matches </dd>
<dl class="section return"><dt>Returns</dt><dd><span class="tt">true</span> size matches </dd>
<dd>
<code>false</code> size does not match </dd></dl>
<span class="tt">false</span> size does not match </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d5/db0/adaline__learning_8cpp_source.html#l00196">196</a> of file <a class="el" href="../../d5/db0/adaline__learning_8cpp_source.html">adaline_learning.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 196</span> {</div>
@@ -487,7 +463,7 @@ template&lt;size_t N&gt; </div>
<p>predict the output of the model for given set of features </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>input vector </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>optional argument to return neuron output before applying activation function (optional, <code>nullptr</code> to ignore) </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>optional argument to return neuron output before applying activation function (optional, <span class="tt">nullptr</span> to ignore) </td></tr>
</table>
</dd>
</dl>
@@ -514,7 +490,7 @@ template&lt;size_t N&gt; </div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a name="doc-related-members" id="doc-related-members"></a><h2 id="header-doc-related-members" class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="ae347040516e995c8fb8ca2e5c0496daa" name="ae347040516e995c8fb8ca2e5c0496daa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae347040516e995c8fb8ca2e5c0496daa">&#9670;&#160;</a></span>operator&lt;&lt;</h2>
@@ -558,7 +534,7 @@ template&lt;size_t N&gt; </div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="aa23d60262f917f35836ef4b1c1d9f7d3" name="aa23d60262f917f35836ef4b1c1d9f7d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa23d60262f917f35836ef4b1c1d9f7d3">&#9670;&#160;</a></span>accuracy</h2>
@@ -642,11 +618,19 @@ template&lt;size_t N&gt; </div>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d8/d77/namespacemachine__learning.html">machine_learning</a></li><li class="navelem"><a class="el" href="../../d6/d30/classmachine__learning_1_1adaline.html">adaline</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
<li class="navelem"><a href="../../d8/d77/namespacemachine__learning.html">machine_learning</a></li><li class="navelem"><a href="../../d6/d30/classmachine__learning_1_1adaline.html">adaline</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>