review.tizen.org Git - platform/upstream/armcl.git/blob

   1 <!-- HTML header for doxygen 1.8.9.1-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7 <meta name="generator" content="Doxygen 1.8.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: constant_expr&lt; T &gt; Struct Template Reference</title>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <script type="text/javascript" src="jquery.js"></script>
  12 <script type="text/javascript" src="dynsections.js"></script>
  13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="resize.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18   $(window).load(resizeHeight);
  19 </script>
  20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(function() { searchBox.OnSelectItem(0); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.09</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  48 <!-- end header part -->
  49 <!-- Generated by Doxygen 1.8.6 -->
  50 <script type="text/javascript">
  51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  67           <input type="text" id="MSearchField" value="Search" accesskey="S"
  68                onfocus="searchBox.OnSearchFieldFocus(true)"
  69                onblur="searchBox.OnSearchFieldFocus(false)"
  70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  71           </span><span class="right">
  72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml','');});
  99 </script>
 100 <div id="doc-content">
 101 <!-- window showing the filter options -->
 102 <div id="MSearchSelectWindow"
 103      onmouseover="return searchBox.OnSearchSelectShow()"
 104      onmouseout="return searchBox.OnSearchSelectHide()"
 105      onkeydown="return searchBox.OnSearchSelectKey(event)">
 106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 108 <!-- iframe showing the search results (closed by default) -->
 109 <div id="MSearchResultsWindow">
 110 <iframe src="javascript:void(0)" frameborder="0"
 111         name="MSearchResults" id="MSearchResults">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
 118   <div class="headertitle">
 119 <div class="title">constant_expr&lt; T &gt; Struct Template Reference</div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p><code>#include &lt;<a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a>&gt;</code></p>
 124 <table class="memberdecls">
 125 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 126 Static Public Member Functions</h2></td></tr>
 127 <tr class="memitem:a9c4b593f19fb9053fd52697eaa30c5d7"><td class="memItemLeft" align="right" valign="top">static constexpr T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a9c4b593f19fb9053fd52697eaa30c5d7">fixed_one</a> (uint8_t p)</td></tr>
 128 <tr class="memdesc:a9c4b593f19fb9053fd52697eaa30c5d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate representation of 1 in fixed point given a fixed point precision.  <a href="#a9c4b593f19fb9053fd52697eaa30c5d7">More...</a><br/></td></tr>
 129 <tr class="separator:a9c4b593f19fb9053fd52697eaa30c5d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 <tr class="memitem:a125e978e1d6df0f6d9f738b0c580f980"><td class="memItemLeft" align="right" valign="top">static constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a125e978e1d6df0f6d9f738b0c580f980">fixed_step</a> (uint8_t p)</td></tr>
 131 <tr class="memdesc:a125e978e1d6df0f6d9f738b0c580f980"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate fixed point precision step given a fixed point precision.  <a href="#a125e978e1d6df0f6d9f738b0c580f980">More...</a><br/></td></tr>
 132 <tr class="separator:a125e978e1d6df0f6d9f738b0c580f980"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:a995c73a5ff995cc1b4c0c730892c792a"><td class="memItemLeft" align="right" valign="top">static constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a995c73a5ff995cc1b4c0c730892c792a">to_float</a> (T val, uint8_t p)</td></tr>
 134 <tr class="memdesc:a995c73a5ff995cc1b4c0c730892c792a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a fixed point value to float given its precision.  <a href="#a995c73a5ff995cc1b4c0c730892c792a">More...</a><br/></td></tr>
 135 <tr class="separator:a995c73a5ff995cc1b4c0c730892c792a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 <tr class="memitem:a918ab57096fdfe5e2cbf70de5145b9fa"><td class="memItemLeft" align="right" valign="top">static constexpr T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a918ab57096fdfe5e2cbf70de5145b9fa">to_int</a> (T val, uint8_t p)</td></tr>
 137 <tr class="memdesc:a918ab57096fdfe5e2cbf70de5145b9fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a fixed point value to integer given its precision.  <a href="#a918ab57096fdfe5e2cbf70de5145b9fa">More...</a><br/></td></tr>
 138 <tr class="separator:a918ab57096fdfe5e2cbf70de5145b9fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a682a2eb8869b48647719e194cbbcb4e1"><td class="memItemLeft" align="right" valign="top">static constexpr T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a682a2eb8869b48647719e194cbbcb4e1">to_fixed</a> (float val, uint8_t p)</td></tr>
 140 <tr class="memdesc:a682a2eb8869b48647719e194cbbcb4e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a single precision floating point value to a fixed point representation given its precision.  <a href="#a682a2eb8869b48647719e194cbbcb4e1">More...</a><br/></td></tr>
 141 <tr class="separator:a682a2eb8869b48647719e194cbbcb4e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:a996cf0a2779076326d094ef9d75ddd1f"><td class="memItemLeft" align="right" valign="top">static constexpr T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a996cf0a2779076326d094ef9d75ddd1f">clamp</a> (T val, T <a class="el" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#aabcf39e3917f842dbc5fbb0d802f24d5">min</a>, T <a class="el" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#ad91bb73431b4de1f4946ed949d444849">max</a>)</td></tr>
 143 <tr class="memdesc:a996cf0a2779076326d094ef9d75ddd1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clamp value between two ranges.  <a href="#a996cf0a2779076326d094ef9d75ddd1f">More...</a><br/></td></tr>
 144 <tr class="separator:a996cf0a2779076326d094ef9d75ddd1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:a59cfd98dfc03fbc5540092aa196d7187"><td class="memTemplParams" colspan="2">template&lt;typename U &gt; </td></tr>
 146 <tr class="memitem:a59cfd98dfc03fbc5540092aa196d7187"><td class="memTemplItemLeft" align="right" valign="top">static constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a59cfd98dfc03fbc5540092aa196d7187">saturate_cast</a> (U val)</td></tr>
 147 <tr class="memdesc:a59cfd98dfc03fbc5540092aa196d7187"><td class="mdescLeft">&#160;</td><td class="mdescRight">Saturate given number.  <a href="#a59cfd98dfc03fbc5540092aa196d7187">More...</a><br/></td></tr>
 148 <tr class="separator:a59cfd98dfc03fbc5540092aa196d7187"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 </table>
 150 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 151 <div class="textblock"><h3>template&lt;typename T&gt;<br/>
 152 struct arm_compute::test::fixed_point_arithmetic::detail::constant_expr&lt; T &gt;</h3>
 153
 154
 155 <p>Definition at line <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00048">48</a> of file <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a>.</p>
 156 </div><h2 class="groupheader">Member Function Documentation</h2>
 157 <a class="anchor" id="a996cf0a2779076326d094ef9d75ddd1f"></a>
 158 <div class="memitem">
 159 <div class="memproto">
 160 <table class="mlabels">
 161   <tr>
 162   <td class="mlabels-left">
 163       <table class="memname">
 164         <tr>
 165           <td class="memname">static constexpr T clamp </td>
 166           <td>(</td>
 167           <td class="paramtype">T&#160;</td>
 168           <td class="paramname"><em>val</em>, </td>
 169         </tr>
 170         <tr>
 171           <td class="paramkey"></td>
 172           <td></td>
 173           <td class="paramtype">T&#160;</td>
 174           <td class="paramname"><em>min</em>, </td>
 175         </tr>
 176         <tr>
 177           <td class="paramkey"></td>
 178           <td></td>
 179           <td class="paramtype">T&#160;</td>
 180           <td class="paramname"><em>max</em>&#160;</td>
 181         </tr>
 182         <tr>
 183           <td></td>
 184           <td>)</td>
 185           <td></td><td></td>
 186         </tr>
 187       </table>
 188   </td>
 189   <td class="mlabels-right">
 190 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 191   </tr>
 192 </table>
 193 </div><div class="memdoc">
 194
 195 <p>Clamp value between two ranges. </p>
 196 <dl class="params"><dt>Parameters</dt><dd>
 197   <table class="params">
 198     <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>Value to clamp </td></tr>
 199     <tr><td class="paramdir">[in]</td><td class="paramname">min</td><td>Minimum value to clamp to </td></tr>
 200     <tr><td class="paramdir">[in]</td><td class="paramname">max</td><td>Maximum value to clamp to</td></tr>
 201   </table>
 202   </dd>
 203 </dl>
 204 <dl class="section return"><dt>Returns</dt><dd>clamped value </dd></dl>
 205
 206 <p>Definition at line <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00349">349</a> of file <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a>.</p>
 207
 208 <p>References <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00889">arm_compute::test::fixed_point_arithmetic::detail::max()</a>, and <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00884">arm_compute::test::fixed_point_arithmetic::detail::min()</a>.</p>
 209
 210 <p>Referenced by <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00498">functions::clamp()</a>.</p>
 211 <div class="fragment"><div class="line"><a name="l00350"></a><span class="lineno">  350</span>&#160;    {</div>
 212 <div class="line"><a name="l00351"></a><span class="lineno">  351</span>&#160;        <span class="keywordflow">return</span> <a class="code" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#aabcf39e3917f842dbc5fbb0d802f24d5">std::min</a>(<a class="code" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#ad91bb73431b4de1f4946ed949d444849">std::max</a>(val, <a class="code" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#aabcf39e3917f842dbc5fbb0d802f24d5">min</a>), <a class="code" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#ad91bb73431b4de1f4946ed949d444849">max</a>);</div>
 213 <div class="line"><a name="l00352"></a><span class="lineno">  352</span>&#160;    }</div>
 214 <div class="ttc" id="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_xhtml_aabcf39e3917f842dbc5fbb0d802f24d5"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#aabcf39e3917f842dbc5fbb0d802f24d5">arm_compute::test::fixed_point_arithmetic::detail::min</a></div><div class="ttdeci">fixed_point&lt; T &gt; min(fixed_point&lt; T &gt; x, fixed_point&lt; T &gt; y)</div><div class="ttdef"><b>Definition:</b> <a href="tests_2validation_2_fixed_point_8h_source.xhtml#l00884">FixedPoint.h:884</a></div></div>
 215 <div class="ttc" id="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_xhtml_ad91bb73431b4de1f4946ed949d444849"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#ad91bb73431b4de1f4946ed949d444849">arm_compute::test::fixed_point_arithmetic::detail::max</a></div><div class="ttdeci">fixed_point&lt; T &gt; max(fixed_point&lt; T &gt; x, fixed_point&lt; T &gt; y)</div><div class="ttdef"><b>Definition:</b> <a href="tests_2validation_2_fixed_point_8h_source.xhtml#l00889">FixedPoint.h:889</a></div></div>
 216 </div><!-- fragment -->
 217 </div>
 218 </div>
 219 <a class="anchor" id="a9c4b593f19fb9053fd52697eaa30c5d7"></a>
 220 <div class="memitem">
 221 <div class="memproto">
 222 <table class="mlabels">
 223   <tr>
 224   <td class="mlabels-left">
 225       <table class="memname">
 226         <tr>
 227           <td class="memname">static constexpr T fixed_one </td>
 228           <td>(</td>
 229           <td class="paramtype">uint8_t&#160;</td>
 230           <td class="paramname"><em>p</em></td><td>)</td>
 231           <td></td>
 232         </tr>
 233       </table>
 234   </td>
 235   <td class="mlabels-right">
 236 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 237   </tr>
 238 </table>
 239 </div><div class="memdoc">
 240
 241 <p>Calculate representation of 1 in fixed point given a fixed point precision. </p>
 242 <dl class="params"><dt>Parameters</dt><dd>
 243   <table class="params">
 244     <tr><td class="paramdir">[in]</td><td class="paramname">p</td><td>Fixed point precision</td></tr>
 245   </table>
 246   </dd>
 247 </dl>
 248 <dl class="section return"><dt>Returns</dt><dd>Representation of value 1 in fixed point. </dd></dl>
 249
 250 <p>Definition at line <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00293">293</a> of file <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a>.</p>
 251
 252 <p>Referenced by <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00337">constant_expr&lt; T &gt;::to_fixed()</a>.</p>
 253 <div class="fragment"><div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;    {</div>
 254 <div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;        <span class="keywordflow">return</span> (1 &lt;&lt; p);</div>
 255 <div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;    }</div>
 256 </div><!-- fragment -->
 257 </div>
 258 </div>
 259 <a class="anchor" id="a125e978e1d6df0f6d9f738b0c580f980"></a>
 260 <div class="memitem">
 261 <div class="memproto">
 262 <table class="mlabels">
 263   <tr>
 264   <td class="mlabels-left">
 265       <table class="memname">
 266         <tr>
 267           <td class="memname">static constexpr float fixed_step </td>
 268           <td>(</td>
 269           <td class="paramtype">uint8_t&#160;</td>
 270           <td class="paramname"><em>p</em></td><td>)</td>
 271           <td></td>
 272         </tr>
 273       </table>
 274   </td>
 275   <td class="mlabels-right">
 276 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 277   </tr>
 278 </table>
 279 </div><div class="memdoc">
 280
 281 <p>Calculate fixed point precision step given a fixed point precision. </p>
 282 <dl class="params"><dt>Parameters</dt><dd>
 283   <table class="params">
 284     <tr><td class="paramdir">[in]</td><td class="paramname">p</td><td>Fixed point precision</td></tr>
 285   </table>
 286   </dd>
 287 </dl>
 288 <dl class="section return"><dt>Returns</dt><dd>Fixed point precision step </dd></dl>
 289
 290 <p>Definition at line <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00303">303</a> of file <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a>.</p>
 291
 292 <p>Referenced by <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00315">constant_expr&lt; T &gt;::to_float()</a>.</p>
 293 <div class="fragment"><div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;    {</div>
 294 <div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;        <span class="keywordflow">return</span> (1.0f / static_cast&lt;float&gt;(1 &lt;&lt; p));</div>
 295 <div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;    }</div>
 296 </div><!-- fragment -->
 297 </div>
 298 </div>
 299 <a class="anchor" id="a59cfd98dfc03fbc5540092aa196d7187"></a>
 300 <div class="memitem">
 301 <div class="memproto">
 302 <table class="mlabels">
 303   <tr>
 304   <td class="mlabels-left">
 305       <table class="memname">
 306         <tr>
 307           <td class="memname">static constexpr T saturate_cast </td>
 308           <td>(</td>
 309           <td class="paramtype">U&#160;</td>
 310           <td class="paramname"><em>val</em></td><td>)</td>
 311           <td></td>
 312         </tr>
 313       </table>
 314   </td>
 315   <td class="mlabels-right">
 316 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 317   </tr>
 318 </table>
 319 </div><div class="memdoc">
 320
 321 <p>Saturate given number. </p>
 322 <dl class="params"><dt>Parameters</dt><dd>
 323   <table class="params">
 324     <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>Value to saturate</td></tr>
 325   </table>
 326   </dd>
 327 </dl>
 328 <dl class="section return"><dt>Returns</dt><dd>Saturated value </dd></dl>
 329
 330 <p>Definition at line <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00360">360</a> of file <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a>.</p>
 331
 332 <p>References <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00889">arm_compute::test::fixed_point_arithmetic::detail::max()</a>, <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00884">arm_compute::test::fixed_point_arithmetic::detail::min()</a>, and <a class="el" href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455aa4c614360da93c0a041b22e537de151eb">arm_compute::U</a>.</p>
 333
 334 <p>Referenced by <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00527">functions::add()</a>, <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00598">functions::div()</a>, <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00099">fixed_point&lt; T &gt;::fixed_point()</a>, <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00577">functions::mul()</a>, <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00509">functions::negate()</a>, <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00184">fixed_point&lt; T &gt;::operator fixed_point&lt; U &gt;()</a>, <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00241">fixed_point&lt; T &gt;::rescale()</a>, <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00626">functions::shift_left()</a>, <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00552">functions::sub()</a>, and <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00337">constant_expr&lt; T &gt;::to_fixed()</a>.</p>
 335 <div class="fragment"><div class="line"><a name="l00361"></a><span class="lineno">  361</span>&#160;    {</div>
 336 <div class="line"><a name="l00362"></a><span class="lineno">  362</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>T<span class="keyword">&gt;</span>(std::min&lt;U&gt;(std::max&lt;U&gt;(val, <span class="keyword">static_cast&lt;</span><a class="code" href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455aa4c614360da93c0a041b22e537de151eb">U</a><span class="keyword">&gt;</span>(<a class="code" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#aabcf39e3917f842dbc5fbb0d802f24d5">std::numeric_limits&lt;T&gt;::min</a>())), <span class="keyword">static_cast&lt;</span><a class="code" href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455aa4c614360da93c0a041b22e537de151eb">U</a><span class="keyword">&gt;</span>(<a class="code" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#ad91bb73431b4de1f4946ed949d444849">std::numeric_limits&lt;T&gt;::max</a>())));</div>
 337 <div class="line"><a name="l00363"></a><span class="lineno">  363</span>&#160;    }</div>
 338 <div class="ttc" id="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_xhtml_aabcf39e3917f842dbc5fbb0d802f24d5"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#aabcf39e3917f842dbc5fbb0d802f24d5">arm_compute::test::fixed_point_arithmetic::detail::min</a></div><div class="ttdeci">fixed_point&lt; T &gt; min(fixed_point&lt; T &gt; x, fixed_point&lt; T &gt; y)</div><div class="ttdef"><b>Definition:</b> <a href="tests_2validation_2_fixed_point_8h_source.xhtml#l00884">FixedPoint.h:884</a></div></div>
 339 <div class="ttc" id="namespacearm__compute_xhtml_a1ce9b523fd4f3b5bbcadcd796183455aa4c614360da93c0a041b22e537de151eb"><div class="ttname"><a href="namespacearm__compute.xhtml#a1ce9b523fd4f3b5bbcadcd796183455aa4c614360da93c0a041b22e537de151eb">arm_compute::Channel::U</a></div><div class="ttdoc">Cb/U channel. </div></div>
 340 <div class="ttc" id="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_xhtml_ad91bb73431b4de1f4946ed949d444849"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml#ad91bb73431b4de1f4946ed949d444849">arm_compute::test::fixed_point_arithmetic::detail::max</a></div><div class="ttdeci">fixed_point&lt; T &gt; max(fixed_point&lt; T &gt; x, fixed_point&lt; T &gt; y)</div><div class="ttdef"><b>Definition:</b> <a href="tests_2validation_2_fixed_point_8h_source.xhtml#l00889">FixedPoint.h:889</a></div></div>
 341 </div><!-- fragment -->
 342 </div>
 343 </div>
 344 <a class="anchor" id="a682a2eb8869b48647719e194cbbcb4e1"></a>
 345 <div class="memitem">
 346 <div class="memproto">
 347 <table class="mlabels">
 348   <tr>
 349   <td class="mlabels-left">
 350       <table class="memname">
 351         <tr>
 352           <td class="memname">static constexpr T to_fixed </td>
 353           <td>(</td>
 354           <td class="paramtype">float&#160;</td>
 355           <td class="paramname"><em>val</em>, </td>
 356         </tr>
 357         <tr>
 358           <td class="paramkey"></td>
 359           <td></td>
 360           <td class="paramtype">uint8_t&#160;</td>
 361           <td class="paramname"><em>p</em>&#160;</td>
 362         </tr>
 363         <tr>
 364           <td></td>
 365           <td>)</td>
 366           <td></td><td></td>
 367         </tr>
 368       </table>
 369   </td>
 370   <td class="mlabels-right">
 371 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 372   </tr>
 373 </table>
 374 </div><div class="memdoc">
 375
 376 <p>Convert a single precision floating point value to a fixed point representation given its precision. </p>
 377 <dl class="params"><dt>Parameters</dt><dd>
 378   <table class="params">
 379     <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>Floating point value </td></tr>
 380     <tr><td class="paramdir">[in]</td><td class="paramname">p</td><td>Fixed point precision</td></tr>
 381   </table>
 382   </dd>
 383 </dl>
 384 <dl class="section return"><dt>Returns</dt><dd>The raw fixed point representation </dd></dl>
 385
 386 <p>Definition at line <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00337">337</a> of file <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a>.</p>
 387
 388 <p>References <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00293">constant_expr&lt; T &gt;::fixed_one()</a>, and <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00360">constant_expr&lt; T &gt;::saturate_cast()</a>.</p>
 389 <div class="fragment"><div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;    {</div>
 390 <div class="line"><a name="l00339"></a><span class="lineno">  339</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>T<span class="keyword">&gt;</span>(<a class="code" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a59cfd98dfc03fbc5540092aa196d7187">saturate_cast</a>&lt;<span class="keywordtype">float</span>&gt;(val * <a class="code" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a9c4b593f19fb9053fd52697eaa30c5d7">fixed_one</a>(p) + ((val &gt;= 0) ? 0.5 : -0.5)));</div>
 391 <div class="line"><a name="l00340"></a><span class="lineno">  340</span>&#160;    }</div>
 392 <div class="ttc" id="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr_xhtml_a9c4b593f19fb9053fd52697eaa30c5d7"><div class="ttname"><a href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a9c4b593f19fb9053fd52697eaa30c5d7">arm_compute::test::fixed_point_arithmetic::detail::constant_expr::fixed_one</a></div><div class="ttdeci">static constexpr T fixed_one(uint8_t p)</div><div class="ttdoc">Calculate representation of 1 in fixed point given a fixed point precision. </div><div class="ttdef"><b>Definition:</b> <a href="tests_2validation_2_fixed_point_8h_source.xhtml#l00293">FixedPoint.h:293</a></div></div>
 393 <div class="ttc" id="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr_xhtml_a59cfd98dfc03fbc5540092aa196d7187"><div class="ttname"><a href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a59cfd98dfc03fbc5540092aa196d7187">arm_compute::test::fixed_point_arithmetic::detail::constant_expr::saturate_cast</a></div><div class="ttdeci">static constexpr T saturate_cast(U val)</div><div class="ttdoc">Saturate given number. </div><div class="ttdef"><b>Definition:</b> <a href="tests_2validation_2_fixed_point_8h_source.xhtml#l00360">FixedPoint.h:360</a></div></div>
 394 </div><!-- fragment -->
 395 </div>
 396 </div>
 397 <a class="anchor" id="a995c73a5ff995cc1b4c0c730892c792a"></a>
 398 <div class="memitem">
 399 <div class="memproto">
 400 <table class="mlabels">
 401   <tr>
 402   <td class="mlabels-left">
 403       <table class="memname">
 404         <tr>
 405           <td class="memname">static constexpr float to_float </td>
 406           <td>(</td>
 407           <td class="paramtype">T&#160;</td>
 408           <td class="paramname"><em>val</em>, </td>
 409         </tr>
 410         <tr>
 411           <td class="paramkey"></td>
 412           <td></td>
 413           <td class="paramtype">uint8_t&#160;</td>
 414           <td class="paramname"><em>p</em>&#160;</td>
 415         </tr>
 416         <tr>
 417           <td></td>
 418           <td>)</td>
 419           <td></td><td></td>
 420         </tr>
 421       </table>
 422   </td>
 423   <td class="mlabels-right">
 424 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 425   </tr>
 426 </table>
 427 </div><div class="memdoc">
 428
 429 <p>Convert a fixed point value to float given its precision. </p>
 430 <dl class="params"><dt>Parameters</dt><dd>
 431   <table class="params">
 432     <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>Fixed point value </td></tr>
 433     <tr><td class="paramdir">[in]</td><td class="paramname">p</td><td>Fixed point precision</td></tr>
 434   </table>
 435   </dd>
 436 </dl>
 437 <dl class="section return"><dt>Returns</dt><dd>Float representation of the fixed point number </dd></dl>
 438
 439 <p>Definition at line <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00315">315</a> of file <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a>.</p>
 440
 441 <p>References <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00303">constant_expr&lt; T &gt;::fixed_step()</a>.</p>
 442
 443 <p>Referenced by <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00166">fixed_point&lt; T &gt;::operator float()</a>.</p>
 444 <div class="fragment"><div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;    {</div>
 445 <div class="line"><a name="l00317"></a><span class="lineno">  317</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">float</span><span class="keyword">&gt;</span>(val * <a class="code" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a125e978e1d6df0f6d9f738b0c580f980">fixed_step</a>(p));</div>
 446 <div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;    }</div>
 447 <div class="ttc" id="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr_xhtml_a125e978e1d6df0f6d9f738b0c580f980"><div class="ttname"><a href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml#a125e978e1d6df0f6d9f738b0c580f980">arm_compute::test::fixed_point_arithmetic::detail::constant_expr::fixed_step</a></div><div class="ttdeci">static constexpr float fixed_step(uint8_t p)</div><div class="ttdoc">Calculate fixed point precision step given a fixed point precision. </div><div class="ttdef"><b>Definition:</b> <a href="tests_2validation_2_fixed_point_8h_source.xhtml#l00303">FixedPoint.h:303</a></div></div>
 448 </div><!-- fragment -->
 449 </div>
 450 </div>
 451 <a class="anchor" id="a918ab57096fdfe5e2cbf70de5145b9fa"></a>
 452 <div class="memitem">
 453 <div class="memproto">
 454 <table class="mlabels">
 455   <tr>
 456   <td class="mlabels-left">
 457       <table class="memname">
 458         <tr>
 459           <td class="memname">static constexpr T to_int </td>
 460           <td>(</td>
 461           <td class="paramtype">T&#160;</td>
 462           <td class="paramname"><em>val</em>, </td>
 463         </tr>
 464         <tr>
 465           <td class="paramkey"></td>
 466           <td></td>
 467           <td class="paramtype">uint8_t&#160;</td>
 468           <td class="paramname"><em>p</em>&#160;</td>
 469         </tr>
 470         <tr>
 471           <td></td>
 472           <td>)</td>
 473           <td></td><td></td>
 474         </tr>
 475       </table>
 476   </td>
 477   <td class="mlabels-right">
 478 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
 479   </tr>
 480 </table>
 481 </div><div class="memdoc">
 482
 483 <p>Convert a fixed point value to integer given its precision. </p>
 484 <dl class="params"><dt>Parameters</dt><dd>
 485   <table class="params">
 486     <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>Fixed point value </td></tr>
 487     <tr><td class="paramdir">[in]</td><td class="paramname">p</td><td>Fixed point precision</td></tr>
 488   </table>
 489   </dd>
 490 </dl>
 491 <dl class="section return"><dt>Returns</dt><dd>Integer of the fixed point number </dd></dl>
 492
 493 <p>Definition at line <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00326">326</a> of file <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a>.</p>
 494
 495 <p>Referenced by <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00715">functions::exp()</a>, and <a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml#l00175">fixed_point&lt; T &gt;::operator U()</a>.</p>
 496 <div class="fragment"><div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;    {</div>
 497 <div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;        <span class="keywordflow">return</span> val &gt;&gt; p;</div>
 498 <div class="line"><a name="l00329"></a><span class="lineno">  329</span>&#160;    }</div>
 499 </div><!-- fragment -->
 500 </div>
 501 </div>
 502 <hr/>The documentation for this struct was generated from the following file:<ul>
 503 <li>tests/validation/<a class="el" href="tests_2validation_2_fixed_point_8h_source.xhtml">FixedPoint.h</a></li>
 504 </ul>
 505 </div><!-- contents -->
 506 </div><!-- doc-content -->
 507 <!-- start footer part -->
 508 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 509   <ul>
 510     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test.xhtml">test</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic.xhtml">fixed_point_arithmetic</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail.xhtml">detail</a></li><li class="navelem"><a class="el" href="structarm__compute_1_1test_1_1fixed__point__arithmetic_1_1detail_1_1constant__expr.xhtml">constant_expr</a></li>
 511     <li class="footer">Generated on Thu Sep 28 2017 14:37:59 for Compute Library by
 512     <a href="http://www.doxygen.org/index.html">
 513     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 514   </ul>
 515 </div>
 516 </body>
 517 </html>