Skip to content

Commit f967f9b

Browse files
tomcombriattomcombriat
committed
Updated doc
1 parent 8ae203b commit f967f9b

32 files changed

+773
-629
lines changed

‎docs/html/FixMath_8h_source.html

Lines changed: 464 additions & 461 deletions
Large diffs are not rendered by default.

‎docs/html/FixMath__Autotests_8h_source.html

Lines changed: 45 additions & 42 deletions
Large diffs are not rendered by default.

‎docs/html/classSFix-members.html

Lines changed: 31 additions & 30 deletions
Large diffs are not rendered by default.

‎docs/html/classSFix.html

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,9 @@
158158
<tr class="separator:a8e26f89e3aa2969906d9ff3deaa53328"><td class="memSeparator" colspan="2">&#160;</td></tr>
159159
<tr class="memitem:a319ae49f75636efec3999140a31fc85c"><td class="memItemLeft" align="right" valign="top">static constexpr int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSFix.html#a319ae49f75636efec3999140a31fc85c">getNF</a> ()</td></tr>
160160
<tr class="separator:a319ae49f75636efec3999140a31fc85c"><td class="memSeparator" colspan="2">&#160;</td></tr>
161+
<tr class="memitem:a59bd681b9d4bfaa3141d9d96e05728a2"><td class="memTemplParams" colspan="2">template&lt;int8_t BITS&gt; </td></tr>
162+
<tr class="memitem:a59bd681b9d4bfaa3141d9d96e05728a2"><td class="memTemplItemLeft" align="right" valign="top">static constexpr void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classSFix.html#a59bd681b9d4bfaa3141d9d96e05728a2">assertSize</a> ()</td></tr>
163+
<tr class="separator:a59bd681b9d4bfaa3141d9d96e05728a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
161164
</table><table class="memberdecls">
162165
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
163166
Friends</h2></td></tr>
@@ -484,6 +487,37 @@ <h2 class="memtitle"><span class="permalink"><a href="#a30667c56d94bf030fbe51d4e
484487
</div><div class="memdoc">
485488
<p>Returns the internal integer value </p><dl class="section return"><dt>Returns</dt><dd>the internal value </dd></dl>
486489

490+
</div>
491+
</div>
492+
<a id="a59bd681b9d4bfaa3141d9d96e05728a2"></a>
493+
<h2 class="memtitle"><span class="permalink"><a href="#a59bd681b9d4bfaa3141d9d96e05728a2">&#9670;&nbsp;</a></span>assertSize()</h2>
494+
495+
<div class="memitem">
496+
<div class="memproto">
497+
<div class="memtemplate">
498+
template&lt;int8_t NI, int8_t NF, uint64_t RANGE&gt; </div>
499+
<div class="memtemplate">
500+
template&lt;int8_t BITS&gt; </div>
501+
<table class="mlabels">
502+
<tr>
503+
<td class="mlabels-left">
504+
<table class="memname">
505+
<tr>
506+
<td class="memname">static constexpr void <a class="el" href="classSFix.html">SFix</a>&lt; NI, NF, RANGE &gt;::assertSize </td>
507+
<td>(</td>
508+
<td class="paramname"></td><td>)</td>
509+
<td></td>
510+
</tr>
511+
</table>
512+
</td>
513+
<td class="mlabels-right">
514+
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
515+
</tr>
516+
</table>
517+
</div><div class="memdoc">
518+
<p>Check wether this number exceeds the given total size in bits. See UFix::asssertSize().</p>
519+
<dl class="section note"><dt>Note</dt><dd>This function counts the number of bits needed, internally, and including the sign bit. E.g. SFix&lt;8,0&gt;::assertSize&lt;8&gt;() will fail, as it requires 9 bits, internally! </dd></dl>
520+
487521
</div>
488522
</div>
489523
<a id="a0ae56f253ada7f3b73756616eac13e91"></a>

‎docs/html/classUFix-members.html

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -71,26 +71,28 @@
7171
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#aeaabe601fa4fa53d39ef5026f644d36f">asFloat</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
7272
<tr><td class="entry"><a class="el" href="classUFix.html#a72bfc5596616a080c133a7075ba1815b">asInt</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
7373
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a390542b7d93844ec88b66c6827775e81">asRaw</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
74-
<tr><td class="entry"><a class="el" href="classUFix.html#ad3d368e0eca82acd2e8088d4fe6114af">asSFix</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
75-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#addb9e008fc41495e651b03c77aed89d0">fromRaw</a>(T raw)</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
76-
<tr><td class="entry"><a class="el" href="classUFix.html#a900f594b8b95f377fff38c49f5149866">getNF</a>()</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
77-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#aa17a66aaaeed2e67163f2bc8bbf2ce08">getNI</a>()</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
78-
<tr><td class="entry"><a class="el" href="classUFix.html#adfa277fb8de13ef075c2f01048b0b302">inv</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
79-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a85cbf1c2c1d3096dbe079b09feacebb0">invAccurate</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
80-
<tr><td class="entry"><a class="el" href="classUFix.html#aa958c40d69f0926ea9d0ee187ed16006">invFast</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
81-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a89807c8de3c6f82ef6c2f65b2903bc95">invFull</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
82-
<tr><td class="entry"><a class="el" href="classUFix.html#a170d50e511f622186082af600e069609">operator!=</a>(const UFix&lt; _NI, _NF &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
83-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a6bb3e48f7436f0ee2e282f572e5d5f29">operator*</a>(const UFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
84-
<tr><td class="entry"><a class="el" href="classUFix.html#aebc71b650e5420ce944c883b29bc87d0">operator*</a>(const SFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
85-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#af330f022002aab482606123e07ab29b0">operator+</a>(const UFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
86-
<tr><td class="entry"><a class="el" href="classUFix.html#ac898c28008d2208830d1641a1c4def9a">operator+</a>(const SFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
87-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#ab76aadf66641650f9a20eb534aba496e">operator-</a>(const UFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
88-
<tr><td class="entry"><a class="el" href="classUFix.html#a86c62691e5d5e9f080feeeada4e88075">operator-</a>(const SFix&lt; _NI, _NF, _RANGE &gt; &amp;op2) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
89-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a20414eb474cfb24b9c0da72ce507d5fe">operator-</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
90-
<tr><td class="entry"><a class="el" href="classUFix.html#a8a55813939a59bc8840315de126bfe50">operator&lt;</a>(const UFix&lt; _NI, _NF &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
91-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#ae66992644d158a7efeb8e521497a3a13">operator==</a>(const UFix&lt; _NI, _NF &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
92-
<tr><td class="entry"><a class="el" href="classUFix.html#addd4204bb434debae918c859da069012">operator&gt;</a>(const UFix&lt; _NI, _NF &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
93-
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a38e656ca44e325c3f384917d53a7882d">operator&gt;&gt;</a>(const int8_t op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
74+
<tr><td class="entry"><a class="el" href="classUFix.html#a4cce7ec1619e8b6d158e69ad437168c3">assertSize</a>()</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
75+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#ad3d368e0eca82acd2e8088d4fe6114af">asSFix</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
76+
<tr><td class="entry"><a class="el" href="classUFix.html#addb9e008fc41495e651b03c77aed89d0">fromRaw</a>(T raw)</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
77+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a900f594b8b95f377fff38c49f5149866">getNF</a>()</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
78+
<tr><td class="entry"><a class="el" href="classUFix.html#aa17a66aaaeed2e67163f2bc8bbf2ce08">getNI</a>()</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
79+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#adfa277fb8de13ef075c2f01048b0b302">inv</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
80+
<tr><td class="entry"><a class="el" href="classUFix.html#a85cbf1c2c1d3096dbe079b09feacebb0">invAccurate</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
81+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#aa958c40d69f0926ea9d0ee187ed16006">invFast</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
82+
<tr><td class="entry"><a class="el" href="classUFix.html#a89807c8de3c6f82ef6c2f65b2903bc95">invFull</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
83+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a170d50e511f622186082af600e069609">operator!=</a>(const UFix&lt; _NI, _NF &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
84+
<tr><td class="entry"><a class="el" href="classUFix.html#a6bb3e48f7436f0ee2e282f572e5d5f29">operator*</a>(const UFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
85+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#aebc71b650e5420ce944c883b29bc87d0">operator*</a>(const SFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
86+
<tr><td class="entry"><a class="el" href="classUFix.html#af330f022002aab482606123e07ab29b0">operator+</a>(const UFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
87+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#ac898c28008d2208830d1641a1c4def9a">operator+</a>(const SFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
88+
<tr><td class="entry"><a class="el" href="classUFix.html#ab76aadf66641650f9a20eb534aba496e">operator-</a>(const UFix&lt; _NI, _NF, _RANGE &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
89+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a86c62691e5d5e9f080feeeada4e88075">operator-</a>(const SFix&lt; _NI, _NF, _RANGE &gt; &amp;op2) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
90+
<tr><td class="entry"><a class="el" href="classUFix.html#a20414eb474cfb24b9c0da72ce507d5fe">operator-</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
91+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a8a55813939a59bc8840315de126bfe50">operator&lt;</a>(const UFix&lt; _NI, _NF &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
92+
<tr><td class="entry"><a class="el" href="classUFix.html#ae66992644d158a7efeb8e521497a3a13">operator==</a>(const UFix&lt; _NI, _NF &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
93+
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#addd4204bb434debae918c859da069012">operator&gt;</a>(const UFix&lt; _NI, _NF &gt; &amp;op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
94+
<tr><td class="entry"><a class="el" href="classUFix.html#a38e656ca44e325c3f384917d53a7882d">operator&gt;&gt;</a>(const int8_t op) const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
95+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>SFix</b> (defined in <a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a>)</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
9496
<tr><td class="entry"><a class="el" href="classUFix.html#add741555c674d50504ae2999080c80e1">sL</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
9597
<tr class="even"><td class="entry"><a class="el" href="classUFix.html#a9835b0be256af62795f14aa454a1ab0c">sR</a>() const</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
9698
<tr bgcolor="#f0f0f0"><td class="entry"><b>UFix</b> (defined in <a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a>)</td><td class="entry"><a class="el" href="classUFix.html">UFix&lt; NI, NF, RANGE &gt;</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>

0 commit comments

Comments
 (0)