thijskamphuis/doxytest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
doxytest/classtest_1_1Calculator.html
thijskamphuis 14898d73df Update web branch with documentation
2025-01-28 21:54:17 +00:00

300 lines
13 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Doxytest: test.Calculator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Doxytest
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>test</b></li><li class="navelem"><a class="el" href="classtest_1_1Calculator.html">Calculator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classtest_1_1Calculator-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">test.Calculator Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8c185a7535165af0112843a7f90591d0" id="r_a8c185a7535165af0112843a7f90591d0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#a8c185a7535165af0112843a7f90591d0">__init__</a> (self, value=0)</td></tr>
<tr class="separator:a8c185a7535165af0112843a7f90591d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51380d9f2eec6a681756eae123305b20" id="r_a51380d9f2eec6a681756eae123305b20"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#a51380d9f2eec6a681756eae123305b20">add</a> (self, number)</td></tr>
<tr class="separator:a51380d9f2eec6a681756eae123305b20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac880e047baec7af0fab457854361b85a" id="r_ac880e047baec7af0fab457854361b85a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#ac880e047baec7af0fab457854361b85a">subtract</a> (self, number)</td></tr>
<tr class="separator:ac880e047baec7af0fab457854361b85a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8b5873a8477abcafd093a2471875c10" id="r_ad8b5873a8477abcafd093a2471875c10"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#ad8b5873a8477abcafd093a2471875c10">multiply</a> (self, number)</td></tr>
<tr class="separator:ad8b5873a8477abcafd093a2471875c10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad86df66a089c89fb9ff2f982289ccbb3" id="r_ad86df66a089c89fb9ff2f982289ccbb3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#ad86df66a089c89fb9ff2f982289ccbb3">divide</a> (self, number)</td></tr>
<tr class="separator:ad86df66a089c89fb9ff2f982289ccbb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50984c3a86c450965b48ee0a3ac536d5" id="r_a50984c3a86c450965b48ee0a3ac536d5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#a50984c3a86c450965b48ee0a3ac536d5">clear</a> (self)</td></tr>
<tr class="separator:a50984c3a86c450965b48ee0a3ac536d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ab35d98546e4ad522f5b85254c435e7ae" id="r_ab35d98546e4ad522f5b85254c435e7ae"><td class="memItemLeft" align="right" valign="top"><a id="ab35d98546e4ad522f5b85254c435e7ae" name="ab35d98546e4ad522f5b85254c435e7ae"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
<tr class="separator:ab35d98546e4ad522f5b85254c435e7ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">A kk kk simple calculator class to perform basic arithmetic operations.
</pre> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8c185a7535165af0112843a7f90591d0" name="a8c185a7535165af0112843a7f90591d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c185a7535165af0112843a7f90591d0">&#9670;&#160;</a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">test.Calculator.__init__ </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>value</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Initializes the calculator with a starting value.
:param value: The starting value of the calculator (default is 0).
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a51380d9f2eec6a681756eae123305b20" name="a51380d9f2eec6a681756eae123305b20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51380d9f2eec6a681756eae123305b20">&#9670;&#160;</a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">test.Calculator.add </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>number</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Adds a number to the current value.
:param number: The number to add.
:return: The updated value after addition.
</pre>
</div>
</div>
<a id="a50984c3a86c450965b48ee0a3ac536d5" name="a50984c3a86c450965b48ee0a3ac536d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50984c3a86c450965b48ee0a3ac536d5">&#9670;&#160;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">test.Calculator.clear </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Resets the calculator to its initial value (0).
:return: The reset value (0).
</pre>
</div>
</div>
<a id="ad86df66a089c89fb9ff2f982289ccbb3" name="ad86df66a089c89fb9ff2f982289ccbb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad86df66a089c89fb9ff2f982289ccbb3">&#9670;&#160;</a></span>divide()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">test.Calculator.divide </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>number</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Divides the current value by the given number.
:param number: The number to divide by.
:return: The updated value after division.
:raises ZeroDivisionError: If the number is zero.
</pre>
</div>
</div>
<a id="ad8b5873a8477abcafd093a2471875c10" name="ad8b5873a8477abcafd093a2471875c10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8b5873a8477abcafd093a2471875c10">&#9670;&#160;</a></span>multiply()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">test.Calculator.multiply </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>number</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Multiplies the current value by a given number.
:param number: The number to multiply with.
:return: The updated value after multiplication.
</pre>
</div>
</div>
<a id="ac880e047baec7af0fab457854361b85a" name="ac880e047baec7af0fab457854361b85a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac880e047baec7af0fab457854361b85a">&#9670;&#160;</a></span>subtract()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">test.Calculator.subtract </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>number</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Subtracts a number from the current value.
:param number: The number to subtract.
:return: The updated value after subtraction.
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/<b>test.py</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink