docs/API/xran__compression_8hpp.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.13"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>o-du/phy: xran_compression.hpp File Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="search/searchdata.js"></script>
  14 <script type="text/javascript" src="search/search.js"></script>
  15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16 </head>
  17 <body>
  18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19 <div id="titlearea">
  20 <table cellspacing="0" cellpadding="0">
  21  <tbody>
  22  <tr style="height: 56px;">
  23   <td id="projectalign" style="padding-left: 0.5em;">
  24    <div id="projectname">o-du/phy
  25    </div>
  26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
  27   </td>
  28  </tr>
  29  </tbody>
  30 </table>
  31 </div>
  32 <!-- end header part -->
  33 <!-- Generated by Doxygen 1.8.13 -->
  34 <script type="text/javascript">
  35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36 </script>
  37 <script type="text/javascript" src="menudata.js"></script>
  38 <script type="text/javascript" src="menu.js"></script>
  39 <script type="text/javascript">
  40 $(function() {
  41   initMenu('',true,false,'search.php','Search');
  42   $(document).ready(function() { init_search(); });
  43 });
  44 </script>
  45 <div id="main-nav"></div>
  46 <!-- window showing the filter options -->
  47 <div id="MSearchSelectWindow"
  48      onmouseover="return searchBox.OnSearchSelectShow()"
  49      onmouseout="return searchBox.OnSearchSelectHide()"
  50      onkeydown="return searchBox.OnSearchSelectKey(event)">
  51 </div>
  52
  53 <!-- iframe showing the search results (closed by default) -->
  54 <div id="MSearchResultsWindow">
  55 <iframe src="javascript:void(0)" frameborder="0"
  56         name="MSearchResults" id="MSearchResults">
  57 </iframe>
  58 </div>
  59
  60 <div id="nav-path" class="navpath">
  61   <ul>
  62 <li class="navelem"><a class="el" href="dir_a4c74d6baed87eba72f3b201b7b4b8f2.html">fhi_lib</a></li><li class="navelem"><a class="el" href="dir_5cc0cc0264b57168b75ca56bde6cc403.html">lib</a></li><li class="navelem"><a class="el" href="dir_7b477aa413287cfa2199e983b77d66dd.html">api</a></li>  </ul>
  63 </div>
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="summary">
  67 <a href="#nested-classes">Data Structures</a> &#124;
  68 <a href="#namespaces">Namespaces</a> &#124;
  69 <a href="#define-members">Macros</a> &#124;
  70 <a href="#func-members">Functions</a> &#124;
  71 <a href="#var-members">Variables</a>  </div>
  72   <div class="headertitle">
  73 <div class="title">xran_compression.hpp File Reference</div>  </div>
  74 </div><!--header-->
  75 <div class="contents">
  76 <div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
  77 </div><div class="textblock"><div class="dynheader">
  78 Include dependency graph for xran_compression.hpp:</div>
  79 <div class="dyncontent">
  80 <div class="center"><img src="xran__compression_8hpp__incl.png" border="0" usemap="#xran__compression_8hpp" alt=""/></div>
  81 <map name="xran__compression_8hpp" id="xran__compression_8hpp">
  82 </map>
  83 </div>
  84 </div><div class="textblock"><div class="dynheader">
  85 This graph shows which files directly or indirectly include this file:</div>
  86 <div class="dyncontent">
  87 <div class="center"><img src="xran__compression_8hpp__dep__incl.png" border="0" usemap="#xran__compression_8hppdep" alt=""/></div>
  88 <map name="xran__compression_8hppdep" id="xran__compression_8hppdep">
  89 <area shape="rect" id="node2" href="xran__compression_8cpp.html" title="xran_compression.cpp" alt="" coords="5,80,159,107"/>
  90 <area shape="rect" id="node3" href="compander__functional_8cc.html" title="compander_functional.cc" alt="" coords="183,80,349,107"/>
  91 </map>
  92 </div>
  93 </div>
  94 <p><a href="xran__compression_8hpp_source.html">Go to the source code of this file.</a></p>
  95 <table class="memberdecls">
  96 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  97 Data Structures</h2></td></tr>
  98 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_1_1_compressed_data.html">CompressedData</a></td></tr>
  99 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_1_1_expanded_data.html">ExpandedData</a></td></tr>
 101 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 102 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_b_f_w_1_1_compressed_data.html">CompressedData</a></td></tr>
 103 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 104 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_block_float_compander_b_f_w_1_1_expanded_data.html">ExpandedData</a></td></tr>
 105 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 106 </table><table class="memberdecls">
 107 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
 108 Namespaces</h2></td></tr>
 109 <tr class="memitem:namespace_block_float_compander"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html">BlockFloatCompander</a></td></tr>
 110 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 111 <tr class="memitem:namespace_block_float_compander_b_f_w"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander_b_f_w.html">BlockFloatCompanderBFW</a></td></tr>
 112 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 113 </table><table class="memberdecls">
 114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
 115 Macros</h2></td></tr>
 116 <tr class="memitem:afb38028874f4f92c87446f57113df109"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__compression_8hpp.html#afb38028874f4f92c87446f57113df109">CACHE_ALIGNED</a>&#160;&#160;&#160;alignas(<a class="el" href="xran__compression_8hpp.html#ae5c6eb9e85f08f46ed0bf72749445d5d">k_cacheByteAlignment</a>)</td></tr>
 117 <tr class="separator:afb38028874f4f92c87446f57113df109"><td class="memSeparator" colspan="2">&#160;</td></tr>
 118 <tr class="memitem:a5e70c4df5750d49b6c4b2aacd556500f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__compression_8hpp.html#a5e70c4df5750d49b6c4b2aacd556500f">ASSUME_CACHE_ALIGNED</a>(data)&#160;&#160;&#160;__assume_aligned(data, <a class="el" href="xran__compression_8hpp.html#ae5c6eb9e85f08f46ed0bf72749445d5d">k_cacheByteAlignment</a>);</td></tr>
 119 <tr class="separator:a5e70c4df5750d49b6c4b2aacd556500f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 120 </table><table class="memberdecls">
 121 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 122 Functions</h2></td></tr>
 123 <tr class="memitem:a45cc83687ca392534168cb8f4d64182f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#a45cc83687ca392534168cb8f4d64182f">BlockFloatCompress_Basic</a> (const ExpandedData &amp;dataIn, CompressedData *dataOut)</td></tr>
 124 <tr class="memdesc:a45cc83687ca392534168cb8f4d64182f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference compression.  <a href="namespace_block_float_compander.html#a45cc83687ca392534168cb8f4d64182f">More...</a><br /></td></tr>
 125 <tr class="separator:a45cc83687ca392534168cb8f4d64182f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 126 <tr class="memitem:a5b3ddd524752c8f556bc4c654e392321"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#a5b3ddd524752c8f556bc4c654e392321">BlockFloatCompress_8b_AVX512</a> (const ExpandedData &amp;dataIn, CompressedData *dataOut)</td></tr>
 127 <tr class="memdesc:a5b3ddd524752c8f556bc4c654e392321"><td class="mdescLeft">&#160;</td><td class="mdescRight">8 bit compression  <a href="namespace_block_float_compander.html#a5b3ddd524752c8f556bc4c654e392321">More...</a><br /></td></tr>
 128 <tr class="separator:a5b3ddd524752c8f556bc4c654e392321"><td class="memSeparator" colspan="2">&#160;</td></tr>
 129 <tr class="memitem:a2356f186e264c7cea4e3c26d448bb1d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#a2356f186e264c7cea4e3c26d448bb1d5">BlockFloatCompress_9b_AVX512</a> (const ExpandedData &amp;dataIn, CompressedData *dataOut)</td></tr>
 130 <tr class="memdesc:a2356f186e264c7cea4e3c26d448bb1d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">9 bit compression  <a href="namespace_block_float_compander.html#a2356f186e264c7cea4e3c26d448bb1d5">More...</a><br /></td></tr>
 131 <tr class="separator:a2356f186e264c7cea4e3c26d448bb1d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 132 <tr class="memitem:ae525362ca026142cab4ac983e29ad0ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#ae525362ca026142cab4ac983e29ad0ff">BlockFloatCompress_10b_AVX512</a> (const ExpandedData &amp;dataIn, CompressedData *dataOut)</td></tr>
 133 <tr class="memdesc:ae525362ca026142cab4ac983e29ad0ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">10 bit compression  <a href="namespace_block_float_compander.html#ae525362ca026142cab4ac983e29ad0ff">More...</a><br /></td></tr>
 134 <tr class="separator:ae525362ca026142cab4ac983e29ad0ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:a2a8db4c5039bc3d5237b31ca2a129815"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#a2a8db4c5039bc3d5237b31ca2a129815">BlockFloatCompress_12b_AVX512</a> (const ExpandedData &amp;dataIn, CompressedData *dataOut)</td></tr>
 136 <tr class="memdesc:a2a8db4c5039bc3d5237b31ca2a129815"><td class="mdescLeft">&#160;</td><td class="mdescRight">12 bit compression  <a href="namespace_block_float_compander.html#a2a8db4c5039bc3d5237b31ca2a129815">More...</a><br /></td></tr>
 137 <tr class="separator:a2a8db4c5039bc3d5237b31ca2a129815"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#a5f4776cd07aac0ae2d9dbd02aaba3435">BlockFloatExpand_Basic</a> (const CompressedData &amp;dataIn, ExpandedData *dataOut)</td></tr>
 139 <tr class="memdesc:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference expansion.  <a href="namespace_block_float_compander.html#a5f4776cd07aac0ae2d9dbd02aaba3435">More...</a><br /></td></tr>
 140 <tr class="separator:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:ae4ad42b117d59e2e7ff8fad2d5da506e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#ae4ad42b117d59e2e7ff8fad2d5da506e">BlockFloatExpand_8b_AVX512</a> (const CompressedData &amp;dataIn, ExpandedData *dataOut)</td></tr>
 142 <tr class="memdesc:ae4ad42b117d59e2e7ff8fad2d5da506e"><td class="mdescLeft">&#160;</td><td class="mdescRight">8 bit expansion  <a href="namespace_block_float_compander.html#ae4ad42b117d59e2e7ff8fad2d5da506e">More...</a><br /></td></tr>
 143 <tr class="separator:ae4ad42b117d59e2e7ff8fad2d5da506e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a32917a78ac1596d9aa95e4089ec88ba9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#a32917a78ac1596d9aa95e4089ec88ba9">BlockFloatExpand_9b_AVX512</a> (const CompressedData &amp;dataIn, ExpandedData *dataOut)</td></tr>
 145 <tr class="memdesc:a32917a78ac1596d9aa95e4089ec88ba9"><td class="mdescLeft">&#160;</td><td class="mdescRight">9 bit expansion  <a href="namespace_block_float_compander.html#a32917a78ac1596d9aa95e4089ec88ba9">More...</a><br /></td></tr>
 146 <tr class="separator:a32917a78ac1596d9aa95e4089ec88ba9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:a8fae7506e2b9c9f9365b306375ab6eff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#a8fae7506e2b9c9f9365b306375ab6eff">BlockFloatExpand_10b_AVX512</a> (const CompressedData &amp;dataIn, ExpandedData *dataOut)</td></tr>
 148 <tr class="memdesc:a8fae7506e2b9c9f9365b306375ab6eff"><td class="mdescLeft">&#160;</td><td class="mdescRight">10 bit expansion  <a href="namespace_block_float_compander.html#a8fae7506e2b9c9f9365b306375ab6eff">More...</a><br /></td></tr>
 149 <tr class="separator:a8fae7506e2b9c9f9365b306375ab6eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:a65b09b78fac0c8dcfc9edd5091b728dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander.html#a65b09b78fac0c8dcfc9edd5091b728dd">BlockFloatExpand_12b_AVX512</a> (const CompressedData &amp;dataIn, ExpandedData *dataOut)</td></tr>
 151 <tr class="memdesc:a65b09b78fac0c8dcfc9edd5091b728dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">12 bit expansion  <a href="namespace_block_float_compander.html#a65b09b78fac0c8dcfc9edd5091b728dd">More...</a><br /></td></tr>
 152 <tr class="separator:a65b09b78fac0c8dcfc9edd5091b728dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:a45cc83687ca392534168cb8f4d64182f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander_b_f_w.html#a45cc83687ca392534168cb8f4d64182f">BlockFloatCompress_Basic</a> (const ExpandedData &amp;dataIn, CompressedData *dataOut)</td></tr>
 154 <tr class="memdesc:a45cc83687ca392534168cb8f4d64182f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference compression.  <a href="namespace_block_float_compander_b_f_w.html#a45cc83687ca392534168cb8f4d64182f">More...</a><br /></td></tr>
 155 <tr class="separator:a45cc83687ca392534168cb8f4d64182f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_block_float_compander_b_f_w.html#a5f4776cd07aac0ae2d9dbd02aaba3435">BlockFloatExpand_Basic</a> (const CompressedData &amp;dataIn, ExpandedData *dataOut)</td></tr>
 157 <tr class="memdesc:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference expansion.  <a href="namespace_block_float_compander_b_f_w.html#a5f4776cd07aac0ae2d9dbd02aaba3435">More...</a><br /></td></tr>
 158 <tr class="separator:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 </table><table class="memberdecls">
 160 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
 161 Variables</h2></td></tr>
 162 <tr class="memitem:ae5c6eb9e85f08f46ed0bf72749445d5d"><td class="memItemLeft" align="right" valign="top">constexpr unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xran__compression_8hpp.html#ae5c6eb9e85f08f46ed0bf72749445d5d">k_cacheByteAlignment</a> = 64</td></tr>
 163 <tr class="separator:ae5c6eb9e85f08f46ed0bf72749445d5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 164 </table>
 165 <h2 class="groupheader">Macro Definition Documentation</h2>
 166 <a id="a5e70c4df5750d49b6c4b2aacd556500f"></a>
 167 <h2 class="memtitle"><span class="permalink"><a href="#a5e70c4df5750d49b6c4b2aacd556500f">&#9670;&nbsp;</a></span>ASSUME_CACHE_ALIGNED</h2>
 168
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">#define ASSUME_CACHE_ALIGNED</td>
 174           <td>(</td>
 175           <td class="paramtype">&#160;</td>
 176           <td class="paramname">data</td><td>)</td>
 177           <td>&#160;&#160;&#160;__assume_aligned(data, <a class="el" href="xran__compression_8hpp.html#ae5c6eb9e85f08f46ed0bf72749445d5d">k_cacheByteAlignment</a>);</td>
 178         </tr>
 179       </table>
 180 </div><div class="memdoc">
 181
 182 <p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00040">40</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
 183
 184 </div>
 185 </div>
 186 <a id="afb38028874f4f92c87446f57113df109"></a>
 187 <h2 class="memtitle"><span class="permalink"><a href="#afb38028874f4f92c87446f57113df109">&#9670;&nbsp;</a></span>CACHE_ALIGNED</h2>
 188
 189 <div class="memitem">
 190 <div class="memproto">
 191       <table class="memname">
 192         <tr>
 193           <td class="memname">#define CACHE_ALIGNED&#160;&#160;&#160;alignas(<a class="el" href="xran__compression_8hpp.html#ae5c6eb9e85f08f46ed0bf72749445d5d">k_cacheByteAlignment</a>)</td>
 194         </tr>
 195       </table>
 196 </div><div class="memdoc">
 197
 198 <p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00034">34</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
 199
 200 </div>
 201 </div>
 202 <h2 class="groupheader">Variable Documentation</h2>
 203 <a id="ae5c6eb9e85f08f46ed0bf72749445d5d"></a>
 204 <h2 class="memtitle"><span class="permalink"><a href="#ae5c6eb9e85f08f46ed0bf72749445d5d">&#9670;&nbsp;</a></span>k_cacheByteAlignment</h2>
 205
 206 <div class="memitem">
 207 <div class="memproto">
 208       <table class="memname">
 209         <tr>
 210           <td class="memname">constexpr unsigned k_cacheByteAlignment = 64</td>
 211         </tr>
 212       </table>
 213 </div><div class="memdoc">
 214
 215 <p class="definition">Definition at line <a class="el" href="xran__compression_8hpp_source.html#l00028">28</a> of file <a class="el" href="xran__compression_8hpp_source.html">xran_compression.hpp</a>.</p>
 216
 217 </div>
 218 </div>
 219 </div><!-- contents -->
 220 <!-- start footer part -->
 221 <hr class="footer"/><address class="footer"><small>
 222 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 223 <img class="footer" src="doxygen.png" alt="doxygen"/>
 224 </a> 1.8.13
 225 </small></address>
 226 </body>
 227 </html>