Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mettbroetchen43 committed Jul 10, 2023
1 parent 12486a4 commit 16baf8b
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions math_basics/math_basics.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Python: module math_basics</title>
</head><body>

<table class="heading">
<tr class="heading-text decor">
<td class="title">&nbsp;<br><strong class="title">math_basics</strong></td>
<td class="extra"><a href=".">index</a><br><a href="file:math_basics.py">math_basics.py</a></td></tr></table>
<p><span class="code">#&nbsp;MIT&nbsp;License</span></p>
<p>
<table class="section">
<tr class="decor functions-decor heading-text">
<td class="section-title" colspan=3>&nbsp;<br><strong class="bigsection">Functions</strong></td></tr>

<tr><td class="decor functions-decor"><span class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td><td>&nbsp;</td>
<td class="singlecolumn"><dl><dt><a name="-addPercent"><strong>addPercent</strong></a>(val1, val2)</dt><dd><span class="code">Adds&nbsp;val2&nbsp;%&nbsp;of&nbsp;val1&nbsp;to&nbsp;val1</span></dd></dl>
<dl><dt><a name="-cbrt"><strong>cbrt</strong></a>(value)</dt><dd><span class="code">Returns&nbsp;the&nbsp;Cube&nbsp;Root&nbsp;of&nbsp;val</span></dd></dl>
<dl><dt><a name="-div"><strong>div</strong></a>(val1, val2)</dt><dd><span class="code">I&nbsp;am&nbsp;fully&nbsp;aware&nbsp;that&nbsp;divisions&nbsp;are&nbsp;provided&nbsp;natively<br>
by&nbsp;Python,&nbsp;but&nbsp;I&nbsp;find&nbsp;it&nbsp;useful&nbsp;though&nbsp;to&nbsp;introduce&nbsp;<br>
a&nbsp;division&nbsp;functionality.&nbsp;The&nbsp;special&nbsp;about&nbsp;this&nbsp;function&nbsp;<br>
is&nbsp;that&nbsp;it&nbsp;checks&nbsp;whether&nbsp;val2&nbsp;is&nbsp;not&nbsp;0,&nbsp;since&nbsp;divisions&nbsp;<br>
by&nbsp;zero&nbsp;are&nbsp;mathematically&nbsp;prohibited.<br>
However,&nbsp;this&nbsp;function&nbsp;divides&nbsp;val1&nbsp;by&nbsp;val2&nbsp;and&nbsp;returns&nbsp;the<br>
result,&nbsp;given&nbsp;the&nbsp;requirements&nbsp;that&nbsp;both&nbsp;values&nbsp;are&nbsp;not&nbsp;strings<br>
and&nbsp;val2&nbsp;is&nbsp;not&nbsp;0.</span></dd></dl>
<dl><dt><a name="-getPercent"><strong>getPercent</strong></a>(val1, val2)</dt><dd><span class="code">Returns&nbsp;val2&nbsp;%&nbsp;of&nbsp;val1</span></dd></dl>
<dl><dt><a name="-isint"><strong>isint</strong></a>(value)</dt><dd><span class="code">Checks&nbsp;whether&nbsp;given&nbsp;value&nbsp;is&nbsp;of&nbsp;type&nbsp;'int'</span></dd></dl>
<dl><dt><a name="-isnotstring"><strong>isnotstring</strong></a>(value)</dt><dd><span class="code">Checks&nbsp;whether&nbsp;given&nbsp;value&nbsp;is&nbsp;of&nbsp;type&nbsp;'str'&nbsp;<br>
since&nbsp;calculations&nbsp;with&nbsp;strings&nbsp;are&nbsp;pointless.</span></dd></dl>
<dl><dt><a name="-isnotzero"><strong>isnotzero</strong></a>(value)</dt></dl>
<dl><dt><a name="-mod"><strong>mod</strong></a>(val1, val2)</dt><dd><span class="code">Returns&nbsp;the&nbsp;modulo&nbsp;of&nbsp;val1&nbsp;/&nbsp;val2</span></dd></dl>
<dl><dt><a name="-pow"><strong>pow</strong></a>(val1, val2)</dt><dd><span class="code">Returns&nbsp;val1&nbsp;to&nbsp;the&nbsp;power&nbsp;of&nbsp;val2</span></dd></dl>
<dl><dt><a name="-rec"><strong>rec</strong></a>(value)</dt><dd><span class="code">Returns&nbsp;the&nbsp;reciprocal&nbsp;of&nbsp;given&nbsp;value.</span></dd></dl>
<dl><dt><a name="-root"><strong>root</strong></a>(val1, val2)</dt><dd><span class="code">Returns&nbsp;the&nbsp;val2.&nbsp;root&nbsp;of&nbsp;val1.</span></dd></dl>
<dl><dt><a name="-sqrt"><strong>sqrt</strong></a>(value)</dt><dd><span class="code">Returns&nbsp;the&nbsp;Square&nbsp;Root&nbsp;of&nbsp;val</span></dd></dl>
<dl><dt><a name="-subPercent"><strong>subPercent</strong></a>(val1, val2)</dt><dd><span class="code">Subtracts&nbsp;val2&nbsp;%&nbsp;of&nbsp;val1&nbsp;from&nbsp;val1</span></dd></dl>
<dl><dt><a name="-val2bin"><strong>val2bin</strong></a>(value)</dt><dd><span class="code">Converts&nbsp;given&nbsp;int&nbsp;value&nbsp;to&nbsp;binary&nbsp;format,&nbsp;<br>
but&nbsp;cuts&nbsp;off&nbsp;the&nbsp;"0b"&nbsp;prefix.</span></dd></dl>
<dl><dt><a name="-val2hex"><strong>val2hex</strong></a>(value)</dt><dd><span class="code">Converts&nbsp;given&nbsp;int&nbsp;value&nbsp;to&nbsp;hexadecimal&nbsp;format,&nbsp;<br>
but&nbsp;cuts&nbsp;off&nbsp;the&nbsp;"0x"&nbsp;prefix.</span></dd></dl>
<dl><dt><a name="-val2oct"><strong>val2oct</strong></a>(value)</dt><dd><span class="code">Converts&nbsp;given&nbsp;int&nbsp;value&nbsp;to&nbsp;octadecimal&nbsp;format,<br>
but&nbsp;cuts&nbsp;off&nbsp;the&nbsp;0o&nbsp;prefix.</span></dd></dl>
</td></tr></table>
</body></html>

0 comments on commit 16baf8b

Please sign in to comment.