add Doxygen documentation
[o-du/phy.git] / docs / API / xran__compression_8hpp.html
diff --git a/docs/API/xran__compression_8hpp.html b/docs/API/xran__compression_8hpp.html
new file mode 100644 (file)
index 0000000..37f59e9
--- /dev/null
@@ -0,0 +1,227 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>o-du/phy: xran_compression.hpp File Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">o-du/phy
+   </div>
+   <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div id="nav-path" class="navpath">
+  <ul>
+<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>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#nested-classes">Data Structures</a> &#124;
+<a href="#namespaces">Namespaces</a> &#124;
+<a href="#define-members">Macros</a> &#124;
+<a href="#func-members">Functions</a> &#124;
+<a href="#var-members">Variables</a>  </div>
+  <div class="headertitle">
+<div class="title">xran_compression.hpp File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for xran_compression.hpp:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__compression_8hpp__incl.png" border="0" usemap="#xran__compression_8hpp" alt=""/></div>
+<map name="xran__compression_8hpp" id="xran__compression_8hpp">
+</map>
+</div>
+</div><div class="textblock"><div class="dynheader">
+This graph shows which files directly or indirectly include this file:</div>
+<div class="dyncontent">
+<div class="center"><img src="xran__compression_8hpp__dep__incl.png" border="0" usemap="#xran__compression_8hppdep" alt=""/></div>
+<map name="xran__compression_8hppdep" id="xran__compression_8hppdep">
+<area shape="rect" id="node2" href="xran__compression_8cpp.html" title="xran_compression.cpp" alt="" coords="5,80,159,107"/>
+<area shape="rect" id="node3" href="compander__functional_8cc.html" title="compander_functional.cc" alt="" coords="183,80,349,107"/>
+</map>
+</div>
+</div>
+<p><a href="xran__compression_8hpp_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+Data Structures</h2></td></tr>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
+Namespaces</h2></td></tr>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
+Macros</h2></td></tr>
+<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>
+<tr class="separator:afb38028874f4f92c87446f57113df109"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a5e70c4df5750d49b6c4b2aacd556500f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Functions</h2></td></tr>
+<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>
+<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>
+<tr class="separator:a45cc83687ca392534168cb8f4d64182f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a5b3ddd524752c8f556bc4c654e392321"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a2356f186e264c7cea4e3c26d448bb1d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:ae525362ca026142cab4ac983e29ad0ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a2a8db4c5039bc3d5237b31ca2a129815"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:ae4ad42b117d59e2e7ff8fad2d5da506e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a32917a78ac1596d9aa95e4089ec88ba9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a8fae7506e2b9c9f9365b306375ab6eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a65b09b78fac0c8dcfc9edd5091b728dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a45cc83687ca392534168cb8f4d64182f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a5f4776cd07aac0ae2d9dbd02aaba3435"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
+Variables</h2></td></tr>
+<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>
+<tr class="separator:ae5c6eb9e85f08f46ed0bf72749445d5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Macro Definition Documentation</h2>
+<a id="a5e70c4df5750d49b6c4b2aacd556500f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5e70c4df5750d49b6c4b2aacd556500f">&#9670;&nbsp;</a></span>ASSUME_CACHE_ALIGNED</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define ASSUME_CACHE_ALIGNED</td>
+          <td>(</td>
+          <td class="paramtype">&#160;</td>
+          <td class="paramname">data</td><td>)</td>
+          <td>&#160;&#160;&#160;__assume_aligned(data, <a class="el" href="xran__compression_8hpp.html#ae5c6eb9e85f08f46ed0bf72749445d5d">k_cacheByteAlignment</a>);</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<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>
+
+</div>
+</div>
+<a id="afb38028874f4f92c87446f57113df109"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#afb38028874f4f92c87446f57113df109">&#9670;&nbsp;</a></span>CACHE_ALIGNED</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define CACHE_ALIGNED&#160;&#160;&#160;alignas(<a class="el" href="xran__compression_8hpp.html#ae5c6eb9e85f08f46ed0bf72749445d5d">k_cacheByteAlignment</a>)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<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>
+
+</div>
+</div>
+<h2 class="groupheader">Variable Documentation</h2>
+<a id="ae5c6eb9e85f08f46ed0bf72749445d5d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae5c6eb9e85f08f46ed0bf72749445d5d">&#9670;&nbsp;</a></span>k_cacheByteAlignment</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">constexpr unsigned k_cacheByteAlignment = 64</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<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>
+
+</div>
+</div>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>