leonetienne/Eule
1
0
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity

built doxygen

Browse Source
This commit is contained in:
Leonetienne
2021-11-15 16:10:26 +01:00
parent 6926ebab1c
commit fb950d36a7
200 changed files with 658 additions and 545 deletions
Download Patch File Download Diff File Expand all files Collapse all files

131
Doxygen/build/classEule_1_1Math.html
View File

@@ -103,9 +103,12 @@ Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab9ccf4aa730ef825faf224445c86ab25"><td class="memItemLeft" align="right" valign="top">static constexpr double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEule_1_1Math.html#ab9ccf4aa730ef825faf224445c86ab25">Abs</a> (const double a)</td></tr>
<tr class="memdesc:ab9ccf4aa730ef825faf224445c86ab25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Will return the absolute value of <code>a</code> <a href="classEule_1_1Math.html#ab9ccf4aa730ef825faf224445c86ab25">More...</a><br /></td></tr>
<tr class="separator:ab9ccf4aa730ef825faf224445c86ab25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac928b1e9cde5ac60f5fdc1ba466305ff"><td class="memItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEule_1_1Math.html#ac928b1e9cde5ac60f5fdc1ba466305ff">Similar</a> (const double a, const double b, const double epsilon=0.00001)</td></tr>
<tr class="memdesc:ac928b1e9cde5ac60f5fdc1ba466305ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two double values with a given accuracy. <a href="classEule_1_1Math.html#ac928b1e9cde5ac60f5fdc1ba466305ff">More...</a><br /></td></tr>
<tr class="separator:ac928b1e9cde5ac60f5fdc1ba466305ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c9a4bc679357551b4a6315497f80f6f"><td class="memItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEule_1_1Math.html#a4c9a4bc679357551b4a6315497f80f6f">Similar</a> (const double a, const double b, const double epsilon=0.00001)</td></tr>
<tr class="memdesc:a4c9a4bc679357551b4a6315497f80f6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two double values with a given accuracy. <a href="classEule_1_1Math.html#a4c9a4bc679357551b4a6315497f80f6f">More...</a><br /></td></tr>
<tr class="separator:a4c9a4bc679357551b4a6315497f80f6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d17091e986de45e9bbee484e2d56430"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEule_1_1Math.html#a9d17091e986de45e9bbee484e2d56430">Mod</a> (const int numerator, const int denominator)</td></tr>
<tr class="memdesc:a9d17091e986de45e9bbee484e2d56430"><td class="mdescLeft">&#160;</td><td class="mdescRight">Will compute the actual modulo of a fraction. <a href="classEule_1_1Math.html#a9d17091e986de45e9bbee484e2d56430">More...</a><br /></td></tr>
<tr class="separator:a9d17091e986de45e9bbee484e2d56430"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6aa6d6c804f995a089779219e5136e4f"><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEule_1_1Math.html#a6aa6d6c804f995a089779219e5136e4f">Random</a> ()</td></tr>
<tr class="memdesc:a6aa6d6c804f995a089779219e5136e4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Will return a random double between <code>0</code> and <code>1</code> <a href="classEule_1_1Math.html#a6aa6d6c804f995a089779219e5136e4f">More...</a><br /></td></tr>
<tr class="separator:a6aa6d6c804f995a089779219e5136e4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -132,7 +135,7 @@ Static Public Member Functions</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classEule_1_1Math.html" title="Math utility class containing basic functions.">Math</a> utility class containing basic functions. </p>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00008">8</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00009">9</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ab9ccf4aa730ef825faf224445c86ab25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9ccf4aa730ef825faf224445c86ab25">&#9670;&nbsp;</a></span>Abs()</h2>
@@ -160,10 +163,10 @@ Static Public Member Functions</h2></td></tr>
<p>Will return the absolute value of <code>a</code> </p>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00092">92</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; {</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordflow">return</span> (a &gt; 0.0) ? a : -a;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00097">97</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; {</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordflow">return</span> (a &gt; 0.0) ? a : -a;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
@@ -209,10 +212,10 @@ Static Public Member Functions</h2></td></tr>
<p>Will return <code>v</code>, but at least <code>min</code>, and at most <code>max</code> </p>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00081">81</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classEule_1_1Math.html#a991c620839f5fa9fcfe7e503b8ab0008">Max</a>(<a class="code" href="classEule_1_1Math.html#aa4d3c52cb09984ec567a9961ff7e3f02">Min</a>(v, max), min);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00086">86</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; {</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classEule_1_1Math.html#a991c620839f5fa9fcfe7e503b8ab0008">Max</a>(<a class="code" href="classEule_1_1Math.html#aa4d3c52cb09984ec567a9961ff7e3f02">Min</a>(v, max), min);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
@@ -258,11 +261,11 @@ Static Public Member Functions</h2></td></tr>
<p>Will return the linear interpolation between <code>a</code> and <code>b</code> by <code>t</code> </p>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00086">86</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; {</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> it = 1.0 - t;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordflow">return</span> (a * it) + (b * t);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00091">91</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> it = 1.0 - t;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordflow">return</span> (a * it) + (b * t);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
@@ -302,10 +305,10 @@ Static Public Member Functions</h2></td></tr>
<p>Will return the bigger of two values. </p>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00071">71</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordflow">return</span> (a &gt; b) ? a : b;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00076">76</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordflow">return</span> (a &gt; b) ? a : b;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
@@ -345,10 +348,68 @@ Static Public Member Functions</h2></td></tr>
<p>Will return the smaller of two values. </p>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00076">76</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordflow">return</span> (a &lt; b) ? a : b;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00081">81</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; {</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordflow">return</span> (a &lt; b) ? a : b;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a9d17091e986de45e9bbee484e2d56430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d17091e986de45e9bbee484e2d56430">&#9670;&nbsp;</a></span>Mod()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Math::Mod </td>
<td>(</td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>numerator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int&#160;</td>
<td class="paramname"><em>denominator</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Will compute the actual modulo of a fraction. </p>
<p>The % operator returns bs for n&lt;0. May throw divide-by-zero std::logic_error </p>
<p class="definition">Definition at line <a class="el" href="Math_8cpp_source.html#l00078">78</a> of file <a class="el" href="Math_8cpp_source.html">Math.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;{</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">if</span> (denominator == 0)</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">&quot;Divide by zero&quot;</span>);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">// Quick optimizations:</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="comment">// -&gt; 0/n is always 0</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">if</span> (numerator == 0)</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="comment">// -&gt; operator% works for a &gt; 0 &amp;&amp; b &gt; 0</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">if</span> (denominator &gt; 0 &amp;&amp; numerator &gt; 0)</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="keywordflow">return</span> numerator % denominator;</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="comment">// Else: generalized formula</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordflow">return</span> (denominator + (numerator % denominator)) % denominator;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;}</div>
</div><!-- fragment -->
</div>
</div>
@@ -637,8 +698,8 @@ Static Public Member Functions</h2></td></tr>
</div><!-- fragment -->
</div>
</div>
<a id="ac928b1e9cde5ac60f5fdc1ba466305ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac928b1e9cde5ac60f5fdc1ba466305ff">&#9670;&nbsp;</a></span>Similar()</h2>
<a id="a4c9a4bc679357551b4a6315497f80f6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c9a4bc679357551b4a6315497f80f6f">&#9670;&nbsp;</a></span>Similar()</h2>
<div class="memitem">
<div class="memproto">
@@ -647,7 +708,7 @@ Static Public Member Functions</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static constexpr bool Eule::Math::Similar </td>
<td class="memname">constexpr bool Eule::Math::Similar </td>
<td>(</td>
<td class="paramtype">const double&#160;</td>
<td class="paramname"><em>a</em>, </td>
@@ -672,13 +733,18 @@ Static Public Member Functions</h2></td></tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two double values with a given accuracy. </p>
<p class="definition">Definition at line <a class="el" href="Math_8h_source.html#l00102">102</a> of file <a class="el" href="Math_8h_source.html">Math.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; {</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classEule_1_1Math.html#ab9ccf4aa730ef825faf224445c86ab25">Abs</a>(a - b) &lt;= epsilon;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
@@ -688,13 +754,14 @@ Static Public Member Functions</h2></td></tr>
</div><!-- contents -->
<div class="ttc" id="aMath_8cpp_html_ac0cae806d3e9a3772f7388dd53cfc370"><div class="ttname"><a href="Math_8cpp.html#ac0cae806d3e9a3772f7388dd53cfc370">MAKE_SURE_RNG_IS_INITIALIZED</a></div><div class="ttdeci">#define MAKE_SURE_RNG_IS_INITIALIZED</div><div class="ttdef"><b>Definition:</b> <a href="Math_8cpp_source.html#l00008">Math.cpp:8</a></div></div>
<div class="ttc" id="aConstants_8h_html_a299aabc5fc8285cbf99025330a3d0d0d"><div class="ttname"><a href="Constants_8h.html#a299aabc5fc8285cbf99025330a3d0d0d">PI</a></div><div class="ttdeci">static constexpr double PI</div><div class="ttdoc">Pi up to 50 decimal places.</div><div class="ttdef"><b>Definition:</b> <a href="Constants_8h_source.html#l00006">Constants.h:6</a></div></div>
<div class="ttc" id="aclassEule_1_1Math_html_a991c620839f5fa9fcfe7e503b8ab0008"><div class="ttname"><a href="classEule_1_1Math.html#a991c620839f5fa9fcfe7e503b8ab0008">Eule::Math::Max</a></div><div class="ttdeci">static constexpr double Max(const double a, const double b)</div><div class="ttdoc">Will return the bigger of two values.</div><div class="ttdef"><b>Definition:</b> <a href="Math_8h_source.html#l00071">Math.h:71</a></div></div>
<div class="ttc" id="aclassEule_1_1Math_html_aa4d3c52cb09984ec567a9961ff7e3f02"><div class="ttname"><a href="classEule_1_1Math.html#aa4d3c52cb09984ec567a9961ff7e3f02">Eule::Math::Min</a></div><div class="ttdeci">static constexpr double Min(const double a, const double b)</div><div class="ttdoc">Will return the smaller of two values.</div><div class="ttdef"><b>Definition:</b> <a href="Math_8h_source.html#l00076">Math.h:76</a></div></div>
<div class="ttc" id="aclassEule_1_1Math_html_ab9ccf4aa730ef825faf224445c86ab25"><div class="ttname"><a href="classEule_1_1Math.html#ab9ccf4aa730ef825faf224445c86ab25">Eule::Math::Abs</a></div><div class="ttdeci">static constexpr double Abs(const double a)</div><div class="ttdoc">Will return the absolute value of a</div><div class="ttdef"><b>Definition:</b> <a href="Math_8h_source.html#l00097">Math.h:97</a></div></div>
<div class="ttc" id="aclassEule_1_1Math_html_a991c620839f5fa9fcfe7e503b8ab0008"><div class="ttname"><a href="classEule_1_1Math.html#a991c620839f5fa9fcfe7e503b8ab0008">Eule::Math::Max</a></div><div class="ttdeci">static constexpr double Max(const double a, const double b)</div><div class="ttdoc">Will return the bigger of two values.</div><div class="ttdef"><b>Definition:</b> <a href="Math_8h_source.html#l00076">Math.h:76</a></div></div>
<div class="ttc" id="aclassEule_1_1Math_html_aa4d3c52cb09984ec567a9961ff7e3f02"><div class="ttname"><a href="classEule_1_1Math.html#aa4d3c52cb09984ec567a9961ff7e3f02">Eule::Math::Min</a></div><div class="ttdeci">static constexpr double Min(const double a, const double b)</div><div class="ttdoc">Will return the smaller of two values.</div><div class="ttdef"><b>Definition:</b> <a href="Math_8h_source.html#l00081">Math.h:81</a></div></div>
<div class="ttc" id="aclassEule_1_1Math_html_a6aa6d6c804f995a089779219e5136e4f"><div class="ttname"><a href="classEule_1_1Math.html#a6aa6d6c804f995a089779219e5136e4f">Eule::Math::Random</a></div><div class="ttdeci">static double Random()</div><div class="ttdoc">Will return a random double between 0 and 1</div><div class="ttdef"><b>Definition:</b> <a href="Math_8cpp_source.html#l00029">Math.cpp:29</a></div></div>
<div class="ttc" id="aConstants_8h_html_ad0661cafa18be7ccadefb27b6b809264"><div class="ttname"><a href="Constants_8h.html#ad0661cafa18be7ccadefb27b6b809264">HALF_PI</a></div><div class="ttdeci">static constexpr double HALF_PI</div><div class="ttdoc">Pi divided by two.</div><div class="ttdef"><b>Definition:</b> <a href="Constants_8h_source.html#l00009">Constants.h:9</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Nov 15 2021 11:45:52 for Leonetienne/Eule by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Mon Nov 15 2021 16:10:18 for Leonetienne/Eule by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>