Skip to content

Commit 5a78b44

Browse files
tomcombriattomcombriat
committed
Updated docs
1 parent bac1519 commit 5a78b44

7 files changed

Lines changed: 16 additions & 17 deletions

File tree

‎docs/html/FixMath_8h.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@
141141
<tr class="memitem:aaaaa1dc404829e0ec37bc565d58f394f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
142142
<tr class="memitem:aaaaa1dc404829e0ec37bc565d58f394f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classUFix.html">UFix</a>&lt; 0, sizeof(T) *8 &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="FixMath_8h.html#aaaaa1dc404829e0ec37bc565d58f394f">toUFraction</a> (T val)</td></tr>
143143
<tr class="separator:aaaaa1dc404829e0ec37bc565d58f394f"><td class="memSeparator" colspan="2">&#160;</td></tr>
144-
<tr class="memitem:a5160f5ab224e5424f6dd9e608db0dc9d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
145-
<tr class="memitem:a5160f5ab224e5424f6dd9e608db0dc9d"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classUFix.html">UFix</a>&lt; sizeof(T) *8-1, 0 &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="FixMath_8h.html#a5160f5ab224e5424f6dd9e608db0dc9d">toUInt</a> (T val)</td></tr>
146-
<tr class="separator:a5160f5ab224e5424f6dd9e608db0dc9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
144+
<tr class="memitem:aa2666bae0f50341fb0db86af1af47ec9"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
145+
<tr class="memitem:aa2666bae0f50341fb0db86af1af47ec9"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classUFix.html">UFix</a>&lt; sizeof(T) *8, 0 &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="FixMath_8h.html#aa2666bae0f50341fb0db86af1af47ec9">toUInt</a> (T val)</td></tr>
146+
<tr class="separator:aa2666bae0f50341fb0db86af1af47ec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
147147
<tr class="memitem:a83bdc57433394da979b73216f504a531"><td class="memTemplParams" colspan="2">template&lt;int8_t NI, int8_t NF, uint64_t RANGE, int8_t _NI, int8_t _NF, uint64_t _RANGE&gt; </td></tr>
148148
<tr class="memitem:a83bdc57433394da979b73216f504a531"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classSFix.html">SFix</a>&lt; FixMathPrivate::neededSNIExtra(FixMathPrivate::FM_max(NI, _NI), FixMathPrivate::FM_max(NF, _NF), FixMathPrivate::rangeAdd(NF, _NF, RANGE, _RANGE)), FixMathPrivate::FM_max(NF, _NF), FixMathPrivate::rangeAdd(NF, _NF, RANGE, _RANGE)&gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="FixMath_8h.html#a83bdc57433394da979b73216f504a531">operator+</a> (const <a class="el" href="classSFix.html">SFix</a>&lt; NI, NF, RANGE &gt; &amp;op1, const <a class="el" href="classUFix.html">UFix</a>&lt; _NI, _NF, _RANGE &gt; &amp;op2)</td></tr>
149149
<tr class="separator:a83bdc57433394da979b73216f504a531"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -890,8 +890,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#aaaaa1dc404829e0ec37bc565
890890

891891
</div>
892892
</div>
893-
<a id="a5160f5ab224e5424f6dd9e608db0dc9d"></a>
894-
<h2 class="memtitle"><span class="permalink"><a href="#a5160f5ab224e5424f6dd9e608db0dc9d">&#9670;&nbsp;</a></span>toUInt()</h2>
893+
<a id="aa2666bae0f50341fb0db86af1af47ec9"></a>
894+
<h2 class="memtitle"><span class="permalink"><a href="#aa2666bae0f50341fb0db86af1af47ec9">&#9670;&nbsp;</a></span>toUInt()</h2>
895895

896896
<div class="memitem">
897897
<div class="memproto">
@@ -902,7 +902,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5160f5ab224e5424f6dd9e60
902902
<td class="mlabels-left">
903903
<table class="memname">
904904
<tr>
905-
<td class="memname"><a class="el" href="classUFix.html">UFix</a>&lt;sizeof(T)*8-1,0&gt; toUInt </td>
905+
<td class="memname"><a class="el" href="classUFix.html">UFix</a>&lt;sizeof(T)*8,0&gt; toUInt </td>
906906
<td>(</td>
907907
<td class="paramtype">T&#160;</td>
908908
<td class="paramname"><em>val</em></td><td>)</td>

‎docs/html/FixMath_8h_source.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -465,8 +465,8 @@
465465
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span>&#160;<span class="stringliteral">}</span></div>
466466
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span>&#160;<span class="stringliteral"></span> </div>
467467
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span>&#160;<span class="stringliteral">template&lt;typename T&gt;</span></div>
468-
<div class="line"><a name="l00652"></a><span class="lineno"><a class="line" href="FixMath_8h.html#a5160f5ab224e5424f6dd9e608db0dc9d"> 652</a></span>&#160;<span class="stringliteral">inline UFix&lt;sizeof(T)*8-1,0&gt; toUInt(T val) {</span></div>
469-
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>&#160;<span class="stringliteral"> return UFix&lt;sizeof(T)*8-1,0&gt;::fromRaw(val); </span></div>
468+
<div class="line"><a name="l00652"></a><span class="lineno"><a class="line" href="FixMath_8h.html#aa2666bae0f50341fb0db86af1af47ec9"> 652</a></span>&#160;<span class="stringliteral">inline UFix&lt;sizeof(T)*8,0&gt; toUInt(T val) {</span></div>
469+
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span>&#160;<span class="stringliteral"> return UFix&lt;sizeof(T)*8,0&gt;::fromRaw(val); </span></div>
470470
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span>&#160;<span class="stringliteral">}</span></div>
471471
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span>&#160;<span class="stringliteral"></span> </div>
472472
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span>&#160;<span class="stringliteral"></span> </div>

‎docs/html/globals.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
: <a class="el" href="FixMath_8h.html#aaaaa1dc404829e0ec37bc565d58f394f">FixMath.h</a>
9494
</li>
9595
<li>toUInt()
96-
: <a class="el" href="FixMath_8h.html#a5160f5ab224e5424f6dd9e608db0dc9d">FixMath.h</a>
96+
: <a class="el" href="FixMath_8h.html#aa2666bae0f50341fb0db86af1af47ec9">FixMath.h</a>
9797
</li>
9898
</ul>
9999
</div><!-- contents -->

‎docs/html/globals_func.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
: <a class="el" href="FixMath_8h.html#aaaaa1dc404829e0ec37bc565d58f394f">FixMath.h</a>
9494
</li>
9595
<li>toUInt()
96-
: <a class="el" href="FixMath_8h.html#a5160f5ab224e5424f6dd9e608db0dc9d">FixMath.h</a>
96+
: <a class="el" href="FixMath_8h.html#aa2666bae0f50341fb0db86af1af47ec9">FixMath.h</a>
9797
</li>
9898
</ul>
9999
</div><!-- contents -->

‎docs/html/search/all_6.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ var searchData=
33
['tosfraction_30',['toSFraction',['../FixMath_8h.html#a46b90b067252e2ceeed03c96ccc55fd4',1,'FixMath.h']]],
44
['tosint_31',['toSInt',['../FixMath_8h.html#a83bd22fe181cddcf4c3faacbe86140fa',1,'FixMath.h']]],
55
['toufraction_32',['toUFraction',['../FixMath_8h.html#aaaaa1dc404829e0ec37bc565d58f394f',1,'FixMath.h']]],
6-
['touint_33',['toUInt',['../FixMath_8h.html#a5160f5ab224e5424f6dd9e608db0dc9d',1,'FixMath.h']]]
6+
['touint_33',['toUInt',['../FixMath_8h.html#aa2666bae0f50341fb0db86af1af47ec9',1,'FixMath.h']]]
77
];

‎docs/html/search/functions_6.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ var searchData=
33
['tosfraction_67',['toSFraction',['../FixMath_8h.html#a46b90b067252e2ceeed03c96ccc55fd4',1,'FixMath.h']]],
44
['tosint_68',['toSInt',['../FixMath_8h.html#a83bd22fe181cddcf4c3faacbe86140fa',1,'FixMath.h']]],
55
['toufraction_69',['toUFraction',['../FixMath_8h.html#aaaaa1dc404829e0ec37bc565d58f394f',1,'FixMath.h']]],
6-
['touint_70',['toUInt',['../FixMath_8h.html#a5160f5ab224e5424f6dd9e608db0dc9d',1,'FixMath.h']]]
6+
['touint_70',['toUInt',['../FixMath_8h.html#aa2666bae0f50341fb0db86af1af47ec9',1,'FixMath.h']]]
77
];

‎docs/latex/FixMath_8h.tex‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
\label{FixMath_8h}\index{FixMath.h@{FixMath.h}}
33
{\ttfamily \#include $<$Arduino.\+h$>$}\newline
44
{\ttfamily \#include \char`\"{}Integer\+Type.\+h\char`\"{}}\newline
5-
Include dependency graph for Fix\+Math.\+h\+:
6-
\nopagebreak
5+
Include dependency graph for Fix\+Math.\+h\+:\nopagebreak
76
\begin{figure}[H]
87
\begin{center}
98
\leavevmode
@@ -60,7 +59,7 @@
6059
\item
6160
{\footnotesize template$<$typename T $>$ }\\\mbox{\hyperlink{classUFix}{UFix}}$<$ 0, sizeof(T) $\ast$8 $>$ \mbox{\hyperlink{FixMath_8h_aaaaa1dc404829e0ec37bc565d58f394f}{to\+UFraction}} (T val)
6261
\item
63-
{\footnotesize template$<$typename T $>$ }\\\mbox{\hyperlink{classUFix}{UFix}}$<$ sizeof(T) $\ast$8-\/1, 0 $>$ \mbox{\hyperlink{FixMath_8h_a5160f5ab224e5424f6dd9e608db0dc9d}{to\+UInt}} (T val)
62+
{\footnotesize template$<$typename T $>$ }\\\mbox{\hyperlink{classUFix}{UFix}}$<$ sizeof(T) $\ast$8, 0 $>$ \mbox{\hyperlink{FixMath_8h_aa2666bae0f50341fb0db86af1af47ec9}{to\+UInt}} (T val)
6463
\item
6564
{\footnotesize template$<$int8\+\_\+t NI, int8\+\_\+t NF, uint64\+\_\+t RANGE, int8\+\_\+t \+\_\+\+NI, int8\+\_\+t \+\_\+\+NF, uint64\+\_\+t \+\_\+\+RANGE$>$ }\\\mbox{\hyperlink{classSFix}{SFix}}$<$ Fix\+Math\+Private\+::needed\+SNIExtra(Fix\+Math\+Private\+::\+FM\+\_\+max(NI, \+\_\+\+NI), Fix\+Math\+Private\+::\+FM\+\_\+max(NF, \+\_\+\+NF), Fix\+Math\+Private\+::range\+Add(NF, \+\_\+\+NF, RANGE, \+\_\+\+RANGE)), Fix\+Math\+Private\+::\+FM\+\_\+max(NF, \+\_\+\+NF), Fix\+Math\+Private\+::range\+Add(NF, \+\_\+\+NF, RANGE, \+\_\+\+RANGE)$>$ \mbox{\hyperlink{FixMath_8h_a83bdc57433394da979b73216f504a531}{operator+}} (const \mbox{\hyperlink{classSFix}{SFix}}$<$ NI, NF, RANGE $>$ \&op1, const \mbox{\hyperlink{classUFix}{UFix}}$<$ \+\_\+\+NI, \+\_\+\+NF, \+\_\+\+RANGE $>$ \&op2)
6665
\item
@@ -428,12 +427,12 @@
428427
\begin{DoxyReturn}{Returns}
429428
A UFix$<$0,\+NF$>$ with NF chosen according to the input type
430429
\end{DoxyReturn}
431-
\mbox{\Hypertarget{FixMath_8h_a5160f5ab224e5424f6dd9e608db0dc9d}\label{FixMath_8h_a5160f5ab224e5424f6dd9e608db0dc9d}}
430+
\mbox{\Hypertarget{FixMath_8h_aa2666bae0f50341fb0db86af1af47ec9}\label{FixMath_8h_aa2666bae0f50341fb0db86af1af47ec9}}
432431
\index{FixMath.h@{FixMath.h}!toUInt@{toUInt}}
433432
\index{toUInt@{toUInt}!FixMath.h@{FixMath.h}}
434433
\doxysubsubsection{\texorpdfstring{toUInt()}{toUInt()}}
435434
{\footnotesize\ttfamily template$<$typename T $>$ \\
436-
\mbox{\hyperlink{classUFix}{UFix}}$<$sizeof(T)$\ast$8-\/1,0$>$ to\+UInt (\begin{DoxyParamCaption}\item[{T}]{val }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
435+
\mbox{\hyperlink{classUFix}{UFix}}$<$sizeof(T)$\ast$8,0$>$ to\+UInt (\begin{DoxyParamCaption}\item[{T}]{val }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
437436

438437
Create a {\itshape pure} integer unsigned fixed number (\mbox{\hyperlink{classUFix}{UFix}}) from an unsigned integer. The number of fractional bits (NI) is chosen automatically depending on the input type. Hence to\+UInt(255) and to\+UInt(uint8\+\_\+t(255)) {\itshape do not} lead to the same thing\+: on an AVR, the former will lead to NI=16 -\/ which is overkill -\/ whereas the latter will lead to NI=8. Mozzi\textquotesingle{}s objects (Oscil and the like) returns correct types, hence you can use this function to convert the return value of a Mozzi\textquotesingle{}s function/class member into a pure fractional number.
439438
\begin{DoxyParams}{Parameters}

0 commit comments

Comments
 (0)