293 lines
12 KiB
HTML
293 lines
12 KiB
HTML
<!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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Doxytest
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</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> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<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 name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a350c5ee9551106bcadf487abe983f1ce"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#a350c5ee9551106bcadf487abe983f1ce">__init__</a> (self, value=0)</td></tr>
|
|
<tr class="separator:a350c5ee9551106bcadf487abe983f1ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b0de864b2501e6cbe51d374023d9485"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#a3b0de864b2501e6cbe51d374023d9485">add</a> (self, number)</td></tr>
|
|
<tr class="separator:a3b0de864b2501e6cbe51d374023d9485"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a398ce099422193d3a814a23df307af40"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#a398ce099422193d3a814a23df307af40">subtract</a> (self, number)</td></tr>
|
|
<tr class="separator:a398ce099422193d3a814a23df307af40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ebb4c4221c4e2b12dc417a1704dc79b"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#a4ebb4c4221c4e2b12dc417a1704dc79b">multiply</a> (self, number)</td></tr>
|
|
<tr class="separator:a4ebb4c4221c4e2b12dc417a1704dc79b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39ad2dc1258dd50fd2970d7627f14219"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#a39ad2dc1258dd50fd2970d7627f14219">divide</a> (self, number)</td></tr>
|
|
<tr class="separator:a39ad2dc1258dd50fd2970d7627f14219"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef3f4068440573b93e3c5fb556964223"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classtest_1_1Calculator.html#aef3f4068440573b93e3c5fb556964223">clear</a> (self)</td></tr>
|
|
<tr class="separator:aef3f4068440573b93e3c5fb556964223"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ab35d98546e4ad522f5b85254c435e7ae"><td class="memItemLeft" align="right" valign="top"><a id="ab35d98546e4ad522f5b85254c435e7ae"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
|
|
<tr class="separator:ab35d98546e4ad522f5b85254c435e7ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><pre class="fragment">A simple calculator class to perform basic arithmetic operations.
|
|
</pre> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a350c5ee9551106bcadf487abe983f1ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a350c5ee9551106bcadf487abe983f1ce">◆ </a></span>__init__()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def test.Calculator.__init__ </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>value</em> = <code>0</code> </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="a3b0de864b2501e6cbe51d374023d9485"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3b0de864b2501e6cbe51d374023d9485">◆ </a></span>add()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def test.Calculator.add </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>number</em> </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="aef3f4068440573b93e3c5fb556964223"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aef3f4068440573b93e3c5fb556964223">◆ </a></span>clear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def test.Calculator.clear </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </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="a39ad2dc1258dd50fd2970d7627f14219"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a39ad2dc1258dd50fd2970d7627f14219">◆ </a></span>divide()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def test.Calculator.divide </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>number</em> </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="a4ebb4c4221c4e2b12dc417a1704dc79b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ebb4c4221c4e2b12dc417a1704dc79b">◆ </a></span>multiply()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def test.Calculator.multiply </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>number</em> </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="a398ce099422193d3a814a23df307af40"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a398ce099422193d3a814a23df307af40">◆ </a></span>subtract()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">def test.Calculator.subtract </td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>number</em> </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/test.py</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|